变更历史

5.0.0-alpha

读写分离

配置项说明

  1. spring.shardingsphere.datasource.names= # 省略数据源配置，请参考使用手册
  3. spring.shardingsphere.rules.replica-query.data-sources.<replica-query-data-source-name>.primary-data-source-name= # 主数据源名称
  4. spring.shardingsphere.rules.replica-query.data-sources.<replica-query-data-source-name>.replica-data-source-names= # 从数据源名称，多个从数据源用逗号分隔
  5. spring.shardingsphere.rules.replica-query.data-sources.<replica-query-data-source-name>.load-balancer-name= # 负载均衡算法名称
  7. # 负载均衡算法配置
  8. spring.shardingsphere.rules.replica-query.load-balancers.<load-balance-algorithm-name>.type= # 负载均衡算法类型
  9. spring.shardingsphere.rules.replica-query.load-balancers.<load-balance-algorithm-name>.props.xxx= # 负载均衡算法属性配置

算法类型的详情，请参见内置负载均衡算法列表。

数据分片

配置项说明

  1. spring.shardingsphere.datasource.names= # 省略数据源配置，请参考使用手册
  3. # 标准分片表配置
  4. spring.shardingsphere.rules.sharding.tables.<table-name>.actual-data-nodes= # 由数据源名 + 表名组成，以小数点分隔。多个表以逗号分隔，支持inline表达式。缺省表示使用已知数据源与逻辑表名称生成数据节点，用于广播表（即每个库中都需要一个同样的表用于关联查询，多为字典表）或只分库不分表且所有库的表结构完全一致的情况
  6. # 分库策略，缺省表示使用默认分库策略，以下的分片策略只能选其一
  8. # 用于单分片键的标准分片场景
  9. spring.shardingsphere.rules.sharding.tables.<table-name>.database-strategy.standard.<sharding-algorithm-name>.sharding-column= # 分片列名称
  10. spring.shardingsphere.rules.sharding.tables.<table-name>.database-strategy.standard.<sharding-algorithm-name>.sharding-algorithm-name= # 分片算法名称
  12. # 用于多分片键的复合分片场景
  13. spring.shardingsphere.rules.sharding.tables.<table-name>.database-strategy.complex.<sharding-algorithm-name>.sharding-columns= # 分片列名称，多个列以逗号分隔
  14. spring.shardingsphere.rules.sharding.tables.<table-name>.database-strategy.complex.<sharding-algorithm-name>.sharding-algorithm-name= # 分片算法名称
  16. # 用于Hint 的分片策略
  17. spring.shardingsphere.rules.sharding.tables.<table-name>.database-strategy.hint.<sharding-algorithm-name>.sharding-algorithm-name= # 分片算法名称
  19. # 分表策略，同分库策略
  20. spring.shardingsphere.rules.sharding.tables.<table-name>.table-strategy.xxx= # 省略
  22. # 自动分片表配置
  23. spring.shardingsphere.rules.sharding.auto-tables.<auto-table-name>.actual-data-sources= # 数据源名
  25. spring.shardingsphere.rules.sharding.auto-tables.<auto-table-name>.sharding-strategy.standard.sharding-column= # 分片列名称
  26. spring.shardingsphere.rules.sharding.auto-tables.<auto-table-name>.sharding-strategy.standard.sharding-algorithm= # 自动分片算法名称
  28. # 分布式序列策略配置
  29. spring.shardingsphere.rules.sharding.tables.<table-name>.key-generate-strategy.column= # 分布式序列列名称
  30. spring.shardingsphere.rules.sharding.tables.<table-name>.key-generate-strategy.key-generator-name= # 分布式序列算法名称
  32. spring.shardingsphere.rules.sharding.binding-tables[0]= # 绑定表规则列表
  33. spring.shardingsphere.rules.sharding.binding-tables[1]= # 绑定表规则列表
  34. spring.shardingsphere.rules.sharding.binding-tables[x]= # 绑定表规则列表
  36. spring.shardingsphere.rules.sharding.broadcast-tables[0]= # 广播表规则列表
  37. spring.shardingsphere.rules.sharding.broadcast-tables[1]= # 广播表规则列表
  38. spring.shardingsphere.rules.sharding.broadcast-tables[x]= # 广播表规则列表
  40. spring.shardingsphere.sharding.default-database-strategy.xxx= # 默认数据库分片策略
  41. spring.shardingsphere.sharding.default-table-strategy.xxx= # 默认表分片策略
  42. spring.shardingsphere.sharding.default-key-generate-strategy.xxx= # 默认分布式序列策略
  44. # 分片算法配置
  45. spring.shardingsphere.rules.sharding.sharding-algorithms.<sharding-algorithm-name>.type= # 分片算法类型
  46. spring.shardingsphere.rules.sharding.sharding-algorithms.<sharding-algorithm-name>.props.xxx=# 分片算法属性配置
  48. # 分布式序列算法配置
  49. spring.shardingsphere.rules.sharding.key-generators.<key-generate-algorithm-name>.type= # 分布式序列算法类型
  50. spring.shardingsphere.rules.sharding.key-generators.<key-generate-algorithm-name>.props.xxx= # 分布式序列算法属性配置

