Sharding

Background

SpringBoot Starter’s data sharding configuration applies to business scenarios that use SpringBoot, which can maximize SpringBoot’s capabilities, such as configuration initialization and Bean management. It can complete the creation of the ShardingSphereDataSource object and reduce unnecessary coding.

Parameters

  1. spring.shardingsphere.datasource.names= # Omit the data source configuration, please refer to the usage
  3. # Standard sharding table configuration
  4. spring.shardingsphere.rules.sharding.tables.<table-name>.actual-data-nodes= # Describe data source names and actual tables, delimiter as point, multiple data nodes separated with comma, support inline expression. Absent means sharding databases only.
  6. # Databases sharding strategy, use default databases sharding strategy if absent. sharding strategy below can choose only one.
  8. # For single sharding column scenario
  9. spring.shardingsphere.rules.sharding.tables.<table-name>.database-strategy.standard.sharding-column= # Sharding column name
  10. spring.shardingsphere.rules.sharding.tables.<table-name>.database-strategy.standard.sharding-algorithm-name= # Sharding algorithm name
  12. # For multiple sharding columns scenario
  13. spring.shardingsphere.rules.sharding.tables.<table-name>.database-strategy.complex.sharding-columns= # Sharding column names, multiple columns separated with comma
  14. spring.shardingsphere.rules.sharding.tables.<table-name>.database-strategy.complex.sharding-algorithm-name= # Sharding algorithm name
  16. # Sharding by hint
  17. spring.shardingsphere.rules.sharding.tables.<table-name>.database-strategy.hint.sharding-algorithm-name= # Sharding algorithm name
  19. # Tables sharding strategy, same as database sharding strategy
  20. spring.shardingsphere.rules.sharding.tables.<table-name>.table-strategy.xxx= # Omitted
  22. # Auto sharding table configuraiton
  23. spring.shardingsphere.rules.sharding.auto-tables.<auto-table-name>.actual-data-sources= # data source names
  25. spring.shardingsphere.rules.sharding.auto-tables.<auto-table-name>.sharding-strategy.standard.sharding-column= # Sharding column name
  26. spring.shardingsphere.rules.sharding.auto-tables.<auto-table-name>.sharding-strategy.standard.sharding-algorithm-name= # Auto sharding algorithm name
  28. # Key generator strategy configuration
  29. spring.shardingsphere.rules.sharding.tables.<table-name>.key-generate-strategy.column= # Column name of key generator
  30. spring.shardingsphere.rules.sharding.tables.<table-name>.key-generate-strategy.key-generator-name= # Key generator name
  32. # Sharding auditor strategy configuration
  33. spring.shardingsphere.rules.sharding.tables.<table-name>.audit-strategy.auditor-names= # Sharding auditor name
  34. spring.shardingsphere.rules.sharding.tables.<table-name>.audit-strategy.allow-hint-disable= # Enable or disable sharding audit hint
  36. spring.shardingsphere.rules.sharding.binding-tables[0]= # Binding table name
  37. spring.shardingsphere.rules.sharding.binding-tables[1]= # Binding table name
  38. spring.shardingsphere.rules.sharding.binding-tables[x]= # Binding table name
  40. spring.shardingsphere.rules.sharding.broadcast-tables[0]= # Broadcast tables
  41. spring.shardingsphere.rules.sharding.broadcast-tables[1]= # Broadcast tables
  42. spring.shardingsphere.rules.sharding.broadcast-tables[x]= # Broadcast tables
  44. spring.shardingsphere.rules.sharding.default-database-strategy.xxx= # Default strategy for database sharding
  45. spring.shardingsphere.rules.sharding.default-table-strategy.xxx= # Default strategy for table sharding
  46. spring.shardingsphere.rules.sharding.default-key-generate-strategy.xxx= # Default Key generator strategy
  47. spring.shardingsphere.rules.sharding.default-sharding-column= # Default sharding column name
  49. # Sharding algorithm configuration
  50. spring.shardingsphere.rules.sharding.sharding-algorithms.<sharding-algorithm-name>.type= # Sharding algorithm type
  51. spring.shardingsphere.rules.sharding.sharding-algorithms.<sharding-algorithm-name>.props.xxx=# Sharding algorithm properties
  53. # Key generate algorithm configuration
  54. spring.shardingsphere.rules.sharding.key-generators.<key-generate-algorithm-name>.type= # Key generate algorithm type
  55. spring.shardingsphere.rules.sharding.key-generators.<key-generate-algorithm-name>.props.xxx= # Key generate algorithm properties
  57. # Sharding audit algorithm configuration
  58. spring.shardingsphere.rules.sharding.auditors.<sharding-audit-algorithm-name>.type= # Sharing audit algorithm type
  59. spring.shardingsphere.rules.sharding.auditors.<sharding-audit-algorithm-name>.props.xxx= # Sharding audit algorithm properties

