CREATE PLACEMENT POLICY

CREATE PLACEMENT POLICY is used to create a named placement policy that can later be assigned to tables, partitions, or database schemas.

CREATE PLACEMENT POLICY - 图1

Note

This feature is not available on TiDB Serverless clusters.

Synopsis

CreatePolicyStmt

CREATE PLACEMENT POLICY - 图2

PolicyName

CREATE PLACEMENT POLICY - 图3

PlacementOptionList

CREATE PLACEMENT POLICY - 图4

PlacementOption

CREATE PLACEMENT POLICY - 图5

CommonPlacementOption

CREATE PLACEMENT POLICY - 图6

SugarPlacementOption

CREATE PLACEMENT POLICY - 图7

AdvancedPlacementOption

CREATE PLACEMENT POLICY - 图8

  1. CreatePolicyStmt ::=
  2.     "CREATE" "PLACEMENT" "POLICY" IfNotExists PolicyName PlacementOptionList
  4. PolicyName ::=
  5.     Identifier
  7. PlacementOptionList ::=
  8.     PlacementOption
  9. |   PlacementOptionList PlacementOption
  10. |   PlacementOptionList ',' PlacementOption
  12. PlacementOption ::=
  13.     CommonPlacementOption
  14. |   SugarPlacementOption
  15. |   AdvancedPlacementOption
  17. CommonPlacementOption ::=
  18.     "FOLLOWERS" EqOpt LengthNum
  20. SugarPlacementOption ::=
  21.     "PRIMARY_REGION" EqOpt stringLit
  22. |   "REGIONS" EqOpt stringLit
  23. |   "SCHEDULE" EqOpt stringLit
  25. AdvancedPlacementOption ::=
  26.     "LEARNERS" EqOpt LengthNum
  27. |   "CONSTRAINTS" EqOpt stringLit
  28. |   "LEADER_CONSTRAINTS" EqOpt stringLit
  29. |   "FOLLOWER_CONSTRAINTS" EqOpt stringLit
  30. |   "LEARNER_CONSTRAINTS" EqOpt stringLit
  31. |   "SURVIVAL_PREFERENCES" EqOpt stringLit

Examples

CREATE PLACEMENT POLICY - 图9

Note

To know which regions are available in your cluster, see SHOW PLACEMENT LABELS.

If you do not see any available regions, your TiKV installation might not have labels set correctly.

  1. CREATE PLACEMENT POLICY p1 PRIMARY_REGION="us-east-1" REGIONS="us-east-1,us-west-1" FOLLOWERS=4;
  2. CREATE TABLE t1 (a INT) PLACEMENT POLICY=p1;
  3. SHOW CREATE PLACEMENT POLICY p1;
  1. Query OK, 0 rows affected (0.08 sec)
  3. Query OK, 0 rows affected (0.10 sec)
  5. +--------+---------------------------------------------------------------------------------------------------+
  6. | Policy | Create Policy                                                                                     |
  7. +--------+---------------------------------------------------------------------------------------------------+
  8. | p1     | CREATE PLACEMENT POLICY `p1` PRIMARY_REGION="us-east-1" REGIONS="us-east-1,us-west-1" FOLLOWERS=4 |
  9. +--------+---------------------------------------------------------------------------------------------------+
  10. 1 row in set (0.00 sec)

MySQL compatibility

This statement is a TiDB extension to MySQL syntax.

See also