算法类型的详情，请参见内置分片算法列表和内置分布式序列算法列表。

数据加密

配置项说明

  1. spring.shardingsphere.datasource.names= # 省略数据源配置，请参考使用手册
  3. spring.shardingsphere.rules.encrypt.tables.<table-name>.columns.<column-name>.cipher-column= # 加密列名称
  4. spring.shardingsphere.rules.encrypt.tables.<table-name>.columns.<column-name>.assisted-query-column= # 查询列名称
  5. spring.shardingsphere.rules.encrypt.tables.<table-name>.columns.<column-name>.plain-column= # 原文列名称
  6. spring.shardingsphere.rules.encrypt.tables.<table-name>.columns.<column-name>.encryptor-name= # 加密算法名称
  8. # 加密算法配置
  9. spring.shardingsphere.rules.encrypt.encryptors.<encrypt-algorithm-name>.type= # 加密算法类型
  10. spring.shardingsphere.rules.encrypt.encryptors.<encrypt-algorithm-name>.props.xxx= # 加密算法属性配置

算法类型的详情，请参见内置分片算法列表

影子库

配置项说明

  1. spring.shardingsphere.datasource.names= # 省略数据源配置，请参考使用手册
  3. spring.shardingsphere.rules.shadow.column= # 影子字段名称名称
  4. spring.shardingsphere.rules.shadow.shadow-mappings.<product-data-source-name>= # 影子数据库名称

分布式治理

配置项说明

  1. spring.shardingsphere.governance.name= # 治理名称
  2. spring.shardingsphere.governance.registry-center.type= # 治理持久化类型。如：Zookeeper, etcd, Apollo, Nacos
  3. spring.shardingsphere.governance.registry-center.server-lists= # 治理服务列表。包括 IP 地址和端口号。多个地址用逗号分隔。如: host1:2181,host2:2181
  4. spring.shardingsphere.governance.registry-center.props= # 其它配置
  5. spring.shardingsphere.governance.overwrite= # 本地配置是否覆盖配置中心配置。如果可覆盖，每次启动都以本地配置为准.

混合规则