Please refer to Built-in Sharding Algorithm List and Built-in Key Generate Algorithm List for more details about type of algorithm.

Attention: Inline expression identifier can use ${...} or $->{...}, but ${...} is conflict with spring placeholder of properties, so use $->{...} on spring environment is better.

Procedure

  1. Configure data sharding rules in the SpringBoot file, including data sources, sharding rules, and global attributes.
  2. Start the SpringBoot program. The configuration is automatically loaded and the ShardingSphereDataSource is initialized.

Sample

  1. spring.shardingsphere.mode.type=Standalone
  2. spring.shardingsphere.mode.repository.type=JDBC
  4. spring.shardingsphere.datasource.names=ds-0,ds-1
  6. spring.shardingsphere.datasource.ds-0.jdbc-url=jdbc:mysql://localhost:3306/demo_ds_0?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
  7. spring.shardingsphere.datasource.ds-0.type=com.zaxxer.hikari.HikariDataSource
  8. spring.shardingsphere.datasource.ds-0.driver-class-name=com.mysql.jdbc.Driver
  9. spring.shardingsphere.datasource.ds-0.username=root
  10. spring.shardingsphere.datasource.ds-0.password=
  12. spring.shardingsphere.datasource.ds-1.jdbc-url=jdbc:mysql://localhost:3306/demo_ds_1?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
  13. spring.shardingsphere.datasource.ds-1.type=com.zaxxer.hikari.HikariDataSource
  14. spring.shardingsphere.datasource.ds-1.driver-class-name=com.mysql.jdbc.Driver
  15. spring.shardingsphere.datasource.ds-1.username=root
  16. spring.shardingsphere.datasource.ds-1.password=
  18. spring.shardingsphere.rules.sharding.default-database-strategy.standard.sharding-column=user_id
  19. spring.shardingsphere.rules.sharding.default-database-strategy.standard.sharding-algorithm-name=database-inline
  20. spring.shardingsphere.rules.sharding.binding-tables[0]=t_order,t_order_item
  21. spring.shardingsphere.rules.sharding.broadcast-tables=t_address
  23. spring.shardingsphere.rules.sharding.tables.t_order.actual-data-nodes=ds-$->{0..1}.t_order_$->{0..1}
  24. spring.shardingsphere.rules.sharding.tables.t_order.table-strategy.standard.sharding-column=order_id
  25. spring.shardingsphere.rules.sharding.tables.t_order.table-strategy.standard.sharding-algorithm-name=t-order-inline
  27. spring.shardingsphere.rules.sharding.tables.t_order.key-generate-strategy.column=order_id
  28. spring.shardingsphere.rules.sharding.tables.t_order.key-generate-strategy.key-generator-name=snowflake
  29. spring.shardingsphere.rules.sharding.tables.t_order.audit-strategy.auditor-names=shardingKeyAudit
  30. spring.shardingsphere.rules.sharding.tables.t_order.audit-strategy.allow-hint-disable=true
  32. spring.shardingsphere.rules.sharding.tables.t_order_item.actual-data-nodes=ds-$->{0..1}.t_order_item_$->{0..1}
  33. spring.shardingsphere.rules.sharding.tables.t_order_item.table-strategy.standard.sharding-column=order_id
  34. spring.shardingsphere.rules.sharding.tables.t_order_item.table-strategy.standard.sharding-algorithm-name=t-order-item-inline
  36. spring.shardingsphere.rules.sharding.tables.t_order_item.key-generate-strategy.column=order_item_id
  37. spring.shardingsphere.rules.sharding.tables.t_order_item.key-generate-strategy.key-generator-name=snowflake
  39. spring.shardingsphere.rules.sharding.sharding-algorithms.database-inline.type=INLINE
  40. spring.shardingsphere.rules.sharding.sharding-algorithms.database-inline.props.algorithm-expression=ds-$->{user_id % 2}
  41. spring.shardingsphere.rules.sharding.sharding-algorithms.t-order-inline.type=INLINE
  42. spring.shardingsphere.rules.sharding.sharding-algorithms.t-order-inline.props.algorithm-expression=t_order_$->{order_id % 2}
  43. spring.shardingsphere.rules.sharding.sharding-algorithms.t-order-item-inline.type=INLINE
  44. spring.shardingsphere.rules.sharding.sharding-algorithms.t-order-item-inline.props.algorithm-expression=t_order_item_$->{order_id % 2}
  46. spring.shardingsphere.rules.sharding.key-generators.snowflake.type=SNOWFLAKE
  47. spring.shardingsphere.rules.sharding.auditors.shardingKeyAudit.type=DML_SHARDING_CONDITIONS