Spring Boot Start 配置

    配置项说明

    读写分离

    配置项说明

    3. spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.primary-data-source-name= # Write data source name
    4. spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.replica-data-source-names= # Read data source names, multiple data source names separated with comma
    5. spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.load-balancer-name= # Load balance algorithm name
    7. # Load balance algorithm configuration
    8. spring.shardingsphere.rules.readwrite-splitting.load-balancers.<load-balance-algorithm-name>.type= # Load balance algorithm type
    9. spring.shardingsphere.rules.readwrite-splitting.load-balancers.<load-balance-algorithm-name>.props.xxx= # Load balance algorithm properties

    Please refer to for more details about type of algorithm.

    加密

    配置项说明

    1. spring.shardingsphere.datasource.names= # Omit the data source configuration, please refer to the usage
    3. spring.shardingsphere.rules.encrypt.tables.<table-name>.columns.<column-name>.cipher-column= # Cipher column name
    4. spring.shardingsphere.rules.encrypt.tables.<table-name>.columns.<column-name>.assisted-query-column= # Assisted query column name
    5. spring.shardingsphere.rules.encrypt.tables.<table-name>.columns.<column-name>.plain-column= # Plain column name
    6. spring.shardingsphere.rules.encrypt.tables.<table-name>.columns.<column-name>.encryptor-name= # Encrypt algorithm name
    8. spring.shardingsphere.rules.encrypt.encryptors.<encrypt-algorithm-name>.type= # Encrypt algorithm type
    9. spring.shardingsphere.rules.encrypt.encryptors.<encrypt-algorithm-name>.props.xxx= # Encrypt algorithm properties

    影子库

    配置项说明

    1. spring.shardingsphere.datasource.names= # Omit the data source configuration, please refer to the usage
    3. spring.shardingsphere.rules.shadow.column= # Shadow column name
    4. spring.shardingsphere.rules.shadow.shadow-mappings.<product-data-source-name>= # Shadow data source name

    分布式治理

    配置项说明

    Management
    1. spring.shardingsphere.governance.name= # Governance name
    2. spring.shardingsphere.governance.registry-center.type= # Governance instance type. Example:Zookeeper, etcd, Apollo, Nacos
    3. spring.shardingsphere.governance.registry-center.server-lists= # The list of servers that connect to governance instance, including IP and port number; use commas to separate
    4. spring.shardingsphere.governance.registry-center.props= # Other properties
    5. spring.shardingsphere.governance.overwrite= # Whether to overwrite local configurations with config center configurations; if it can, each initialization should refer to local configurations

    配置项说明

    数据分片

    配置项说明

    1. spring.shardingsphere.datasource.names= #Data source name; multiple data sources are separated by commas
    3. spring.shardingsphere.datasource.<data-source-name>.type= #Database connection pool type name
    4. spring.shardingsphere.datasource.<data-source-name>.driver-class-name= #Database driver class name
    5. spring.shardingsphere.datasource.<data-source-name>.url= #Database url connection
    6. spring.shardingsphere.datasource.<data-source-name>.username= #Database username
    7. spring.shardingsphere.datasource.<data-source-name>.password= #Database password
    8. spring.shardingsphere.datasource.<data-source-name>.xxx= #Other properties of database connection pool
    10. spring.shardingsphere.sharding.tables.<logic-table-name>.actual-data-nodes= #It is consisted of data source name + table name, separated by decimal points; multiple tables are separated by commas and support inline expressions; default means using existing data sources and logic table names to generate data nodes; it can be applied in broadcast tables (each database needs a same table for relevance query, dictionary table mostly) or the situation with sharding database but without sharding table (table structures of all the databases are consistent)
    12. #Database sharding strategy; default means using default database sharding strategy; it can only choose one of the following sharding strategies
    14. #It is applied in standard sharding situation of single-sharding key
    15. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.standard.sharding-column= #Sharding column name
    16. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.standard.precise-algorithm-class-name= #Precise algorithm class name, applied in = and IN; the class needs to implement PreciseShardingAlgorithm interface and provide parameter-free constructor
    17. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.standard.range-algorithm-class-name= #Range sharding algorithm class name, applied in BETWEEN, optional; the class should implement RangeShardingAlgorithm interface and provide parameter-free constructor
    19. #It is applied in complex sharding situations with multiple sharding keys
    20. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.complex.sharding-columns= #Sharding column name, with multiple columns separated by commas
    21. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.complex.algorithm-class-name= #Complex sharding algorithm class name; the class needs to implement ComplexKeysShardingAlgorithm interface and provide parameter-free constructor
    23. #Inline expression sharding strategy
    24. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.inline.sharding-column= #Sharding column name
    25. spring.shardingsphere.sharding.tables.<logic-table-name>.database-strategy.inline.algorithm-expression= #Inline expression of sharding algorithm, which needs to conform to groovy statements
    27. #Hint Sharding Strategy
    30. #Table sharding strategy, same as database sharding strategy
    31. spring.shardingsphere.sharding.tables.<logic-table-name>.table-strategy.xxx= #Omitted
    33. spring.shardingsphere.sharding.tables.<logic-table-name>.key-generator.column= #Auto-increment column name; default means not using auto-increment key generator
    34. spring.shardingsphere.sharding.tables.<logic-table-name>.key-generator.type= #Auto-increament key generator type; default means using default auto-increament key generator; user defined generator or internal generator (SNOWFLAKE, UUID) can both be selected
    35. spring.shardingsphere.sharding.tables.<logic-table-name>.key-generator.props.<property-name>= #Properties, Notice: when use SNOWFLAKE, `worker.id` and `max.tolerate.time.difference.milliseconds` for `SNOWFLAKE` need to be set. To use the generated value of this algorithm as sharding value, it is recommended to configure `max.vibration.offset`
    37. spring.shardingsphere.sharding.binding-tables[0]= #Binding table rule list
    38. spring.shardingsphere.sharding.binding-tables[1]= #Binding table rule list
    39. spring.shardingsphere.sharding.binding-tables[x]= #Binding table rule list
    41. spring.shardingsphere.sharding.broadcast-tables[0]= #Broadcast table rule list
    42. spring.shardingsphere.sharding.broadcast-tables[1]= #Broadcast table rule list
    43. spring.shardingsphere.sharding.broadcast-tables[x]= #Broadcast table rule list
    45. spring.shardingsphere.sharding.default-data-source-name= #Tables without sharding rules will be located through default data source
    46. spring.shardingsphere.sharding.default-database-strategy.xxx= #Default database sharding strategy
    47. spring.shardingsphere.sharding.default-table-strategy.xxx= #Default table sharding strategy
    48. spring.shardingsphere.sharding.default-key-generator.type= #Default auto-increament key generator of type; it will use org.apache.shardingsphere.core.keygen.generator.impl.SnowflakeKeyGenerator in default; user defined generator or internal generator (SNOWFLAKE or UUID) can both be used
    49. spring.shardingsphere.sharding.default-key-generator.props.<property-name>= #Auto-increament key generator property configuration, such as worker.id and max.tolerate.time.difference.milliseconds of SNOWFLAKE algorithm
    51. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.master-data-source-name= #Refer to readwrite-splitting part for more details
    52. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[0]= #Refer to readwrite-splitting part for more details
    53. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[1]= #Refer to readwrite-splitting part for more details
    54. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[x]= #Refer to readwrite-splitting part for more details
    55. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-class-name= #Refer to readwrite-splitting part for more details
    56. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-type= #Refer to readwrite-splitting part for more details
    58. spring.shardingsphere.props.sql.show= #Show SQL or not; default value: false
    59. spring.shardingsphere.props.executor.size= #Executing thread number; default value: CPU core number

    读写分离

    配置项说明

    1. #Omit data source configurations; keep it consistent with data sharding
    3. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.master-data-source-name= #Data source name of master database
    4. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[1]= #Data source name list of slave database
    5. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[x]= #Data source name list of slave database
    6. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-class-name= #Load balance algorithm class name; the class needs to implement MasterSlaveLoadBalanceAlgorithm interface and provide parameter-free constructor
    7. spring.shardingsphere.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-type= #Load balance algorithm class of slave database; optional value: ROUND_ROBIN and RANDOM; if there is load-balance-algorithm-class-name, the configuration can be omitted
    9. spring.shardingsphere.props.sql.show= #Show SQL or not; default value: false
    10. spring.shardingsphere.props.executor.size= #Executing thread number; default value: CPU core number
    11. spring.shardingsphere.props.check.table.metadata.enabled= #Whether to check meta-data consistency of sharding table when it initializes; default value: false

    数据脱敏

    配置项说明

    1. #Omit data source configurations; keep it consistent with data sharding
    3. spring.shardingsphere.encrypt.encryptors.<encryptor-name>.type= #Type of encryptor，use user-defined ones or built-in ones, e.g. MD5/AES  
    4. spring.shardingsphere.encrypt.encryptors.<encryptor-name>.props.<property-name>= #Properties, Notice: when use AES encryptor, `aes.key.value` for AES encryptor need to be set
    5. spring.shardingsphere.encrypt.tables.<table-name>.columns.<logic-column-name>.plainColumn= #Plain column name
    6. spring.shardingsphere.encrypt.tables.<table-name>.columns.<logic-column-name>.cipherColumn= #Cipher column name 
    7. spring.shardingsphere.encrypt.tables.<table-name>.columns.<logic-column-name>.assistedQueryColumn= #AssistedColumns for query，when use ShardingQueryAssistedEncryptor, it can help query encrypted data
    8. spring.shardingsphere.encrypt.tables.<table-name>.columns.<logic-column-name>.encryptor= #Encryptor name

    治理

    配置项说明

    1. #Omit data source, data sharding, readwrite split and data masking configurations
    3. spring.shardingsphere.orchestration.name= #Orchestration instance name
    5. spring.shardingsphere.orchestration.registry.type= #Registry center type. Example:zookeeper
    6. spring.shardingsphere.orchestration.registry.server-lists= #The list of servers that connect to registry center, including IP and port number; use commas to separate
    7. spring.shardingsphere.orchestration.registry.namespace= #Registry center namespace
    8. spring.shardingsphere.orchestration.registry.digest= #The token that connects to the registry center; default means there is no need for authentication
    9. spring.shardingsphere.orchestration.registry.operation-timeout-milliseconds= #The millisecond number for operation timeout; default value: 500 milliseconds
    10. spring.shardingsphere.orchestration.registry.max-retries= #Maximum retry time after failing; default value: 3 times
    11. spring.shardingsphere.orchestration.registry.retry-interval-milliseconds= #Interval time to retry; default value: 500 milliseconds
    12. spring.shardingsphere.orchestration.registry.time-to-live-seconds= #Living time of temporary nodes; default value: 60 seconds
    13. spring.shardingsphere.orchestration.registry.props= #Customize registry center props.

    配置项说明

    读写分离

    配置项说明

    1. #Ignore data sources configuration, same as sharding
    3. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.master-data-source-name= #Name of master data source
    4. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[0]=  #Name of master data source
    5. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[1]= #Names of Slave data sources
    6. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.slave-data-source-names[x]= #Names of Slave data sources
    7. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-class-name= #Load balance algorithm class name. This class need to implements MasterSlaveLoadBalanceAlgorithm, and require a no argument constructor 
    8. sharding.jdbc.config.sharding.master-slave-rules.<master-slave-data-source-name>.load-balance-algorithm-type= #Load balance algorithm type, values should be: `ROUND_ROBIN` or `RANDOM`. Ignore if `load-balance-algorithm-class-name` is present 
    10. sharding.jdbc.config.config.map.key1= #User-defined arguments
    11. sharding.jdbc.config.config.map.key2= #User-defined arguments
    12. sharding.jdbc.config.config.map.keyx= #User-defined arguments
    14. sharding.jdbc.config.props.sql.show= #To show SQLS or not, default value: false
    15. sharding.jdbc.config.props.executor.size= #The number of working threads, default value: CPU count
    16. sharding.jdbc.config.props.check.table.metadata.enabled= #Check the metadata consistency of all the tables, default value: false

    治理

    配置项说明

    1. #Ignore data sources, sharding and readwrite splitting configuration
    3. sharding.jdbc.config.sharding.orchestration.name= #Name of orchestration instance
    4. sharding.jdbc.config.sharding.orchestration.overwrite= #Use local configuration to overwrite registry center or not
    5. sharding.jdbc.config.sharding.orchestration.registry.server-lists= #Rgistry servers list, multiple split as comma. Example: host1:2181,host2:2181
    6. sharding.jdbc.config.sharding.orchestration.registry.namespace= #Namespace of registry
    7. sharding.jdbc.config.sharding.orchestration.registry.digest= #Digest for registry. Default is not need digest.
    8. sharding.jdbc.config.sharding.orchestration.registry.operation-timeout-milliseconds= #Operation timeout time in milliseconds, default value is 500 milliseconds
    9. sharding.jdbc.config.sharding.orchestration.registry.max-retries= #Max number of times to retry, default value is 3
    10. sharding.jdbc.config.sharding.orchestration.registry.retry-interval-milliseconds= #Time interval in milliseconds on each retry, default value is 500 milliseconds
    11. sharding.jdbc.config.sharding.orchestration.registry.time-to-live-seconds= #Time to live in seconds of ephemeral keys, default value is 60 seconds

    分库分表

    配置项说明

    1. # Ignore data sources configuration
    2. sharding.jdbc.config.sharding.default-data-source-name= #Tables without sharding rules will be located through default data source
    3. sharding.jdbc.config.sharding.default-database-strategy.inline.sharding-column= #Name of database sharding column
    4. sharding.jdbc.config.sharding.default-database-strategy.inline.algorithm-expression= #Inline expression for database sharding algorithm
    5. sharding.jdbc.config.sharding.tables.t_order.actualDataNodes= #Describe data source names and actual tables, delimiter as point, multiple data nodes separated with comma, support inline expression. Absent means sharding databases only. Example: ds${0..7}.tbl${0..7}
    6. sharding.jdbc.config.sharding.tables.t_order.tableStrategy.inline.shardingColumn= #Name of table sharding column
    7. sharding.jdbc.config.sharding.tables.t_order.tableStrategy.inline.algorithmInlineExpression= #Inline expression for table sharding algorithm
    8. sharding.jdbc.config.sharding.tables.t_order.keyGeneratorColumnName= #Column name of key generator, do not use Key generator if absent
    11. sharding.jdbc.config.sharding.tables.<logic-table-name>.key-generator-column-name= #Column name of key generator, do not use Key generator if absent
    12. sharding.jdbc.config.sharding.tables.<logic-table-name>.key-generator-class-name= #Key generator, use default key generator if absent. This class need to implements KeyGenerator, and require a no argument constructor

    读写分离

    配置项说明

    1. # Ignore data sources configuration
    3. sharding.jdbc.config.masterslave.load-balance-algorithm-type= #Load balance algorithm class of slave database; optional value: ROUND_ROBIN and RANDOM; if there is load-balance-algorithm-class-name, the configuration can be omitted
    4. sharding.jdbc.config.masterslave.name= # master name
    5. sharding.jdbc.config.masterslave.master-data-source-name= #Name of master data source

    配置项说明