配置项说明

  1. # 数据源配置
  2. # 数据源名称，多数据源以逗号分隔
  3. spring.shardingsphere.datasource.names= write-ds0,write-ds1,write-ds0-read0,write-ds1-read0
  5. spring.shardingsphere.datasource.write-ds0.url= # 数据库 URL 连接
  6. spring.shardingsphere.datasource.write-ds0.type=  # 数据库连接池类名称
  7. spring.shardingsphere.datasource.write-ds0.driver-class-name= # 数据库驱动类名
  8. spring.shardingsphere.datasource.write-ds0.username= # 数据库用户名
  9. spring.shardingsphere.datasource.write-ds0.password= # 数据库密码
  10. spring.shardingsphere.datasource.write-ds0.xxx=  # 数据库连接池的其它属性
  12. spring.shardingsphere.datasource.write-ds1.url= # 数据库 URL 连接
  14. spring.shardingsphere.datasource.write-ds0-read0.url= # 数据库 URL 连接
  16. spring.shardingsphere.datasource.write-ds1-read0.url= # 数据库 URL 连接
  18. # 分片规则配置
  19. # 分库策略
  20. spring.shardingsphere.rules.sharding.default-database-strategy.standard.sharding-column=user_id
  21. spring.shardingsphere.rules.sharding.default-database-strategy.standard.sharding-algorithm-name=default-database-strategy-inline
  22. # 绑定表规则，多组绑定规则使用数组形式配置
  23. spring.shardingsphere.rules.sharding.binding-tables[0]=t_user,t_user_detail # 绑定表名称，多个表之间以逗号分隔
  24. spring.shardingsphere.rules.sharding.binding-tables[1]= # 绑定表名称，多个表之间以逗号分隔
  25. spring.shardingsphere.rules.sharding.binding-tables[x]= # 绑定表名称，多个表之间以逗号分隔
  26. # 广播表规则配置
  27. spring.shardingsphere.rules.sharding.broadcast-tables= # 广播表名称，多个表之间以逗号分隔
  29. # 分表策略
  30. # 表达式 `ds_$->{0..1}`枚举的数据源为读写分离配置的逻辑数据源名称
  31. spring.shardingsphere.rules.sharding.tables.t_user.actual-data-nodes=ds_$->{0..1}.t_user_$->{0..1}
  32. spring.shardingsphere.rules.sharding.tables.t_user.table-strategy.standard.sharding-column=user_id
  33. spring.shardingsphere.rules.sharding.tables.t_user.table-strategy.standard.sharding-algorithm-name=user-table-strategy-inline
  35. spring.shardingsphere.rules.sharding.tables.t_user_detail.actual-data-nodes=ds_$->{0..1}.t_user_detail_$->{0..1}
  36. spring.shardingsphere.rules.sharding.tables.t_user_detail.table-strategy.standard.sharding-column=user_id
  37. spring.shardingsphere.rules.sharding.tables.t_user_detail.table-strategy.standard.sharding-algorithm-name=user-detail-table-strategy-inline
  39. # 数据加密配置
  40. # `t_user` 使用分片规则配置的逻辑表名称
  41. spring.shardingsphere.rules.encrypt.tables.t_user.columns.user_name.cipher-column=user_name
  42. spring.shardingsphere.rules.encrypt.tables.t_user.columns.user_name.encryptor-name=name-encryptor
  43. spring.shardingsphere.rules.encrypt.tables.t_user.columns.pwd.cipher-column=pwd
  44. spring.shardingsphere.rules.encrypt.tables.t_user.columns.pwd.encryptor-name=pwd-encryptor
  46. # 数据加密算法配置
  47. spring.shardingsphere.rules.encrypt.encryptors.name-encryptor.type=AES
  48. spring.shardingsphere.rules.encrypt.encryptors.name-encryptor.props.aes-key-value=123456abc
  49. spring.shardingsphere.rules.encrypt.encryptors.pwd-encryptor.type=AES
  50. spring.shardingsphere.rules.encrypt.encryptors.pwd-encryptor.props.aes-key-value=123456abc
  52. # 分布式序列策略配置
  53. spring.shardingsphere.rules.sharding.tables.t_user.key-generate-strategy.column=user_id
  54. spring.shardingsphere.rules.sharding.tables.t_user.key-generate-strategy.key-generator-name=snowflake
  56. # 分片算法配置
  57. spring.shardingsphere.rules.sharding.sharding-algorithms.default-database-strategy-inline.type=INLINE
  58. # 表达式`ds_$->{user_id % 2}` 枚举的数据源为读写分离配置的逻辑数据源名称
  59. spring.shardingsphere.rules.sharding.sharding-algorithms.default-database-strategy-inline.algorithm-expression=ds_$->{user_id % 2}
  60. spring.shardingsphere.rules.sharding.sharding-algorithms.user-table-strategy-inline.type=INLINE
  61. spring.shardingsphere.rules.sharding.sharding-algorithms.user-table-strategy-inline.algorithm-expression=t_user_$->{user_id % 2}
  63. spring.shardingsphere.rules.sharding.sharding-algorithms.user-detail-table-strategy-inline.type=INLINE
  64. spring.shardingsphere.rules.sharding.sharding-algorithms.user-detail-table-strategy-inline.algorithm-expression=t_user_detail_$->{user_id % 2}
  66. # 分布式序列算法配置
  67. spring.shardingsphere.rules.sharding.key-generators.snowflake.type=SNOWFLAKE
  68. spring.shardingsphere.rules.sharding.key-generators.snowflake.props.worker-id=123
  70. # 读写分离策略配置
  71. # ds_0,ds_1为读写分离配置的逻辑数据源名称
  72. spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.write-data-source-name=write-ds0
  73. spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.read-data-source-names=write-ds0-read0
  74. spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.load-balancer-name=read-random
  75. spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.write-data-source-name=write-ds1
  76. spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.read-data-source-names=write-ds1-read0
  77. spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.load-balancer-name=read-random
  79. # 负载均衡算法配置
  80. spring.shardingsphere.rules.readwrite-splitting.load-balancers.read-random.type=RANDOM

