CREATE SHARDING TABLE RULE

描述

CREATE SHARDING TABLE RULE 语法用于为当前所选逻辑库添加分片规则

语法定义

语法 铁路图

  1. CreateShardingTableRule ::=
  2.   'CREATE' 'SHARDING' 'TABLE' 'RULE' ifNotExists? (tableDefinition | autoTableDefinition) (',' (tableDefinition | autoTableDefinition))*
  4. ifNotExists ::=
  5.   'IF' 'NOT' 'EXISTS'
  7. tableDefinition ::= 
  8.   tableName '(' 'DATANODES' '(' dataNode (',' dataNode)* ')' (','  'DATABASE_STRATEGY' '(' strategyDefinition ')')? (','  'TABLE_STRATEGY' '(' strategyDefinition ')')? (','  'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' 'AUDIT_STRATEGY' '(' auditStrategyDefinition ')')? ')'
  10. autoTableDefinition ::=
  11.   tableName '(' 'STORAGE_UNITS' '(' storageUnitName (',' storageUnitName)*  ')' ',' 'SHARDING_COLUMN' '=' columnName ',' algorithmDefinition (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' 'AUDIT_STRATEGY' '(' auditStrategyDefinition ')')? ')'
  13. strategyDefinition ::=
  14.   'TYPE' '=' strategyType ',' ('SHARDING_COLUMN' | 'SHARDING_COLUMNS') '=' columnName ',' algorithmDefinition
  16. keyGenerateStrategyDefinition ::= 
  17.   'KEY_GENERATE_STRATEGY' '(' 'COLUMN' '=' columnName ',' algorithmDefinition ')' 
  19. auditStrategyDefinition ::= 
  20.   'AUDIT_STRATEGY' '(' algorithmDefinition (',' algorithmDefinition)* ')'
  22. algorithmDefinition ::=
  23.   'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)?')'
  25. propertiesDefinition ::=
  26.   'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'
  28. key ::=
  29.   string
  31. value ::=
  32.   literal
  34. tableName ::=
  35.   identifier
  37. dataNode ::=
  38.   string
  40. storageUnitName ::=
  41.   identifier
  43. columnName ::=
  44.   identifier
  46. algorithmType ::=
  47.   identifier
  49. strategyType ::=
  50.   string

补充说明

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

示例

1.标准分片规则

  1. CREATE SHARDING TABLE RULE t_order_item (
  2. DATANODES("ds_${0..1}.t_order_item_${0..1}"),
  3. DATABASE_STRATEGY(TYPE="standard",SHARDING_COLUMN=user_id,SHARDING_ALGORITHM(TYPE(NAME="inline",PROPERTIES("algorithm-expression"="ds_${user_id % 2}")))),
  4. TABLE_STRATEGY(TYPE="standard",SHARDING_COLUMN=order_id,SHARDING_ALGORITHM(TYPE(NAME="inline",PROPERTIES("algorithm-expression"="t_order_item_${order_id % 2}")))),
  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. CREATE SHARDING TABLE RULE t_order (
  2. STORAGE_UNITS(ds_0,ds_1),
  3. SHARDING_COLUMN=order_id,TYPE(NAME="hash_mod",PROPERTIES("sharding-count"="4")),
  4. KEY_GENERATE_STRATEGY(COLUMN=another_id,TYPE(NAME="snowflake")),
  5. AUDIT_STRATEGY (TYPE(NAME="DML_SHARDING_CONDITIONS"),ALLOW_HINT_DISABLE=true)
  6. );

3.使用 ifNotExists 子句创建分片规则

  • 标准分片规则
  1. CREATE SHARDING TABLE RULE IF NOT EXISTS t_order_item (
  2. DATANODES("ds_${0..1}.t_order_item_${0..1}"),
  3. DATABASE_STRATEGY(TYPE="standard",SHARDING_COLUMN=user_id,SHARDING_ALGORITHM(TYPE(NAME="inline",PROPERTIES("algorithm-expression"="ds_${user_id % 2}")))),
  4. TABLE_STRATEGY(TYPE="standard",SHARDING_COLUMN=order_id,SHARDING_ALGORITHM(TYPE(NAME="inline",PROPERTIES("algorithm-expression"="t_order_item_${order_id % 2}")))),
  5. KEY_GENERATE_STRATEGY(COLUMN=another_id,TYPE(NAME="snowflake")),
  6. AUDIT_STRATEGY (TYPE(NAME="DML_SHARDING_CONDITIONS"),ALLOW_HINT_DISABLE=true)
  7. );
  • 自动分片规则
  1. CREATE SHARDING TABLE RULE IF NOT EXISTS t_order (
  2. STORAGE_UNITS(ds_0,ds_1),
  3. SHARDING_COLUMN=order_id,TYPE(NAME="hash_mod",PROPERTIES("sharding-count"="4")),
  4. KEY_GENERATE_STRATEGY(COLUMN=another_id,TYPE(NAME="snowflake")),
  5. AUDIT_STRATEGY (TYPE(NAME="DML_SHARDING_CONDITIONS"),ALLOW_HINT_DISABLE=true)
  6. );

保留字

CREATE、SHARDING、TABLE、RULE、DATANODES、DATABASE_STRATEGY、TABLE_STRATEGY、KEY_GENERATE_STRATEGY、STORAGE_UNITS、SHARDING_COLUMN、TYPE、SHARDING_COLUMN、KEY_GENERATOR、SHARDING_ALGORITHM、COLUMN、NAME、PROPERTIES、AUDIT_STRATEGY、AUDITORS、ALLOW_HINT_DISABLE

相关链接