TiDBTiDB Docs Dash 2024

Jan 9 - Jan 12 (UTC)
Join us to improve docs and win a prize!
Sign InTry Free

PLACEMENT_POLICIES

The PLACEMENT_POLICIES table provides information on all placement policies. For details, refer to Placement Rules in SQL.

USE information_schema; DESC placement_policies;
+----------------------+---------------+------+-----+---------+-------+ | Field | Type | Null | Key | Default | Extra | +----------------------+---------------+------+-----+---------+-------+ | POLICY_ID | bigint(64) | NO | | <null> | | | CATALOG_NAME | varchar(512) | NO | | <null> | | | POLICY_NAME | varchar(64) | NO | | <null> | | | PRIMARY_REGION | varchar(1024) | YES | | <null> | | | REGIONS | varchar(1024) | YES | | <null> | | | CONSTRAINTS | varchar(1024) | YES | | <null> | | | LEADER_CONSTRAINTS | varchar(1024) | YES | | <null> | | | FOLLOWER_CONSTRAINTS | varchar(1024) | YES | | <null> | | | LEARNER_CONSTRAINTS | varchar(1024) | YES | | <null> | | | SCHEDULE | varchar(20) | YES | | <null> | | | FOLLOWERS | bigint(64) | YES | | <null> | | | LEARNERS | bigint(64) | YES | | <null> | | +----------------------+---------------+------+-----+---------+-------+ 12 rows in set (0.00 sec)

Examples

The PLACEMENT_POLICIES table only shows all placement policies. To view the canonical version of placement rules (including all placement policies and objects assigned placement policies), use the statement SHOW PLACEMENT instead:

CREATE TABLE t1 (a INT); CREATE PLACEMENT POLICY p1 primary_region="us-east-1" regions="us-east-1"; CREATE TABLE t3 (a INT) PLACEMENT POLICY=p1; SHOW PLACEMENT; -- Shows all information, including table t3. SELECT * FROM information_schema.placement_policies; -- Only shows placement policies, excluding t3.
Query OK, 0 rows affected (0.09 sec) Query OK, 0 rows affected (0.11 sec) Query OK, 0 rows affected (0.08 sec) +---------------+------------------------------------------------+------------------+ | Target | Placement | Scheduling_State | +---------------+------------------------------------------------+------------------+ | POLICY p1 | PRIMARY_REGION="us-east-1" REGIONS="us-east-1" | NULL | | TABLE test.t3 | PRIMARY_REGION="us-east-1" REGIONS="us-east-1" | PENDING | +---------------+------------------------------------------------+------------------+ 2 rows in set (0.00 sec) +-----------+--------------+-------------+----------------+-----------+-------------+--------------------+----------------------+---------------------+----------+-----------+----------+ | POLICY_ID | CATALOG_NAME | POLICY_NAME | PRIMARY_REGION | REGIONS | CONSTRAINTS | LEADER_CONSTRAINTS | FOLLOWER_CONSTRAINTS | LEARNER_CONSTRAINTS | SCHEDULE | FOLLOWERS | LEARNERS | +-----------+--------------+-------------+----------------+-----------+-------------+--------------------+----------------------+---------------------+----------+-----------+----------+ | 1 | def | p1 | us-east-1 | us-east-1 | | | | | | 2 | 0 | +-----------+--------------+-------------+----------------+-----------+-------------+--------------------+----------------------+---------------------+----------+-----------+----------+ 1 rows in set (0.00 sec)

Was this page helpful?

Download PDFRequest docs changesAsk questions on Discord
Playground
New
One-stop & interactive experience of TiDB's capabilities WITHOUT registration.
Products
TiDB
TiDB Dedicated
TiDB Serverless
Pricing
Get Demo
Get Started
© 2024 PingCAP. All Rights Reserved.
Privacy Policy.