shardingsphere-4.x

读写分离

配置项说明

  1. #省略数据源配置，与数据分片一致
  3. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.master-data-source-name= #主库数据源名称
  4. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[0]= #从库数据源名称列表
  5. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[1]= #从库数据源名称列表
  6. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[x]= #从库数据源名称列表
  7. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-class-name= #从库负载均衡算法类名称。该类需实现MasterSlaveLoadBalanceAlgorithm接口且提供无参数构造器
  8. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-type= #从库负载均衡算法类型，可选值：ROUND_ROBIN，RANDOM。若`load-balance-algorithm-class-name`存在则忽略该配置
  10. spring.shardingsphere.props.sql.show= #是否开启SQL显示，默认值: false
  11. spring.shardingsphere.props.executor.size= #工作线程数量，默认值: CPU核数
  12. spring.shardingsphere.props.check.table.metadata.enabled= #是否在启动时检查分表元数据一致性，默认值: false

数据分片

配置项说明

  1. spring.shardingsphere.datasource.names= #数据源名称，多数据源以逗号分隔
  3. spring.shardingsphere.datasource.<data-source-name>.type= #数据库连接池类名称
  4. spring.shardingsphere.datasource.<data-source-name>.driver-class-name= #数据库驱动类名
  5. spring.shardingsphere.datasource.<data-source-name>.url= #数据库url连接
  6. spring.shardingsphere.datasource.<data-source-name>.username= #数据库用户名
  7. spring.shardingsphere.datasource.<data-source-name>.password= #数据库密码
  8. spring.shardingsphere.datasource.<data-source-name>.xxx= #数据库连接池的其它属性
  10. spring.shardingsphere.sharding.tables.<logic-table-name>.actual-data-nodes= #由数据源名 + 表名组成，以小数点分隔。多个表以逗号分隔，支持inline表达式。缺省表示使用已知数据源与逻辑表名称生成数据节点，用于广播表（即每个库中都需要一个同样的表用于关联查询，多为字典表）或只分库不分表且所有库的表结构完全一致的情况
  12. #分库策略，缺省表示使用默认分库策略，以下的分片策略只能选其一
  14. #用于单分片键的标准分片场景
  15. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.standard.sharding-column= #分片列名称
  16. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.standard.precise-algorithm-class-name= #精确分片算法类名称，用于=和IN。该类需实现PreciseShardingAlgorithm接口并提供无参数的构造器
  17. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.standard.range-algorithm-class-name= #范围分片算法类名称，用于BETWEEN，可选。该类需实现RangeShardingAlgorithm接口并提供无参数的构造器
  19. #用于多分片键的复合分片场景
  20. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.complex.sharding-columns= #分片列名称，多个列以逗号分隔
  21. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.complex.algorithm-class-name= #复合分片算法类名称。该类需实现ComplexKeysShardingAlgorithm接口并提供无参数的构造器
  23. #行表达式分片策略
  24. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.inline.sharding-column= #分片列名称
  25. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.inline.algorithm-expression= #分片算法行表达式，需符合groovy语法
  27. #Hint分片策略
  28. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.hint.algorithm-class-name= #Hint分片算法类名称。该类需实现HintShardingAlgorithm接口并提供无参数的构造器
  30. #分表策略，同分库策略
  31. spring.shardingsphere.sharding.tables.<logic-table-name>.table-strategy.xxx= #省略
  33. spring.shardingsphere.sharding.tables.<logic-table-name>.key-generator.column= #自增列名称，缺省表示不使用自增主键生成器
  34. spring.shardingsphere.sharding.tables.<logic-table-name>.key-generator.type= #自增列值生成器类型，缺省表示使用默认自增列值生成器。可使用用户自定义的列值生成器或选择内置类型：SNOWFLAKE/UUID
  35. spring.shardingsphere.sharding.tables.<logic-table-name>.key-generator.props.<property-name>= #属性配置, 注意：使用SNOWFLAKE算法，需要配置worker.id与max.tolerate.time.difference.milliseconds属性。若使用此算法生成值作分片值，建议配置max.vibration.offset属性
  37. spring.shardingsphere.sharding.binding-tables[0]= #绑定表规则列表
  38. spring.shardingsphere.sharding.binding-tables[1]= #绑定表规则列表
  39. spring.shardingsphere.sharding.binding-tables[x]= #绑定表规则列表
  41. spring.shardingsphere.sharding.broadcast-tables[0]= #广播表规则列表
  42. spring.shardingsphere.sharding.broadcast-tables[1]= #广播表规则列表
  43. spring.shardingsphere.sharding.broadcast-tables[x]= #广播表规则列表
  45. spring.shardingsphere.sharding.default-data-source-name= #未配置分片规则的表将通过默认数据源定位
  46. spring.shardingsphere.sharding.default-database-strategy.xxx= #默认数据库分片策略，同分库策略
  47. spring.shardingsphere.sharding.default-table-strategy.xxx= #默认表分片策略，同分表策略
  48. spring.shardingsphere.sharding.default-key-generator.type= #默认自增列值生成器类型，缺省将使用org.apache.shardingsphere.core.keygen.generator.impl.SnowflakeKeyGenerator。可使用用户自定义的列值生成器或选择内置类型：SNOWFLAKE/UUID
  49. spring.shardingsphere.sharding.default-key-generator.props.<property-name>= #自增列值生成器属性配置, 比如SNOWFLAKE算法的worker.id与max.tolerate.time.difference.milliseconds
  51. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.master-data-source-name= #详见读写分离部分
  52. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[0]= #详见读写分离部分
  53. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[1]= #详见读写分离部分
  54. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[x]= #详见读写分离部分
  55. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-class-name= #详见读写分离部分
  56. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-type= #详见读写分离部分
  58. spring.shardingsphere.props.sql.show= #是否开启SQL显示，默认值: false
  59. spring.shardingsphere.props.executor.size= #工作线程数量，默认值: CPU核数

