ALTER PLACEMENT POLICY

ALTER PLACEMENT POLICY is used to modify existing placement policies that have previously been created. All the tables and partitions which use the placement policy will automatically be updated.

ALTER PLACEMENT POLICY - 图1

Note

This feature is not available on TiDB Serverless clusters.

ALTER PLACEMENT POLICY replaces the previous policy with the new definition. It does not merge the old policy with the new one. In the following example, FOLLOWERS=4 is lost when the ALTER PLACEMENT POLICY is executed:

  1. CREATE PLACEMENT POLICY p1 FOLLOWERS=4;
  2. ALTER PLACEMENT POLICY p1 PRIMARY_REGION="us-east-1" REGIONS="us-east-1,us-west-1";

Synopsis

AlterPolicyStmt

ALTER PLACEMENT POLICY - 图2

PolicyName

ALTER PLACEMENT POLICY - 图3

PlacementOptionList

ALTER PLACEMENT POLICY - 图4

PlacementOption

ALTER PLACEMENT POLICY - 图5

CommonPlacementOption

ALTER PLACEMENT POLICY - 图6

SugarPlacementOption

ALTER PLACEMENT POLICY - 图7

AdvancedPlacementOption

ALTER PLACEMENT POLICY - 图8

  1. AlterPolicyStmt ::=
  2.     "ALTER" "PLACEMENT" "POLICY" IfExists 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

ALTER 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";
  2. CREATE TABLE t1 (i INT) PLACEMENT POLICY=p1; -- Assign policy p1 to table t1
  3. ALTER PLACEMENT POLICY p1 PRIMARY_REGION="us-east-1" REGIONS="us-east-1,us-west-1,us-west-2" FOLLOWERS=4; -- The rules of t1 will be updated automatically.
  4. SHOW CREATE PLACEMENT POLICY p1\G
  1. Query OK, 0 rows affected (0.08 sec)
  3. Query OK, 0 rows affected (0.10 sec)
  5. ***************************[ 1. row ]***************************
  6. Policy        | p1
  7. Create Policy | CREATE PLACEMENT POLICY `p1` PRIMARY_REGION="us-east-1" REGIONS="us-east-1,us-west-1,us-west-2" FOLLOWERS=4
  8. 1 row in set (0.00 sec)

MySQL compatibility

This statement is a TiDB extension to MySQL syntax.

See also