You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2022/11/05 13:07:55 UTC

[shardingsphere] branch master updated: Update DistSQL documents (#21970)

This is an automated email from the ASF dual-hosted git repository.

zhangliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git


The following commit(s) were added to refs/heads/master by this push:
     new a08e67e24c0 Update DistSQL documents (#21970)
a08e67e24c0 is described below

commit a08e67e24c039e1f14a5d28c8162417df65787fa
Author: Zichao <57...@users.noreply.github.com>
AuthorDate: Sun Nov 6 02:07:48 2022 +1300

    Update DistSQL documents (#21970)
---
 .../enable-disable-compute-node.cn.md              |  3 +-
 .../enable-disable-compute-node.en.md              |  3 +-
 .../label-relabel-compute-node.cn.md               | 48 ++++++++++++++
 .../label-relabel-compute-node.en.md               | 50 +++++++++++++++
 .../ral/circuit-breaker/unlabel-compute-node.cn.md | 41 ++++++++++++
 .../ral/circuit-breaker/unlabel-compute-node.en.md | 42 ++++++++++++
 .../ral/global-rule/alter-traffic-rule.cn.md       | 61 ++++++++++++++++++
 .../ral/global-rule/alter-traffic-rule.en.md       | 61 ++++++++++++++++++
 .../ral/global-rule/create-traffic-rule.cn.md      | 61 ++++++++++++++++++
 .../ral/global-rule/create-traffic-rule.en.md      | 61 ++++++++++++++++++
 .../syntax/ral/global-rule/drop-traffic-rule.cn.md | 39 +++++++++++
 .../syntax/ral/global-rule/drop-traffic-rule.en.md | 39 +++++++++++
 .../syntax/ral/global-rule/show-traffic-rule.cn.md | 73 +++++++++++++++++++++
 .../syntax/ral/global-rule/show-traffic-rule.en.md | 75 ++++++++++++++++++++++
 .../reference/distsql/syntax/reserved-word.cn.md   |  2 +-
 .../reference/distsql/syntax/reserved-word.en.md   |  2 +-
 16 files changed, 657 insertions(+), 4 deletions(-)

diff --git a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/enable-disable-compute-node.cn.md b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/enable-disable-compute-node.cn.md
index d7cb60f6fb6..5ad5f68f5ac 100644
--- a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/enable-disable-compute-node.cn.md
+++ b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/enable-disable-compute-node.cn.md
@@ -19,7 +19,7 @@ instanceId ::=
 
 ### 补充说明
 
-- `instanceId` 需要通过 `SHOW COMPUTE NODES` 语法查询得到
+- `instanceId` 需要通过 [SHOW COMPUTE NODES](/cn/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes/) 语法查询得到
 
 - 不可禁用当前正在使用的 proxy 实例
 
@@ -44,3 +44,4 @@ ENABLE COMPUTE NODE '734bb086-b15d-4af0-be87-2372d8b6a0cd';
 ### 相关链接
 
 - [保留字](/cn/reference/distsql/syntax/reserved-word/)
+- [SHOW COMPUTE NODES](/cn/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/enable-disable-compute-node.en.md b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/enable-disable-compute-node.en.md
index 6494cadc2d7..3d140df1ae5 100644
--- a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/enable-disable-compute-node.en.md
+++ b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/enable-disable-compute-node.en.md
@@ -19,7 +19,7 @@ instanceId ::=
 
 ### Supplement
 
-- `instanceId` needs to be obtained through `SHOW COMPUTE NODES` syntax query
+- `instanceId` needs to be obtained through [SHOW COMPUTE NODES](/en/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes/) syntax query
 
 - The currently in-use proxy instance cannot be disabled
 
@@ -43,3 +43,4 @@ ENABLE COMPUTE NODE '734bb086-b15d-4af0-be87-2372d8b6a0cd';
 ### Related links
 
 - [Reserved word](/en/reference/distsql/syntax/reserved-word/)
+- [SHOW COMPUTE NODES](/en/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/label-relabel-compute-node.cn.md b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/label-relabel-compute-node.cn.md
new file mode 100644
index 00000000000..0c46fb4e834
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/label-relabel-compute-node.cn.md
@@ -0,0 +1,48 @@
++++
+title = "LABEL|RELABEL COMPUTE NODE"
+weight = 6
++++
+
+### 描述
+
+`LABEL|RELABEL COMPUTE NODE` 语法用于为 `PROXY` 实例添加标签
+
+### 语法
+
+```sql
+LableRelabelComputeNodes ::=
+  ('LABEL'|'RELABEL') 'COMPUTE' 'NODE' instance_id 'WITH' labelName
+
+instance_id ::=
+  string
+
+labelName ::=
+  identifier
+```
+### 补充说明
+
+- `instance_id` 需要通过 [SHOW COMPUTE NODES](/cn/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes/) 语法查询获得
+
+- `RELABEL` 用于为 `PROXY` 实例修改标签
+
+### 示例
+
+- 为 `PROXY` 实例添加标签
+
+```sql
+LABEL COMPUTE NODE "0699e636-ade9-4681-b37a-65240c584bb3" WITH label_1;
+```
+
+- 为 `PROXY` 实例修改标签
+```sql
+RELABEL COMPUTE NODE "0699e636-ade9-4681-b37a-65240c584bb3" WITH label_2;
+```
+
+### 保留字
+
+`LABEL`、`RELABEL`、`COMPUTE`、`NODE` 、`WITH`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
+- [SHOW COMPUTE NODES](/cn/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/label-relabel-compute-node.en.md b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/label-relabel-compute-node.en.md
new file mode 100644
index 00000000000..09e6af500b8
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/label-relabel-compute-node.en.md
@@ -0,0 +1,50 @@
++++
+title = "LABEL|RELABEL COMPUTE NODES"
+weight = 6
++++
+
+### Description
+
+The `LABEL|RELABEL COMPUTE NODES` syntax is used to label `PROXY` instance.
+
+### Syntax
+
+```sql
+LableRelabelComputeNodes ::=
+  ('LABEL'|'RELABEL') 'COMPUTE' 'NODE' instance_id 'WITH' labelName
+
+instance_id ::=
+  string
+
+labelName ::=
+  identifier
+```
+
+### Supplement
+
+- needs to be obtained through [SHOW COMPUTE NODES](/en/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes/) syntax query
+
+- `RELABEL` is used to relabel `PROXY` instance
+
+### Example
+
+- Label `PROXY` instance
+
+```sql
+LABEL COMPUTE NODE "0699e636-ade9-4681-b37a-65240c584bb3" WITH label_1;
+```
+
+- Relabel `PROXY` instance
+
+```sql
+RELABEL COMPUTE NODE "0699e636-ade9-4681-b37a-65240c584bb3" WITH label_2;
+```
+
+### Reserved word
+
+`LABEL`, `RELABEL`, `COMPUTE`, `NODES`, `WITH`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
+- [SHOW COMPUTE NODES](/en/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/unlabel-compute-node.cn.md b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/unlabel-compute-node.cn.md
new file mode 100644
index 00000000000..5d05abcebfa
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/unlabel-compute-node.cn.md
@@ -0,0 +1,41 @@
++++
+title = "UNLABEL COMPUTE NODE"
+weight = 7
++++
+
+### 描述
+
+`UNLABEL COMPUTE NODE` 语法用于为 `PROXY` 实例去除指定标签
+
+### 语法
+
+```sql
+UnlabelComputeNode ::=
+  'UNLABEL' 'COMPUTE' 'NODE' instance_id 'WITH' labelName
+
+instance_id ::=
+  string
+
+labelName ::=
+  identifier
+```
+### 补充说明
+
+- `instance_id` 需要通过 [SHOW COMPUTE NODES](/cn/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes/) 语法查询获得
+
+### 示例
+
+- 为 `PROXY` 实例去除指定标签
+
+```sql
+UNLABEL COMPUTE NODE "0699e636-ade9-4681-b37a-65240c584bb3" WITH label_1;
+```
+
+### 保留字
+
+`UNLABEL`、`COMPUTE`、`NODE`、`WITH`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
+- [SHOW COMPUTE NODES](/cn/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/unlabel-compute-node.en.md b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/unlabel-compute-node.en.md
new file mode 100644
index 00000000000..6144ed087dd
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/unlabel-compute-node.en.md
@@ -0,0 +1,42 @@
++++
+title = "UNLABEL COMPUTE NODES"
+weight = 6
++++
+
+### Description
+
+The `UNLABEL COMPUTE NODES` syntax is used to remove specified label from `PROXY` instance.
+
+### Syntax
+
+```sql
+UnlabelComputeNode ::=
+  'UNLABEL' 'COMPUTE' 'NODE' instance_id 'WITH' labelName
+
+instance_id ::=
+  string
+
+labelName ::=
+  identifier
+```
+
+### Supplement
+
+- needs to be obtained through [SHOW COMPUTE NODES](/en/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes/) syntax query
+
+### Example
+
+- Remove specified label from `PROXY` instance
+
+```sql
+UNLABEL COMPUTE NODE "0699e636-ade9-4681-b37a-65240c584bb3" WITH label_1;
+```
+
+### Reserved word
+
+`UNLABEL`, `COMPUTE`, `NODES`, `WITH`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
+- [SHOW COMPUTE NODES](/en/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-traffic-rule.cn.md b/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-traffic-rule.cn.md
new file mode 100644
index 00000000000..33e8ad0df98
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-traffic-rule.cn.md
@@ -0,0 +1,61 @@
++++
+title = "ALTER TRAFFIC RULE"
+weight = 8
++++
+
+## 描述
+
+`ALTER TRAFFIC RULE` 语法用于修改双路由规则
+
+### 语法定义
+
+```sql
+AlterTrafficRule ::=
+  'ALTER' 'TRAFFIC' 'RULE'  '(' 'LABELS' '(' lableName ')' ',' trafficAlgorithmDefination ',' loadBalancerDefination ')'
+
+lableName ::=
+  identifier
+
+trafficAlgorithmDefination ::=
+  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' = trafficAlgorithmTypeName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+
+loadBalancerDefination ::=
+  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' = loadBalancerName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+
+trafficAlgorithmTypeName ::=
+  string
+
+loadBalancerTypeName ::=
+  string
+
+key ::= 
+  string
+
+value ::=
+  string
+```
+
+### 补充说明
+
+- `TRAFFIC_ALGORITHM` 支持 `SQL_MATCH` 与 `SQL_HINT` 两种类型
+
+- `LOAD_BALANCER` 支持 `RANDOM` 与 `ROUND_ROBIN` 两种类型
+
+### 示例
+
+- 修改双路由规则
+
+```sql
+ALTER TRAFFIC RULE sql_match_traffic ( 
+  LABELS (OLTP),
+  TRAFFIC_ALGORITHM(TYPE(NAME="SQL_MATCH",PROPERTIES("sql" = "SELECT * FROM t_order WHERE order_id = 1; UPDATE t_order SET order_id = 5;"))),
+  LOAD_BALANCER(TYPE(NAME="RANDOM")));
+```
+
+### 保留字
+
+`ALTER`、`TRAFFIC`、`RULE`、`LABELS`、`TYPE`、`NAME`、`PROPERTIES`、`TRAFFIC_ALGORITHM`、`LOAD_BALANCER`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-traffic-rule.en.md b/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-traffic-rule.en.md
new file mode 100644
index 00000000000..552bc267e64
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-traffic-rule.en.md
@@ -0,0 +1,61 @@
++++
+title = "ALTER TRAFFIC RULE"
+weight = 8
++++
+
+### Description
+
+The `ALTER TRAFFIC RULE` syntax is used to alter dual routing rule.
+
+### Syntax
+
+```sql
+AlterTrafficRule ::=
+  'ALTER' 'TRAFFIC' 'RULE'  '(' 'LABELS' '(' lableName ')' ',' trafficAlgorithmDefination ',' loadBalancerDefination ')'
+
+lableName ::=
+  identifier
+
+trafficAlgorithmDefination ::=
+  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' = trafficAlgorithmTypeName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+
+loadBalancerDefination ::=
+  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' = loadBalancerName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+
+trafficAlgorithmTypeName ::=
+  string
+
+loadBalancerTypeName ::=
+  string
+
+key ::= 
+  string
+
+value ::=
+  string
+```
+
+### Supplement
+
+- `TRAFFIC_ALGORITHM` support `SQL_MATCH` and `SQL_HINT` two types;
+
+- `LOAD_BALANCER` support `RANDOM` and `ROUND_ROBIN` two types.
+
+### Example
+
+- Alter dual routing rule
+
+```sql
+ TRAFFIC RULE sql_match_traffic ( 
+  LABELS (OLTP),
+  TRAFFIC_ALGORITHM(TYPE(NAME="SQL_MATCH",PROPERTIES("sql" = "SELECT * FROM t_order WHERE order_id = 1; UPDATE t_order SET order_id = 5;"))),
+  LOAD_BALANCER(TYPE(NAME="RANDOM")));
+```
+
+### Reserved word
+
+`ALTER`, `TRAFFIC`, `RULE`, `LABELS`, `TYPE`, `NAME`, `PROPERTIES`, `TRAFFIC_ALGORITHM`, `LOAD_BALANCER`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/global-rule/create-traffic-rule.cn.md b/docs/document/content/reference/distsql/syntax/ral/global-rule/create-traffic-rule.cn.md
new file mode 100644
index 00000000000..c3796255853
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/global-rule/create-traffic-rule.cn.md
@@ -0,0 +1,61 @@
++++
+title = "CREATE TRAFFIC RULE"
+weight = 7
++++
+
+## 描述
+
+`CREATE TRAFFIC RULE` 语法用于创建双路由规则
+
+### 语法定义
+
+```sql
+CreateTrafficRule ::=
+  'CREATE' 'TRAFFIC' 'RULE'  '(' 'LABELS' '(' lableName ')' ',' trafficAlgorithmDefination ',' loadBalancerDefination ')'
+
+lableName ::=
+  identifier
+
+trafficAlgorithmDefination ::=
+  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' = trafficAlgorithmTypeName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+
+loadBalancerDefination ::=
+  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' = loadBalancerName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+
+trafficAlgorithmTypeName ::=
+  string
+
+loadBalancerTypeName ::=
+  string
+
+key ::= 
+  string
+
+value ::=
+  string
+```
+
+### 补充说明
+
+- `TRAFFIC_ALGORITHM` 支持 `SQL_MATCH` 与 `SQL_HINT` 两种类型
+
+- `LOAD_BALANCER` 支持 `RANDOM` 与 `ROUND_ROBIN` 两种类型
+
+### 示例
+
+- 创建双路由规则
+
+```sql
+CREATE TRAFFIC RULE sql_match_traffic ( 
+  LABELS (OLTP),
+  TRAFFIC_ALGORITHM(TYPE(NAME="SQL_MATCH",PROPERTIES("sql" = "SELECT * FROM t_order WHERE order_id = 1; UPDATE t_order SET order_id = 5;"))),
+  LOAD_BALANCER(TYPE(NAME="RANDOM")));
+```
+
+### 保留字
+
+`CREATE`、`TRAFFIC`、`RULE`、`LABELS`、`TYPE`、`NAME`、`PROPERTIES`、`TRAFFIC_ALGORITHM`、`LOAD_BALANCER`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/global-rule/create-traffic-rule.en.md b/docs/document/content/reference/distsql/syntax/ral/global-rule/create-traffic-rule.en.md
new file mode 100644
index 00000000000..5edfdc18b73
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/global-rule/create-traffic-rule.en.md
@@ -0,0 +1,61 @@
++++
+title = "CREATE TRAFFIC RULE"
+weight = 7
++++
+
+### Description
+
+The `CREATE TRAFFIC RULE` syntax is used to create dual routing rule.
+
+### Syntax
+
+```sql
+CreateTrafficRule ::=
+  'CREATE' 'TRAFFIC' 'RULE'  '(' 'LABELS' '(' lableName ')' ',' trafficAlgorithmDefination ',' loadBalancerDefination ')'
+
+lableName ::=
+  identifier
+
+trafficAlgorithmDefination ::=
+  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' = trafficAlgorithmTypeName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+
+loadBalancerDefination ::=
+  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' = loadBalancerName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+
+trafficAlgorithmTypeName ::=
+  string
+
+loadBalancerTypeName ::=
+  string
+
+key ::= 
+  string
+
+value ::=
+  string
+```
+
+### Supplement
+
+- `TRAFFIC_ALGORITHM` support `SQL_MATCH` and `SQL_HINT` two types;
+
+- `LOAD_BALANCER` support `RANDOM` and `ROUND_ROBIN` two types.
+
+### Example
+
+- Create dual routing rule
+
+```sql
+CREATE TRAFFIC RULE sql_match_traffic ( 
+  LABELS (OLTP),
+  TRAFFIC_ALGORITHM(TYPE(NAME="SQL_MATCH",PROPERTIES("sql" = "SELECT * FROM t_order WHERE order_id = 1; UPDATE t_order SET order_id = 5;"))),
+  LOAD_BALANCER(TYPE(NAME="RANDOM")));
+```
+
+### Reserved word
+
+`CREATE`, `TRAFFIC`, `RULE`, `LABELS`, `TYPE`, `NAME`, `PROPERTIES`, `TRAFFIC_ALGORITHM`, `LOAD_BALANCER`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/global-rule/drop-traffic-rule.cn.md b/docs/document/content/reference/distsql/syntax/ral/global-rule/drop-traffic-rule.cn.md
new file mode 100644
index 00000000000..8b5b4c5ee5e
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/global-rule/drop-traffic-rule.cn.md
@@ -0,0 +1,39 @@
++++
+title = "DROP TRAFFIC RULE"
+weight = 10
++++
+
+### 描述
+
+`DROP TRAFFIC RULE` 语法用于删除指定的双路由规则
+### 语法
+
+```sql
+DropTrafficRule ::=
+  'DROP' 'TRAFFIC' 'RULE' ruleName (',' ruleName)?
+
+ruleName ::=
+  identifier
+```
+
+### 示例
+
+- 删除指定双路由规则
+
+```sql
+DROP TRAFFIC RULE sql_match_traffic;
+```
+
+- 删除多个双路由规则
+
+```sql
+DROP TRAFFIC RULE sql_match_traffic, sql_hint_traffic;
+```
+
+### 保留字
+
+`DROP`、`TRAFFIC`、`RULE`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/global-rule/drop-traffic-rule.en.md b/docs/document/content/reference/distsql/syntax/ral/global-rule/drop-traffic-rule.en.md
new file mode 100644
index 00000000000..40bf1708d5c
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/global-rule/drop-traffic-rule.en.md
@@ -0,0 +1,39 @@
++++
+title = "DROP TRAFFIC RULE"
+weight = 10
++++
+
+### Description
+
+The `DROP TRAFFIC RULE` syntax is used to drop specified dual routing rule.
+
+### Syntax
+
+```sql
+DropTrafficRule ::=
+  'DROP' 'TRAFFIC' 'RULE' ruleName (',' ruleName)?
+
+ruleName ::=
+  identifier
+```
+
+### Example
+
+- Drop specified traffic rule
+
+```sql
+DROP TRAFFIC RULE sql_match_traffic;
+```
+
+- Drop mutiple traffic rules
+```sql
+DROP TRAFFIC RULE sql_match_traffic, sql_hint_traffic;
+```
+
+### Reserved word
+
+`DROP`, `TRAFFIC`, `RULE`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/global-rule/show-traffic-rule.cn.md b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-traffic-rule.cn.md
new file mode 100644
index 00000000000..e09b24321b3
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-traffic-rule.cn.md
@@ -0,0 +1,73 @@
++++
+title = "SHOW TRAFFIC RULE"
+weight = 9
++++
+
+### 描述
+
+`SHOW TRAFFIC RULE` 语法用于查询指定的双路由规则
+### 语法
+
+```sql
+ShowTrafficRule ::=
+  'SHOW' 'TRAFFIC' ('RULES' | 'RULE' ruleName)?
+
+ruleName ::=
+  identifier
+```
+### 补充说明
+
+- 未指定 `ruleName` 时,默认查询所有双路由规则
+
+### 返回值说明
+
+| 列                   | 说明         |
+|---------------------|--------------|
+| name                | 双路由规则名称 |
+| labels              | 计算节点标签   |
+| algorithm_type      | 双路由算法类型 |
+| algorithm_props     | 双路由算法参数 |
+| load_balancer_type  | 负载均衡器类型 |
+| load_balancer_props | 负载均衡器参数 |
+
+### 示例
+
+- 查询指定双路由规则
+
+```sql
+SHOW TRAFFIC RULE sql_match_traffic;
+```
+
+```sql
+mysql> SHOW TRAFFIC RULE sql_match_traffic;
++-------------------+--------+----------------+--------------------------------------------------------------------------------+--------------------+---------------------+
+| name              | labels | algorithm_type | algorithm_props                                                                | load_balancer_type | load_balancer_props |
++-------------------+--------+----------------+--------------------------------------------------------------------------------+--------------------+---------------------+
+| sql_match_traffic | OLTP   | SQL_MATCH      | sql=SELECT * FROM t_order WHERE order_id = 1; UPDATE t_order SET order_id = 5; | RANDOM             |                     |
++-------------------+--------+----------------+--------------------------------------------------------------------------------+--------------------+---------------------+
+1 row in set (0.00 sec)
+```
+
+- 查询所有双路由规则
+
+```sql
+SHOW TRAFFIC RULES;
+```
+
+```sql
+mysql> SHOW TRAFFIC RULES;
++-------------------+--------+----------------+--------------------------------------------------------------------------------+--------------------+---------------------+
+| name              | labels | algorithm_type | algorithm_props                                                                | load_balancer_type | load_balancer_props |
++-------------------+--------+----------------+--------------------------------------------------------------------------------+--------------------+---------------------+
+| sql_match_traffic | OLTP   | SQL_MATCH      | sql=SELECT * FROM t_order WHERE order_id = 1; UPDATE t_order SET order_id = 5; | RANDOM             |                     |
++-------------------+--------+----------------+--------------------------------------------------------------------------------+--------------------+---------------------+
+1 row in set (0.04 sec)
+```
+
+### 保留字
+
+`SHOW`、`TRAFFIC`、`RULE`、`RULES`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/global-rule/show-traffic-rule.en.md b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-traffic-rule.en.md
new file mode 100644
index 00000000000..eef87d0b725
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-traffic-rule.en.md
@@ -0,0 +1,75 @@
++++
+title = "SHOW TRAFFIC RULE"
+weight = 9
++++
+
+### Description
+
+The `SHOW TRAFFIC RULE` syntax is used to query specified dual routing rule.
+
+### Syntax
+
+```sql
+ShowTrafficRule ::=
+  'SHOW' 'TRAFFIC' ('RULES' | 'RULE' ruleName)?
+
+ruleName ::=
+  identifier
+```
+
+### Supplement
+
+- When `ruleName` not specified, the default is show all traffic rules
+
+### Return Value Description
+
+| Colume              | Description                  |
+|---------------------|------------------------------|
+| name                | traffic rule name            |
+| labels              | compute node labels          |
+| algorithm_type      | traffic algorithm type       |
+| algorithm_props     | traffic algorithn properties |
+| load_balancer_type  | load balancer type           |
+| load_balancer_props | load balancer properties     |
+
+### Example
+
+- Query specified traffic rule
+
+```sql
+SHOW TRAFFIC RULE sql_match_traffic;
+```
+
+```sql
+mysql> SHOW TRAFFIC RULE sql_match_traffic;
++-------------------+--------+----------------+--------------------------------------------------------------------------------+--------------------+---------------------+
+| name              | labels | algorithm_type | algorithm_props                                                                | load_balancer_type | load_balancer_props |
++-------------------+--------+----------------+--------------------------------------------------------------------------------+--------------------+---------------------+
+| sql_match_traffic | OLTP   | SQL_MATCH      | sql=SELECT * FROM t_order WHERE order_id = 1; UPDATE t_order SET order_id = 5; | RANDOM             |                     |
++-------------------+--------+----------------+--------------------------------------------------------------------------------+--------------------+---------------------+
+1 row in set (0.00 sec)
+```
+
+- Query all traffic rules
+
+```sql
+SHOW TRAFFIC RULES;
+```
+
+```sql
+mysql> SHOW TRAFFIC RULES;
++-------------------+--------+----------------+--------------------------------------------------------------------------------+--------------------+---------------------+
+| name              | labels | algorithm_type | algorithm_props                                                                | load_balancer_type | load_balancer_props |
++-------------------+--------+----------------+--------------------------------------------------------------------------------+--------------------+---------------------+
+| sql_match_traffic | OLTP   | SQL_MATCH      | sql=SELECT * FROM t_order WHERE order_id = 1; UPDATE t_order SET order_id = 5; | RANDOM             |                     |
++-------------------+--------+----------------+--------------------------------------------------------------------------------+--------------------+---------------------+
+1 row in set (0.04 sec)
+```
+
+### Reserved word
+
+`SHOW`, `TRAFFIC`, `RULE`, `RULES`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/reserved-word.cn.md b/docs/document/content/reference/distsql/syntax/reserved-word.cn.md
index 34d603ce50e..abc78945638 100644
--- a/docs/document/content/reference/distsql/syntax/reserved-word.cn.md
+++ b/docs/document/content/reference/distsql/syntax/reserved-word.cn.md
@@ -1,6 +1,6 @@
 +++
 title = "保留字"
-weight = 3
+weight = 5
 +++
 
 ## RDL
diff --git a/docs/document/content/reference/distsql/syntax/reserved-word.en.md b/docs/document/content/reference/distsql/syntax/reserved-word.en.md
index e7802a41a64..7d13a0c8633 100644
--- a/docs/document/content/reference/distsql/syntax/reserved-word.en.md
+++ b/docs/document/content/reference/distsql/syntax/reserved-word.en.md
@@ -1,6 +1,6 @@
 +++
 title = "Reserved word"
-weight = 3
+weight = 5
 +++
 
 ## RDL