编排治理

治理

配置项说明
  1. #省略数据源、数据分片、读写分离和数据脱敏配置
  3. spring.shardingsphere.orchestration.name= #治理实例名称
  4. spring.shardingsphere.orchestration.overwrite= #本地配置是否覆盖注册中心配置。如果可覆盖，每次启动都以本地配置为准
  5. spring.shardingsphere.orchestration.registry.type= #配置中心类型。如：zookeeper
  6. spring.shardingsphere.orchestration.registry.server-lists= #连接注册中心服务器的列表。包括IP地址和端口号。多个地址用逗号分隔。如: host1:2181,host2:2181
  7. spring.shardingsphere.orchestration.registry.namespace= #注册中心的命名空间
  8. spring.shardingsphere.orchestration.registry.digest= #连接注册中心的权限令牌。缺省为不需要权限验证
  9. spring.shardingsphere.orchestration.registry.operation-timeout-milliseconds= #操作超时的毫秒数，默认500毫秒
  10. spring.shardingsphere.orchestration.registry.max-retries= #连接失败后的最大重试次数，默认3次
  11. spring.shardingsphere.orchestration.registry.retry-interval-milliseconds= #重试间隔毫秒数，默认500毫秒
  12. spring.shardingsphere.orchestration.registry.time-to-live-seconds= #临时节点存活秒数，默认60秒
  13. spring.shardingsphere.orchestration.registry.props= #配置中心其它属性

