Skip to content

ALTER SHARDING KEY GENERATOR

Description

The ALTER SHARDING KEY GENERATOR syntax is used to alter an independent sharding key generator in the currently selected database.

Syntax

AlterShardingKeyGenerator ::=
  'ALTER' 'SHARDING' 'KEY' 'GENERATOR' keyGeneratorName '(' algorithmDefinition ')'

algorithmDefinition ::=
  'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'

propertiesDefinition ::=
  'PROPERTIES' '(' (key '=' value (',' key '=' value)*)? ')'

key ::=
  string

value ::=
  literal

keyGeneratorName ::=
  identifier

algorithmType ::=
  string

Supplement

  • keyGeneratorName is the name of the sharding key generator to be altered;
  • algorithmDefinition defines the new key generator algorithm and its properties;
  • If the specified sharding key generator does not exist, a missing rule error will be reported;
  • algorithmType is the key generation algorithm type. For details, refer to Distributed Primary Key.

Example

  • Alter a sharding key generator
ALTER SHARDING KEY GENERATOR snowflake_generator (
TYPE(NAME="UUID")
);
  • Alter a sharding key generator with properties
ALTER SHARDING KEY GENERATOR snowflake_generator (
TYPE(NAME="SNOWFLAKE",PROPERTIES("worker-id"=2))
);

Reserved word

ALTER, SHARDING, KEY, GENERATOR, TYPE, NAME, PROPERTIES

Related links