ALTER SHARDING TABLE RULE

描述

ALTER SHARDING TABLE RULE 语法用于修改当前所选逻辑库的分片规则

语法定义

语法 铁路图

  1. AlterShardingTableRule ::=
  2. 'ALTER' 'SHARDING' 'TABLE' 'RULE' (tableDefinition | autoTableDefinition) (',' (tableDefinition | autoTableDefinition))*
  3. tableDefinition ::=
  4. tableName '(' 'DATANODES' '(' dataNode (',' dataNode)* ')' (',' 'DATABASE_STRATEGY' '(' strategyDefinition ')')? (',' 'TABLE_STRATEGY' '(' strategyDefinition ')')? (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' 'AUDIT_STRATEGY' '(' auditStrategyDefinition ')')? ')'
  5. autoTableDefinition ::=
  6. tableName '(' 'STORAGE_UNITS' '(' storageUnitName (',' storageUnitName)* ')' ',' 'SHARDING_COLUMN' '=' columnName ',' algorithmDefinition (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' 'AUDIT_STRATEGY' '(' auditStrategyDefinition ')')? ')'
  7. strategyDefinition ::=
  8. 'TYPE' '=' strategyType ',' ('SHARDING_COLUMN' | 'SHARDING_COLUMNS') '=' columnName ',' algorithmDefinition
  9. keyGenerateStrategyDefinition ::=
  10. 'KEY_GENERATE_STRATEGY' '(' 'COLUMN' '=' columnName ',' algorithmDefinition ')'
  11. auditStrategyDefinition ::=
  12. 'AUDIT_STRATEGY' '(' algorithmDefinition (',' algorithmDefinition)* ')'
  13. algorithmDefinition ::=
  14. 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)?')'
  15. propertiesDefinition ::=
  16. 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'
  17. key ::=
  18. string
  19. value ::=
  20. literal
  21. tableName ::=
  22. identifier
  23. dataNode ::=
  24. string
  25. storageUnitName ::=
  26. identifier
  27. columnName ::=
  28. identifier
  29. algorithmType ::=
  30. identifier
  31. strategyType ::=
  32. string

补充说明

  • tableDefinition 为标准分片规则定义;
  • autoTableDefinition为自动分片规则定义。标准分片规则和自动分片规则可参考数据分片
  • 当使用标准分片时:
    • DATANODES 只能使用已经添加到当前逻辑库的资源,且只能使用 INLINE 表达式指定需要的资源;
    • DATABASE_STRATEGYTABLE_STRATEGY 表示分库和分表策略,均为可选项,未配置时使用默认策略;
    • strategyDefinition 中属性 TYPE 用于指定分片算法的类型,目前仅支持 STANDARDCOMPLEX。使用 COMPLEX 时需要用 SHARDING_COLUMNS 指定多个分片键。
  • 当使用自动分片时:
    • STORAGE_UNITS 只能使用已经添加到当前逻辑库的资源,可通过枚举或 INLINE 表达式指定需要的资源;
    • 只能使用自动分片算法,可参考自动分片算法
  • algorithmType 为分片算法类型,分片算法类型请参考分片算法
  • 自动生成的算法命名规则为 tableName _ strategyType _ algorithmType
  • 自动生成的主键策略命名规则为 tableName _ strategyType
  • KEY_GENERATE_STRATEGY 用于指定主键生成策略,为可选项,关于主键生成策略可参考分布式主键
  • AUDIT_STRATEGY 用于指定分配审计生成策略,为可选项,关于分片审计生成策略可参考分片审计

示例

1.标准分片规则

  1. ALTER SHARDING TABLE RULE t_order_item (
  2. DATANODES("ds_${0..3}.t_order_item${0..3}"),
  3. DATABASE_STRATEGY(TYPE="standard",SHARDING_COLUMN=user_id,SHARDING_ALGORITHM(TYPE(NAME="inline",PROPERTIES("algorithm-expression"="ds_${user_id % 4}")))),
  4. TABLE_STRATEGY(TYPE="standard",SHARDING_COLUMN=order_id,SHARDING_ALGORITHM(TYPE(NAME="inline",PROPERTIES("algorithm-expression"="t_order_item_${order_id % 4}")))),
  5. KEY_GENERATE_STRATEGY(COLUMN=another_id,TYPE(NAME="snowflake")),
  6. AUDIT_STRATEGY(TYPE(NAME="dml_sharding_conditions"),ALLOW_HINT_DISABLE=true)
  7. );

2.自动分片规则

  1. ALTER SHARDING TABLE RULE t_order (
  2. STORAGE_UNITS(ds_0,ds_1,ds_2,ds_3),
  3. SHARDING_COLUMN=order_id,TYPE(NAME="hash_mod",PROPERTIES("sharding-count"="16")),
  4. KEY_GENERATE_STRATEGY(COLUMN=another_id,TYPE(NAME="snowflake")),
  5. AUDIT_STRATEGY(TYPE(NAME="dml_sharding_conditions"),ALLOW_HINT_DISABLE=true)
  6. );

保留字

ALTERSHARDINGTABLERULEDATANODESDATABASE_STRATEGYTABLE_STRATEGYKEY_GENERATE_STRATEGYSTORAGE_UNITSSHARDING_COLUMNTYPESHARDING_COLUMNKEY_GENERATORSHARDING_ALGORITHMCOLUMNNAMEPROPERTIESAUDIT_STRATEGYAUDITORSALLOW_HINT_DISABLE

相关链接