数据脱敏

配置项说明

  1. #省略数据源配置，与数据分片一致
  3. spring.shardingsphere.encrypt.encryptors.<encryptor-name>.type= #加解密器类型，可自定义或选择内置类型：MD5/AES
  4. spring.shardingsphere.encrypt.encryptors.<encryptor-name>.props.<property-name>= #属性配置, 注意：使用AES加密器，需要配置AES加密器的KEY属性：aes.key.value
  5. spring.shardingsphere.encrypt.tables.<table-name>.columns.<logic-column-name>.plainColumn= #存储明文的字段
  6. spring.shardingsphere.encrypt.tables.<table-name>.columns.<logic-column-name>.cipherColumn= #存储密文的字段
  7. spring.shardingsphere.encrypt.tables.<table-name>.columns.<logic-column-name>.assistedQueryColumn= #辅助查询字段，针对ShardingQueryAssistedEncryptor类型的加解密器进行辅助查询
  8. spring.shardingsphere.encrypt.tables.<table-name>.columns.<logic-column-name>.encryptor= #加密器名字

shardingsphere-3.x

数据分片

配置项说明

  1. sharding.jdbc.datasource.names= #数据源名称，多数据源以逗号分隔
  3. sharding.jdbc.datasource.<data-source-name>.type= #数据库连接池类名称
  4. sharding.jdbc.datasource.<data-source-name>.driver-class-name= #数据库驱动类名
  5. sharding.jdbc.datasource.<data-source-name>.url= #数据库url连接
  6. sharding.jdbc.datasource.<data-source-name>.username= #数据库用户名
  7. sharding.jdbc.datasource.<data-source-name>.password= #数据库密码
  8. sharding.jdbc.datasource.<data-source-name>.xxx= #数据库连接池的其它属性
  10. sharding.jdbc.config.sharding.tables.<logic-table-name>.actual-data-nodes= #由数据源名 + 表名组成，以小数点分隔。多个表以逗号分隔，支持inline表达式。缺省表示使用已知数据源与逻辑表名称生成数据节点。用于广播表（即每个库中都需要一个同样的表用于关联查询，多为字典表）或只分库不分表且所有库的表结构完全一致的情况
  12. #分库策略，缺省表示使用默认分库策略，以下的分片策略只能选其一
  14. #用于单分片键的标准分片场景
  15. sharding.jdbc.config.sharding.tables.<logic-table-name>.database-strategy.standard.sharding-column= #分片列名称
  16. sharding.jdbc.config.sharding.tables.<logic-table-name>.database-strategy.standard.precise-algorithm-class-name= #精确分片算法类名称，用于=和IN。该类需实现PreciseShardingAlgorithm接口并提供无参数的构造器
  17. sharding.jdbc.config.sharding.tables.<logic-table-name>.database-strategy.standard.range-algorithm-class-name= #范围分片算法类名称，用于BETWEEN，可选。该类需实现RangeShardingAlgorithm接口并提供无参数的构造器
  19. #用于多分片键的复合分片场景
  20. sharding.jdbc.config.sharding.tables.<logic-table-name>.database-strategy.complex.sharding-columns= #分片列名称，多个列以逗号分隔
  21. sharding.jdbc.config.sharding.tables.<logic-table-name>.database-strategy.complex.algorithm-class-name= #复合分片算法类名称。该类需实现ComplexKeysShardingAlgorithm接口并提供无参数的构造器
  23. #行表达式分片策略
  24. sharding.jdbc.config.sharding.tables.<logic-table-name>.database-strategy.inline.sharding-column= #分片列名称
  25. sharding.jdbc.config.sharding.tables.<logic-table-name>.database-strategy.inline.algorithm-expression= #分片算法行表达式，需符合groovy语法
  27. #Hint分片策略
  28. sharding.jdbc.config.sharding.tables.<logic-table-name>.database-strategy.hint.algorithm-class-name= #Hint分片算法类名称。该类需实现HintShardingAlgorithm接口并提供无参数的构造器
  30. #分表策略，同分库策略
  31. sharding.jdbc.config.sharding.tables.<logic-table-name>.table-strategy.xxx= #省略
  33. sharding.jdbc.config.sharding.tables.<logic-table-name>.key-generator-column-name= #自增列名称，缺省表示不使用自增主键生成器
  34. sharding.jdbc.config.sharding.tables.<logic-table-name>.key-generator-class-name= #自增列值生成器类名称，缺省表示使用默认自增列值生成器。该类需提供无参数的构造器
  36. sharding.jdbc.config.sharding.tables.<logic-table-name>.logic-index= #逻辑索引名称，对于分表的Oracle/PostgreSQL数据库中DROP INDEX XXX语句，需要通过配置逻辑索引名称定位所执行SQL的真实分表
  38. sharding.jdbc.config.sharding.binding-tables[0]= #绑定表规则列表
  39. sharding.jdbc.config.sharding.binding-tables[1]= #绑定表规则列表
  40. sharding.jdbc.config.sharding.binding-tables[x]= #绑定表规则列表
  42. sharding.jdbc.config.sharding.broadcast-tables[0]= #广播表规则列表
  43. sharding.jdbc.config.sharding.broadcast-tables[1]= #广播表规则列表
  44. sharding.jdbc.config.sharding.broadcast-tables[x]= #广播表规则列表
  46. sharding.jdbc.config.sharding.default-data-source-name= #未配置分片规则的表将通过默认数据源定位
  47. sharding.jdbc.config.sharding.default-database-strategy.xxx= #默认数据库分片策略，同分库策略
  48. sharding.jdbc.config.sharding.default-table-strategy.xxx= #默认表分片策略，同分表策略
  49. sharding.jdbc.config.sharding.default-key-generator-class-name= #默认自增列值生成器类名称，缺省使用io.shardingsphere.core.keygen.DefaultKeyGenerator。该类需实现KeyGenerator接口并提供无参数的构造器
  51. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.master-data-source-name= #详见读写分离部分
  52. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[0]= #详见读写分离部分
  53. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[1]= #详见读写分离部分
  54. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[x]= #详见读写分离部分
  55. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-class-name= #详见读写分离部分
  56. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-type= #详见读写分离部分
  58. sharding.jdbc.config.props.sql.show= #是否开启SQL显示，默认值: false
  59. sharding.jdbc.config.props.executor.size= #工作线程数量，默认值: CPU核数
  61. sharding.jdbc.config.config.map.key1= #用户自定义配置
  62. sharding.jdbc.config.config.map.key2= #用户自定义配置
  63. sharding.jdbc.config.config.map.keyx= #用户自定义配置

读写分离

配置项说明

  1. #省略数据源配置，与数据分片一致
  3. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.master-data-source-name= #主库数据源名称
  4. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[0]= #从库数据源名称列表
  5. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[1]= #从库数据源名称列表
  6. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[x]= #从库数据源名称列表
  7. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-class-name= #从库负载均衡算法类名称。该类需实现MasterSlaveLoadBalanceAlgorithm接口且提供无参数构造器
  8. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-type= #从库负载均衡算法类型，可选值：ROUND_ROBIN，RANDOM。若`load-balance-algorithm-class-name`存在则忽略该配置
  10. sharding.jdbc.config.config.map.key1= #用户自定义配置
  11. sharding.jdbc.config.config.map.key2= #用户自定义配置
  12. sharding.jdbc.config.config.map.keyx= #用户自定义配置
  14. sharding.jdbc.config.props.sql.show= #是否开启SQL显示，默认值: false
  15. sharding.jdbc.config.props.executor.size= #工作线程数量，默认值: CPU核数
  16. sharding.jdbc.config.props.check.table.metadata.enabled= #是否在启动时检查分表元数据一致性，默认值: false

数据治理

配置项说明

  1. #省略数据源、数据分片和读写分离配置
  3. sharding.jdbc.config.sharding.orchestration.name= #数据治理实例名称
  4. sharding.jdbc.config.sharding.orchestration.overwrite= #本地配置是否覆盖注册中心配置。如果可覆盖，每次启动都以本地配置为准
  5. sharding.jdbc.config.sharding.orchestration.registry.server-lists= #连接注册中心服务器的列表。包括IP地址和端口号。多个地址用逗号分隔。如: host1:2181,host2:2181
  6. sharding.jdbc.config.sharding.orchestration.registry.namespace= #注册中心的命名空间
  7. sharding.jdbc.config.sharding.orchestration.registry.digest= #连接注册中心的权限令牌。缺省为不需要权限验证
  8. sharding.jdbc.config.sharding.orchestration.registry.operation-timeout-milliseconds= #操作超时的毫秒数，默认500毫秒
  9. sharding.jdbc.config.sharding.orchestration.registry.max-retries= #连接失败后的最大重试次数，默认3次
  10. sharding.jdbc.config.sharding.orchestration.registry.retry-interval-milliseconds= #重试间隔毫秒数，默认500毫秒
  11. sharding.jdbc.config.sharding.orchestration.registry.time-to-live-seconds= #临时节点存活秒数，默认60秒

shardingsphere-2.x

读写分离

配置项说明

  2. sharding.jdbc.config.masterslave.load-balance-algorithm-type= #从库负载均衡算法类型，可选值：ROUND_ROBIN，RANDOM。若`load-balance-algorithm-class-name`存在则忽略该配置
  3. sharding.jdbc.config.masterslave.name= #主库名称
  4. sharding.jdbc.config.masterslave.master-data-source-name= #主库数据源名称
  5. sharding.jdbc.config.masterslave.slave-data-source-names= #从数据源名称，多个使用逗号隔开

分库分表

配置说明

  2. sharding.jdbc.config.sharding.default-data-source-name= #未配置分片规则的表将通过默认数据源定位
  3. sharding.jdbc.config.sharding.default-database-strategy.inline.sharding-column= #默认分库数据列
  4. sharding.jdbc.config.sharding.default-database-strategy.inline.algorithm-expression= # 默认分库inline表达式
  5. sharding.jdbc.config.sharding.tables.<logic-table-name>.actualDataNodes= #由数据源名 + 表名组成，以小数点分隔。多个表以逗号分隔，支持inline表达式。缺省表示使用已知数据源与逻辑表名称生成数据节点。用于广播表（即每个库中都需要一个同样的表用于关联查询，多为字典表）或只分库不分表且所有库的表结构完全一致的情况
  6. sharding.jdbc.config.sharding.tables.<logic-table-name>.tableStrategy.inline.shardingColumn= #默认分表的列
  7. sharding.jdbc.config.sharding.tables.<logic-table-name>.tableStrategy.inline.algorithmInlineExpression= #默认分表inline表达式
  8. sharding.jdbc.config.sharding.tables.<logic-table-name>.keyGeneratorColumnName=  #默认自增列值生成器类名称

编排治理

配置项说明

  2. sharding.jdbc.config.orchestration.name= #数据治理实例名称
  3. sharding.jdbc.config.orchestration.overwrite= #本地配置是否覆盖注册中心配置。如果可覆盖，每次启动都以本地配置为准
  5. # zookeeper配置说明
  6. sharding.jdbc.config.orchestration.zookeeper.namespace= # zookeeper配置中心命名空间
  7. sharding.jdbc.config.orchestration.zookeeper.server-lists= #连接zookeeper注册中心服务器的列表。包括IP地址和端口号。多个地址用逗号分隔。如: host1:2181,host2:2181
  9. # etcd配置说明
  10. sharding.jdbc.config.orchestration.etcd.server-lists= #连接etcd注册中心服务器的列表。包括IP地址和端口号。多个地址用逗号分隔。如: host1:2181,host2:2181