This is an automated email from the ASF dual-hosted git repository.
jianglongtao 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 422fa7537a2 Update DistSql documents (#21910)
422fa7537a2 is described below
commit 422fa7537a25af4ecd304f568f2676661923283e
Author: Zichao <[email protected]>
AuthorDate: Thu Nov 3 03:36:02 2022 +1300
Update DistSql documents (#21910)
* Update DistSql documents
* Update DistSql documents
* Update DistSql documents
---
.../syntax/ral/circuit-breaker/_index.cn.md | 8 ++
.../syntax/ral/circuit-breaker/_index.en.md | 8 ++
...r-readwrite-splitting-rule-enable-disable.cn.md | 62 +++++++++++
...r-readwrite-splitting-rule-enable-disable.en.md | 62 +++++++++++
.../enable-disable-compute-node.cn.md | 46 ++++++++
.../enable-disable-compute-node.en.md | 45 ++++++++
.../ral/circuit-breaker/show-compute-nodes.cn.md | 53 +++++++++
.../ral/circuit-breaker/show-compute-nodes.en.md | 52 +++++++++
...show-status-from-readwrite-splitting-rule.cn.md | 119 +++++++++++++++++++++
...show-status-from-readwrite-splitting-rule.en.md | 119 +++++++++++++++++++++
.../distsql/syntax/ral/global-rule/_index.cn.md | 8 ++
.../distsql/syntax/ral/global-rule/_index.en.md | 8 ++
.../ral/global-rule/alter-sql-parser-rule.cn.md | 60 +++++++++++
.../ral/global-rule/alter-sql-parser-rule.en.md | 60 +++++++++++
.../ral/global-rule/alter-transaction-rule.cn.md | 51 +++++++++
.../ral/global-rule/alter-transaction-rule.en.md | 51 +++++++++
.../ral/global-rule/show-authority-rule.cn.md | 48 +++++++++
.../ral/global-rule/show-authority-rule.en.md | 49 +++++++++
.../ral/global-rule/show-sql-parser-rule.cn.md | 49 +++++++++
.../ral/global-rule/show-sql-parser-rule.en.md | 49 +++++++++
.../ral/global-rule/show-transaction-rule.cn.md | 48 +++++++++
.../ral/global-rule/show-transaction-rule.en.md | 49 +++++++++
.../syntax/ral/migration/show-migration-rule.cn.md | 2 +-
23 files changed, 1105 insertions(+), 1 deletion(-)
diff --git
a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/_index.cn.md
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/_index.cn.md
new file mode 100644
index 00000000000..04197e557db
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/_index.cn.md
@@ -0,0 +1,8 @@
++++
+title = "熔断"
+weight = 1
+chapter = true
+
++++
+
+本章节将对熔断功能的语法进行详细说明。
diff --git
a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/_index.en.md
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/_index.en.md
new file mode 100644
index 00000000000..984fd6e707a
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/_index.en.md
@@ -0,0 +1,8 @@
++++
+title = "CIRCUIT BREAKER"
+weight = 1
+chapter = true
+
++++
+
+This chapter describes the syntax of Circuit Breaker.
diff --git
a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.cn.md
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.cn.md
new file mode 100644
index 00000000000..60356e4eedf
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.cn.md
@@ -0,0 +1,62 @@
++++
+title = "ALTER READWRITE_SPLITTING RULE ENABLE/DISABLE"
+weight = 2
++++
+
+## 描述
+
+`ALTER READWRITE_SPLITTING RULE ENABLE/DISABLE`
语法用于启用/禁用指定逻辑库中指定读写分离规则中的指定读数据存储单元
+
+### 语法定义
+
+```sql
+AlterReadwriteSplittingRule ::=
+ 'ALTER' 'READWRITE_SPLITTING' 'RULE' groupName ( 'ENABLE' | 'DISABLE' )
storageUnitName 'FROM' databaseName
+
+groupName ::=
+ identifier
+
+storageUnitName ::=
+ identifier
+
+databaseName ::=
+ identifier
+```
+
+### 补充说明
+
+- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。 如果也未使用 `DATABASE` 则会提示 `No
database selected`。
+
+### 示例
+
+- 禁用指定逻辑库中指定读写分离规则中的指定读数据存储单元
+
+```sql
+ALTER READWRITE_SPLITTING RULE ms_group_0 DISABLE read_su_0 FROM test1;
+```
+
+- 启用指定逻辑库中指定读写分离规则中的指定读数据存储单元
+
+```sql
+ALTER READWRITE_SPLITTING RULE ms_group_0 ENABLE read_su_0 FROM test1;
+```
+
+- 禁用当前逻辑库中指定读写分离规则中的指定读数据存储单元
+
+```sql
+ALTER READWRITE_SPLITTING RULE ms_group_0 DISABLE read_su_0;
+```
+
+- 启用当前逻辑库中指定读写分离规则中的指定读数据存储单元
+
+```sql
+ALTER READWRITE_SPLITTING RULE ms_group_1 ENABLE read_su_0;
+```
+
+### 保留字
+
+`ALTER`、`READWRITE_SPLITTING`、`RULE`、`ENABLE`、`DISABLE`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
diff --git
a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.en.md
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.en.md
new file mode 100644
index 00000000000..1dc7885adfd
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.en.md
@@ -0,0 +1,62 @@
++++
+title = "ALTER READWRITE_SPLITTING RULE ENABLE/DISABLE"
+weight = 2
++++
+
+## Description
+
+The `ALTER READWRITE_SPLITTING RULE ENABLE/DISABLE` syntax is used
enable/disable a specified read source for specified readwrite splitting rule.
+
+### Syntax
+
+```sql
+AlterReadwriteSplittingRule ::=
+ 'ALTER' 'READWRITE_SPLITTING' 'RULE' groupName ( 'ENABLE' | 'DISABLE' )
storageUnitName 'FROM' databaseName
+
+groupName ::=
+ identifier
+
+storageUnitName ::=
+ identifier
+
+databaseName ::=
+ identifier
+```
+
+### Supplement
+
+- When `databaseName` is not specified, the default is the currently used
`DATABASE`. If `DATABASE` is not used, `No database selected` will be prompted.
+
+### Example
+
+- Disable a specified read source for specified readwrite splitting rule in
specified database
+
+```sql
+ALTER READWRITE_SPLITTING RULE ms_group_0 DISABLE read_su_0 FROM test1;
+```
+
+- Enable a specified read source for specified readwrite splitting rule in
specified database
+
+```sql
+ALTER READWRITE_SPLITTING RULE ms_group_0 ENABLE read_su_0 FROM test1;
+```
+
+- Disable a specified read source for specified readwrite splitting rule in
current database
+
+```sql
+ALTER READWRITE_SPLITTING RULE ms_group_0 DISABLE read_su_0;
+```
+
+- Enable a specified read source for specified readwrite splitting rule in
current database
+
+```sql
+ALTER READWRITE_SPLITTING RULE ms_group_1 ENABLE read_su_0;
+```
+
+### Reserved word
+
+`ALTER`, `READWRITE_SPLITTING`, `RULE`, `ENABLE`, `DISABLE`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
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
new file mode 100644
index 00000000000..d7cb60f6fb6
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/enable-disable-compute-node.cn.md
@@ -0,0 +1,46 @@
++++
+title = "ENABLE/DISABLE COMPUTE NODE"
+weight = 4
++++
+
+## 描述
+
+`ENABLE/DISABLE COMPUTE NODE` 语法用于启用/禁用指定 proy 实例
+
+### 语法定义
+
+```sql
+EnableDisableComputeNode ::=
+ ( 'ENABLE' | 'DISABLE' ) 'COMPUTE' 'NODE' instanceId
+
+instanceId ::=
+ string
+```
+
+### 补充说明
+
+- `instanceId` 需要通过 `SHOW COMPUTE NODES` 语法查询得到
+
+- 不可禁用当前正在使用的 proxy 实例
+
+### 示例
+
+- 禁用指定 proxy 实例
+
+```sql
+DISABLE COMPUTE NODE '734bb086-b15d-4af0-be87-2372d8b6a0cd';
+```
+
+- 启用指定 proxy 实例
+
+```sql
+ENABLE COMPUTE NODE '734bb086-b15d-4af0-be87-2372d8b6a0cd';
+```
+
+### 保留字
+
+`ENABLE`、`DISABLE`、`COMPUTE`、`NODE`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
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
new file mode 100644
index 00000000000..6494cadc2d7
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/enable-disable-compute-node.en.md
@@ -0,0 +1,45 @@
++++
+title = "ENABLE/DISABLE COMPUTE NODE"
+weight = 4
++++
+
+## Description
+
+The `ENABLE/DISABLE COMPUTE NODE` syntax is used enable/disable a specified
proxy instance
+
+### Syntax
+
+```sql
+EnableDisableComputeNode ::=
+ ( 'ENABLE' | 'DISABLE' ) 'COMPUTE' 'NODE' instanceId
+
+instanceId ::=
+ string
+```
+
+### Supplement
+
+- `instanceId` needs to be obtained through `SHOW COMPUTE NODES` syntax query
+
+- The currently in-use proxy instance cannot be disabled
+
+### Example
+
+- Disable a specified proxy instance
+```sql
+DISABLE COMPUTE NODE '734bb086-b15d-4af0-be87-2372d8b6a0cd';
+```
+
+- Enable a specified proxy instance
+
+```sql
+ENABLE COMPUTE NODE '734bb086-b15d-4af0-be87-2372d8b6a0cd';
+```
+
+### Reserved word
+
+`ENABLE`, `DISABLE`, `COMPUTE`, `NODE`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git
a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes.cn.md
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes.cn.md
new file mode 100644
index 00000000000..4af1b120fd6
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes.cn.md
@@ -0,0 +1,53 @@
++++
+title = "SHOW COMPUTE NODES"
+weight = 3
++++
+
+### 描述
+
+`SHOW COMPUTE NODES` 语法用于查询 proxy 实例信息
+
+### 语法
+
+```sql
+ShowComputeNodes ::=
+ 'SHOW' 'COMPUTE' 'NODES'
+```
+
+### 返回值说明
+
+| 列 | 说明 |
+|----------------|-------------------|
+| instance_id | proxy 实例编号 |
+| host | 主机地址 |
+| port | 端口号 |
+| status | proxy 实例状态 |
+| mode_type | proxy 实例模式 |
+| worker_id | worker id |
+| labels | 标签 |
+
+### 示例
+
+- 查询 proxy 实例信息
+
+```sql
+SHOW COMPUTE NODES;
+```
+
+```sql
+mysql> SHOW COMPUTE NODES;
++--------------------------------------+---------------+------+--------+-----------+-----------+--------+
+| instance_id | host | port | status |
mode_type | worker_id | labels |
++--------------------------------------+---------------+------+--------+-----------+-----------+--------+
+| 734bb036-b15d-4af0-be87-2372d8b6a0cd | 192.168.5.163 | 3307 | OK |
Cluster | -1 | |
++--------------------------------------+---------------+------+--------+-----------+-----------+--------+
+1 row in set (0.01 sec)
+```
+
+### 保留字
+
+`SHOW`、`COMPUTE`、`NODES`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git
a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes.en.md
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes.en.md
new file mode 100644
index 00000000000..98cb98c7abb
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/show-compute-nodes.en.md
@@ -0,0 +1,52 @@
++++
+title = "SHOW COMPUTE NODES"
+weight = 3
++++
+
+### Description
+
+The `SHOW COMPUTE NODES` syntax is used to query proxy instance information.
+### Syntax
+
+```sql
+ShowComputeNodes ::=
+ 'SHOW' 'COMPUTE' 'NODES'
+```
+
+### Return Value Description
+
+| Columns | Description |
+|----------------|-----------------------|
+| instance_id | proxy instance id |
+| host | host address |
+| port | port number |
+| status | proxy instance status |
+| mode_type | proxy instance mode |
+| worker_id | worker id |
+| labels | labels |
+
+### Example
+
+- Query proxy instance information
+
+```sql
+SHOW COMPUTE NODES;
+```
+
+```sql
+mysql> SHOW COMPUTE NODES;
++--------------------------------------+---------------+------+--------+-----------+-----------+--------+
+| instance_id | host | port | status |
mode_type | worker_id | labels |
++--------------------------------------+---------------+------+--------+-----------+-----------+--------+
+| 734bb036-b15d-4af0-be87-2372d8b6a0cd | 192.168.5.163 | 3307 | OK |
Cluster | -1 | |
++--------------------------------------+---------------+------+--------+-----------+-----------+--------+
+1 row in set (0.01 sec)
+```
+
+### Reserved word
+
+`SHOW`, `COMPUTE`, `NODES`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git
a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/show-status-from-readwrite-splitting-rule.cn.md
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/show-status-from-readwrite-splitting-rule.cn.md
new file mode 100644
index 00000000000..bc10053823b
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/show-status-from-readwrite-splitting-rule.cn.md
@@ -0,0 +1,119 @@
++++
+title = "SHOW STATUS FROM READWRITE_SPLITTING RULE"
+weight = 3
++++
+
+### 描述
+
+`SHOW STATUS FROM READWRITE_SPLITTING RULE` 语法用于查询指定逻辑库中指定读写分离规则中读写分离存储单元状态
+
+### 语法
+
+```sql
+ShowStatusFromReadwriteSplittingRule ::=
+ 'SHOW' 'STATUS' 'FROM' 'READWRITE_SPLITTING' ('RULES' | 'RULE' groupName)
('FROM' databaseName)?
+
+groupName ::=
+ identifier
+
+databaseName ::=
+ identifier
+```
+
+### 补充说明
+
+- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。 如果也未使用 `DATABASE` 则会提示 `No
database selected`。
+
+### 返回值说明
+
+| 列 | 说明 |
+|----------------|---------------|
+| resource | 存储单元名称 |
+| status | 存储单元状态 |
+| delay_time(ms) | 延迟时间 |
+
+### 示例
+
+- 查询指定逻辑库中指定读写分离规则中读写分离存储单元状态
+
+```sql
+SHOW STATUS FROM READWRITE_SPLITTING RULE ms_group_0 FROM test1;
+```
+
+```sql
+mysql> SHOW STATUS FROM READWRITE_SPLITTING RULE ms_group_0 FROM test1;
++----------+---------+----------------+
+| resource | status | delay_time(ms) |
++----------+---------+----------------+
+| su_0 | enabled | 0 |
+| su_1 | enabled | 0 |
+| ds_2 | enabled | 0 |
+| ds_1 | enabled | 0 |
++----------+---------+----------------+
+4 rows in set (0.01 sec)
+```
+
+- 查询指定逻辑库中所有读写分离存储单元状态
+
+```sql
+SHOW STATUS FROM READWRITE_SPLITTING RULES FROM test1;
+```
+
+```sql
+mysql> SHOW STATUS FROM READWRITE_SPLITTING RULES FROM test1;
++----------+---------+----------------+
+| resource | status | delay_time(ms) |
++----------+---------+----------------+
+| su_0 | enabled | 0 |
+| su_1 | enabled | 0 |
+| ds_2 | enabled | 0 |
+| ds_1 | enabled | 0 |
++----------+---------+----------------+
+4 rows in set (0.00 sec)
+```
+
+- 查询当前逻辑库中指定读写分离规则中读写分离存储单元状态
+
+```sql
+SHOW STATUS FROM READWRITE_SPLITTING RULE ms_group_0;
+```
+
+```sql
+mysql> SHOW STATUS FROM READWRITE_SPLITTING RULE ms_group_0;
++----------+---------+----------------+
+| resource | status | delay_time(ms) |
++----------+---------+----------------+
+| su_0 | enabled | 0 |
+| su_1 | enabled | 0 |
+| ds_2 | enabled | 0 |
+| ds_1 | enabled | 0 |
++----------+---------+----------------+
+4 rows in set (0.01 sec)
+```
+
+- 查询当前逻辑库中所有读写分离存储单元状态
+
+```sql
+mysql> SHOW STATUS FROM READWRITE_SPLITTING RULES;
+```
+
+```sql
+mysql> SHOW STATUS FROM READWRITE_SPLITTING RULES;
++----------+---------+----------------+
+| resource | status | delay_time(ms) |
++----------+---------+----------------+
+| su_0 | enabled | 0 |
+| su_1 | enabled | 0 |
+| ds_2 | enabled | 0 |
+| ds_1 | enabled | 0 |
++----------+---------+----------------+
+4 rows in set (0.01 sec)
+```
+
+### 保留字
+
+`SHOW`、`STATUS`、`FROM`、`READWRITE_SPLITTING`、`RULE`、`RULES`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git
a/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/show-status-from-readwrite-splitting-rule.en.md
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/show-status-from-readwrite-splitting-rule.en.md
new file mode 100644
index 00000000000..c78ff256932
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/circuit-breaker/show-status-from-readwrite-splitting-rule.en.md
@@ -0,0 +1,119 @@
++++
+title = "SHOW STATUS FROM READWRITE_SPLITTING RULE"
+weight = 3
++++
+
+### Description
+
+The `SHOW STATUS FROM READWRITE_SPLITTING RULE` syntax is used to query
readwrite splitting storage unit status for specified readwrite splitting rule
in specified database.
+
+### Syntax
+
+```sql
+ShowStatusFromReadwriteSplittingRule ::=
+ 'SHOW' 'STATUS' 'FROM' 'READWRITE_SPLITTING' ('RULES' | 'RULE' groupName)
('FROM' databaseName)?
+
+groupName ::=
+ identifier
+
+databaseName ::=
+ identifier
+```
+
+### Supplement
+
+- When `databaseName` is not specified, the default is the currently used
`DATABASE`. If `DATABASE` is not used, `No database selected` will be prompted.
+
+### Return Value Description
+
+| Columns | Description |
+|----------------|---------------------|
+| resource | storage unit name |
+| status | storage unit status |
+| delay_time(ms) | delay time |
+
+### Example
+
+- Query readwrite splitting storage unit status for specified readwrite
splitting rule in specified database.
+
+```sql
+SHOW STATUS FROM READWRITE_SPLITTING RULE ms_group_0 FROM test1;
+```
+
+```sql
+mysql> SHOW STATUS FROM READWRITE_SPLITTING RULE ms_group_0 FROM test1;
++----------+---------+----------------+
+| resource | status | delay_time(ms) |
++----------+---------+----------------+
+| su_0 | enabled | 0 |
+| su_1 | enabled | 0 |
+| ds_2 | enabled | 0 |
+| ds_1 | enabled | 0 |
++----------+---------+----------------+
+4 rows in set (0.01 sec)
+```
+
+- Query all readwrite splitting storage unit from specified database
+
+```sql
+SHOW STATUS FROM READWRITE_SPLITTING RULES FROM test1;
+```
+
+```sql
+mysql> SHOW STATUS FROM READWRITE_SPLITTING RULES FROM test1;
++----------+---------+----------------+
+| resource | status | delay_time(ms) |
++----------+---------+----------------+
+| su_0 | enabled | 0 |
+| su_1 | enabled | 0 |
+| ds_2 | enabled | 0 |
+| ds_1 | enabled | 0 |
++----------+---------+----------------+
+4 rows in set (0.00 sec)
+```
+
+- Query readwrite splitting storage unit status for specified readwrite
splitting rule in current database
+
+```sql
+SHOW STATUS FROM READWRITE_SPLITTING RULE ms_group_0;
+```
+
+```sql
+mysql> SHOW STATUS FROM READWRITE_SPLITTING RULE ms_group_0;
++----------+---------+----------------+
+| resource | status | delay_time(ms) |
++----------+---------+----------------+
+| su_0 | enabled | 0 |
+| su_1 | enabled | 0 |
+| ds_2 | enabled | 0 |
+| ds_1 | enabled | 0 |
++----------+---------+----------------+
+4 rows in set (0.01 sec)
+```
+
+- Query all readwrite splitting storage unit from current database
+
+```sql
+mysql> SHOW STATUS FROM READWRITE_SPLITTING RULES;
+```
+
+```sql
+mysql> SHOW STATUS FROM READWRITE_SPLITTING RULES;
++----------+---------+----------------+
+| resource | status | delay_time(ms) |
++----------+---------+----------------+
+| su_0 | enabled | 0 |
+| su_1 | enabled | 0 |
+| ds_2 | enabled | 0 |
+| ds_1 | enabled | 0 |
++----------+---------+----------------+
+4 rows in set (0.01 sec)
+```
+
+### Reserved word
+
+`SHOW`, `STATUS`, `FROM`, `READWRITE_SPLITTING`, `RULE`, `RULES`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git
a/docs/document/content/reference/distsql/syntax/ral/global-rule/_index.cn.md
b/docs/document/content/reference/distsql/syntax/ral/global-rule/_index.cn.md
new file mode 100644
index 00000000000..0252343e96f
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/global-rule/_index.cn.md
@@ -0,0 +1,8 @@
++++
+title = "全局规则"
+weight = 1
+chapter = true
+
++++
+
+本章节将对全局规则的语法进行详细说明。
diff --git
a/docs/document/content/reference/distsql/syntax/ral/global-rule/_index.en.md
b/docs/document/content/reference/distsql/syntax/ral/global-rule/_index.en.md
new file mode 100644
index 00000000000..c7afcdc13ea
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/global-rule/_index.en.md
@@ -0,0 +1,8 @@
++++
+title = "GLOBAL RULE"
+weight = 1
+chapter = true
+
++++
+
+This chapter describes the syntax of Global Rule.
diff --git
a/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-sql-parser-rule.cn.md
b/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-sql-parser-rule.cn.md
new file mode 100644
index 00000000000..3a244f502c1
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-sql-parser-rule.cn.md
@@ -0,0 +1,60 @@
++++
+title = "ALTER SQL_PARSER RULE"
+weight = 6
++++
+
+### 描述
+
+`ALTER SQL_PARSER RULE` 语法用于修改解析引擎规则配置
+
+### 语法
+
+```sql
+AlterSqlParserRule ::=
+ 'ALTER' 'SQL_PARSER' 'RULE' 'SQL_COMMENT_PARSE_ENABLE' '='
sqlCommentParseEnable ',' 'PARSE_TREE_CACHE' parseTreeCacheDefination ','
'SQL_STATEMENT_CACHE' sqlStatementCacheDefination
+
+sqlCommentParseEnable ::=
+ boolean
+
+parseTreeCacheDefination ::=
+ '(' 'INITIAL_CAPACITY' '=' initialCapacity ',' 'MAXIMUM_SIZE' '='
maximumSize ',' 'CONCURRENCY_LEVEL' '=' concurrencyLevel ')'
+
+sqlStatementCacheDefination ::=
+ '(' 'INITIAL_CAPACITY' '=' initialCapacity ',' 'MAXIMUM_SIZE' '='
maximumSize ',' 'CONCURRENCY_LEVEL' '=' concurrencyLevel ')'
+
+initialCapacity ::=
+ int
+
+maximumSize ::=
+ int
+
+concurrencyLevel ::=
+ int
+```
+
+### 补充说明
+
+- `SQL_COMMENT_PARSE_ENABLE`：是否解析 SQL 注释
+
+- `PARSE_TREE_CACHE`：语法树本地缓存配置
+
+- `SQL_STATEMENT_CACHE`：SQL 语句本地缓存配置项
+
+### 示例
+
+- 修改解析引擎规则配置
+
+```sql
+ALTER SQL_PARSER RULE
+ SQL_COMMENT_PARSE_ENABLE=false,
+ PARSE_TREE_CACHE(INITIAL_CAPACITY=10, MAXIMUM_SIZE=11, CONCURRENCY_LEVEL=1),
+ SQL_STATEMENT_CACHE(INITIAL_CAPACITY=11, MAXIMUM_SIZE=11,
CONCURRENCY_LEVEL=100)；
+```
+
+### 保留字
+
+`ALTER`、`SQL_PARSER`、`RULE`、`SQL_COMMENT_PARSE_ENABLE`、`PARSE_TREE_CACHE`、`INITIAL_CAPACITY`、`MAXIMUM_SIZE`、`CONCURRENCY_LEVEL`、`SQL_STATEMENT_CACHE`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git
a/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-sql-parser-rule.en.md
b/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-sql-parser-rule.en.md
new file mode 100644
index 00000000000..c6d88071ef8
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-sql-parser-rule.en.md
@@ -0,0 +1,60 @@
++++
+title = "ALTER SQL_PARSER RULE"
+weight = 6
++++
+
+### Description
+
+The `ALTER SQL_PARSER RULE` syntax is used to alter sql parser rule
configuration.
+
+### Syntax
+
+```sql
+AlterSqlParserRule ::=
+ 'ALTER' 'SQL_PARSER' 'RULE' 'SQL_COMMENT_PARSE_ENABLE' '='
sqlCommentParseEnable ',' 'PARSE_TREE_CACHE' parseTreeCacheDefination ','
'SQL_STATEMENT_CACHE' sqlStatementCacheDefination
+
+sqlCommentParseEnable ::=
+ boolean
+
+parseTreeCacheDefination ::=
+ '(' 'INITIAL_CAPACITY' '=' initialCapacity ',' 'MAXIMUM_SIZE' '='
maximumSize ',' 'CONCURRENCY_LEVEL' '=' concurrencyLevel ')'
+
+sqlStatementCacheDefination ::=
+ '(' 'INITIAL_CAPACITY' '=' initialCapacity ',' 'MAXIMUM_SIZE' '='
maximumSize ',' 'CONCURRENCY_LEVEL' '=' concurrencyLevel ')'
+
+initialCapacity ::=
+ int
+
+maximumSize ::=
+ int
+
+concurrencyLevel ::=
+ int
+```
+
+### Supplement
+
+- `SQL_COMMENT_PARSE_ENABLE`: whether to parse the SQL comment
+
+- `PARSE_TREE_CACHE`: local cache configuration of syntax tree
+
+- `SQL_STATEMENT_CACHE`: local cache of SQL statement
+
+### Example
+
+- Alter sql parser rule
+
+```sql
+ALTER SQL_PARSER RULE
+ SQL_COMMENT_PARSE_ENABLE=false,
+ PARSE_TREE_CACHE(INITIAL_CAPACITY=10, MAXIMUM_SIZE=11, CONCURRENCY_LEVEL=1),
+ SQL_STATEMENT_CACHE(INITIAL_CAPACITY=11, MAXIMUM_SIZE=11,
CONCURRENCY_LEVEL=100)；
+```
+
+### Reserved word
+
+`ALTER`, `SQL_PARSER`, `RULE`, `SQL_COMMENT_PARSE_ENABLE`, `PARSE_TREE_CACHE`,
`INITIAL_CAPACITY`, `MAXIMUM_SIZE`, `CONCURRENCY_LEVEL`, `SQL_STATEMENT_CACHE`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git
a/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-transaction-rule.cn.md
b/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-transaction-rule.cn.md
new file mode 100644
index 00000000000..240fc4e42a7
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-transaction-rule.cn.md
@@ -0,0 +1,51 @@
++++
+title = "ALTER TRANSACTION RULE"
+weight = 5
++++
+
+### 描述
+
+`ALTER TRANSACTION RULE` 语法用于修改事务规则
+
+### 语法
+
+```sql
+AlterTransactionRule ::=
+ 'ALTER' 'TRANSACTION' 'RULE' '(' 'DEFAULT' '=' defaultTransactionType ','
'TYPE' '(' 'NAME' '=' transactionManager ',' 'PROPERTIES' '(' key '=' value
(',' key '=' value)* ')' ')' ')'
+
+defaultTransactionType ::=
+ string
+
+transactionManager ::=
+ string
+
+key ::=
+ string
+
+value ::=
+ string
+```
+
+### 补充说明
+
+- `defaultTransactionType` 支持 `LOCAL`、`XA`、`BASE`
+
+- `transactionManager` 支持 `Atomikos`、`Narayana` 和 `Bitronix`
+
+### 示例
+
+- 修改事务规则配置
+
+```sql
+ALTER TRANSACTION RULE(
+ DEFAULT="XA”,TYPE(NAME="Narayana”,
PROPERTIES(“databaseName"="jbossts”,“host"="127.0.0.1”))
+);
+```
+
+### 保留字
+
+`ALTER`、`TRANSACTION`、`RULE`、`DEFAULT`、`TYPE`、`NAME`、`PROPERTIES`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git
a/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-transaction-rule.en.md
b/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-transaction-rule.en.md
new file mode 100644
index 00000000000..42d20c56ccc
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/global-rule/alter-transaction-rule.en.md
@@ -0,0 +1,51 @@
++++
+title = "ALTER TRANSACTION RULE"
+weight = 5
++++
+
+### Description
+
+The `ALTER TRANSACTION RULE` syntax is used to alter transaction rule
configuration.
+
+### Syntax
+
+```sql
+AlterTransactionRule ::=
+ 'ALTER' 'TRANSACTION' 'RULE' '(' 'DEFAULT' '=' defaultTransactionType ','
'TYPE' '(' 'NAME' '=' transactionManager ',' 'PROPERTIES' '(' key '=' value
(',' key '=' value)* ')' ')' ')'
+
+defaultTransactionType ::=
+ string
+
+transactionManager ::=
+ string
+
+key ::=
+ string
+
+value ::=
+ string
+```
+
+### Supplement
+
+- `defaultTransactionType` support `LOCAL`, `XA`, `BASE`
+
+- `transactionManager` support `Atomikos`, `Narayana` and `Bitronix`
+
+### Example
+
+- Alter transaction rule
+
+```sql
+ALTER TRANSACTION RULE(
+ DEFAULT="XA”,TYPE(NAME="Narayana”,
PROPERTIES(“databaseName"="jbossts”,“host"="127.0.0.1”))
+);
+```
+
+### Reserved word
+
+`ALTER`, `TRANSACTION`, `RULE`, `DEFAULT`, `TYPE`, `NAME`, `PROPERTIES`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git
a/docs/document/content/reference/distsql/syntax/ral/global-rule/show-authority-rule.cn.md
b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-authority-rule.cn.md
new file mode 100644
index 00000000000..bcb204f3934
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-authority-rule.cn.md
@@ -0,0 +1,48 @@
++++
+title = "SHOW AUTHORITY RULE"
+weight = 2
++++
+
+### 描述
+
+`SHOW AUTHORITY RULE` 语法用于查询权限规则配置
+### 语法
+
+```sql
+ShowAuthorityRule ::=
+ 'SHOW' 'AUTHORITY' 'RULE'
+```
+
+### 返回值说明
+
+| 列 | 说明 |
+|-------------|--------------|
+| users | 用户 |
+| provider | 权限提供者类型 |
+| props | 权限参数 |
+
+### 示例
+
+- 查询权限规则配置
+
+```sql
+SHOW AUTHORITY RULE;
+```
+
+```sql
+mysql> SHOW AUTHORITY RULE;
++--------------------+---------------+-------+
+| users | provider | props |
++--------------------+---------------+-------+
+| root@%; sharding@% | ALL_PERMITTED | |
++--------------------+---------------+-------+
+1 row in set (0.07 sec)
+```
+
+### 保留字
+
+`SHOW`、`AUTHORITY`、`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/show-authority-rule.en.md
b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-authority-rule.en.md
new file mode 100644
index 00000000000..a42f95b0a3e
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-authority-rule.en.md
@@ -0,0 +1,49 @@
++++
+title = "SHOW AUTHORITY RULE"
+weight = 2
++++
+
+### Description
+
+The `SHOW AUTHORITY RULE` syntax is used to query authority rule configuration.
+
+### Syntax
+
+```sql
+ShowAuthorityRule ::=
+ 'SHOW' 'AUTHORITY' 'RULE'
+```
+
+### Return Value Description
+
+| Colume | Description |
+|-------------|-------------------------|
+| users | users |
+| provider | privilege provider type |
+| props | privilege properties |
+
+### Example
+
+- Query authority rule configuration
+
+```sql
+SHOW AUTHORITY RULE;
+```
+
+```sql
+mysql> SHOW AUTHORITY RULE;
++--------------------+---------------+-------+
+| users | provider | props |
++--------------------+---------------+-------+
+| root@%; sharding@% | ALL_PERMITTED | |
++--------------------+---------------+-------+
+1 row in set (0.07 sec)
+```
+
+### Reserved word
+
+`SHOW`, `AUTHORITY`, `RULE`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git
a/docs/document/content/reference/distsql/syntax/ral/global-rule/show-sql-parser-rule.cn.md
b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-sql-parser-rule.cn.md
new file mode 100644
index 00000000000..6d2d5b6181b
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-sql-parser-rule.cn.md
@@ -0,0 +1,49 @@
++++
+title = "SHOW SQL_PARSER RULE"
+weight = 4
++++
+
+### 描述
+
+`SHOW SQL_PARSER RULE` 语法用于查询解析引擎规则配置
+
+### 语法
+
+```sql
+ShowSqlParserRule ::=
+ 'SHOW' 'SQL_PARSER' 'RULE'
+```
+
+### 返回值说明
+
+| 列 | 说明 |
+|---------------------------|-------------|
+| sql_comment_parse_enable | sql注释解析启用状态 |
+| parse_tree_cache | 语法树缓存 |
+| sql_statement_cache | sql语句缓存 |
+
+### 示例
+
+- 查询权限规则配置
+
+```sql
+SHOW SQL_PARSER RULE;
+```
+
+```sql
+mysql> SHOW SQL_PARSER RULE;
++--------------------------+-----------------------------------------+-------------------------------------------+
+| sql_comment_parse_enable | parse_tree_cache |
sql_statement_cache |
++--------------------------+-----------------------------------------+-------------------------------------------+
+| false | initialCapacity: 128, maximumSize: 1024 |
initialCapacity: 2000, maximumSize: 65535 |
++--------------------------+-----------------------------------------+-------------------------------------------+
+1 row in set (0.05 sec)
+```
+
+### 保留字
+
+`SHOW`、`SQL_PARSER`、`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/show-sql-parser-rule.en.md
b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-sql-parser-rule.en.md
new file mode 100644
index 00000000000..9ed48faf27b
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-sql-parser-rule.en.md
@@ -0,0 +1,49 @@
++++
+title = "SHOW SQL_PARSER RULE"
+weight = 4
++++
+
+### Description
+
+The `SHOW SQL_PARSER RULE` syntax is used to query sql parser rule
configuration.
+
+### Syntax
+
+```sql
+ShowSqlParserRule ::=
+ 'SHOW' 'SQL_PARSER' 'RULE'
+```
+
+### Return Value Description
+
+| Colume | Description |
+|---------------------------|------------------------------------|
+| sql_comment_parse_enable | sql comment parse enable status |
+| parse_tree_cache | parse tree cache configuration |
+| sql_statement_cache | sql statement cache configuration |
+
+### Example
+
+- Query sql parser rule configuration
+
+```sql
+SHOW SQL_PARSER RULE;
+```
+
+```sql
+mysql> SHOW SQL_PARSER RULE;
++--------------------------+-----------------------------------------+-------------------------------------------+
+| sql_comment_parse_enable | parse_tree_cache |
sql_statement_cache |
++--------------------------+-----------------------------------------+-------------------------------------------+
+| false | initialCapacity: 128, maximumSize: 1024 |
initialCapacity: 2000, maximumSize: 65535 |
++--------------------------+-----------------------------------------+-------------------------------------------+
+1 row in set (0.05 sec)
+```
+
+### Reserved word
+
+`SHOW`, `SQL_PARSER`, `RULE`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git
a/docs/document/content/reference/distsql/syntax/ral/global-rule/show-transaction-rule.cn.md
b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-transaction-rule.cn.md
new file mode 100644
index 00000000000..6d8d49fe5f7
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-transaction-rule.cn.md
@@ -0,0 +1,48 @@
++++
+title = "SHOW TRANSACTION RULE"
+weight = 3
++++
+
+### 描述
+
+`SHOW TRANSACTION RULE` 语法用于查询事务规则配置
+### 语法
+
+```sql
+ShowTransactionRule ::=
+ 'SHOW' 'TRANSACTION' 'RULE'
+```
+
+### 返回值说明
+
+| 列 | 说明 |
+|----------------|--------------|
+| default_type | 默认事务类型 |
+| provider_type | 事务提供者类型 |
+| props | 事务参数 |
+
+### 示例
+
+- 查询权限规则配置
+
+```sql
+SHOW TRANSACTION RULE;
+```
+
+```sql
+mysql> SHOW TRANSACTION RULE;
++--------------+---------------+-------+
+| default_type | provider_type | props |
++--------------+---------------+-------+
+| LOCAL | | |
++--------------+---------------+-------+
+1 row in set (0.05 sec)
+```
+
+### 保留字
+
+`SHOW`、`TRANSACTION`、`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/show-transaction-rule.en.md
b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-transaction-rule.en.md
new file mode 100644
index 00000000000..ab5ac10e3c2
--- /dev/null
+++
b/docs/document/content/reference/distsql/syntax/ral/global-rule/show-transaction-rule.en.md
@@ -0,0 +1,49 @@
++++
+title = "SHOW TRANSACTION RULE"
+weight = 3
++++
+
+### Description
+
+The `SHOW TRANSACTION RULE` syntax is used to query transaction rule
configuration.
+
+### Syntax
+
+```sql
+ShowTransactionRule ::=
+ 'SHOW' 'TRANSACTION' 'RULE'
+```
+
+### Return Value Description
+
+| Colume | Description |
+|-------------|-------------------------|
+| users | users |
+| provider | privilege provider type |
+| props | privilege properties |
+
+### Example
+
+- Query transaction rule configuration
+
+```sql
+SHOW TRANSACTION RULE;
+```
+
+```sql
+mysql> SHOW TRANSACTION RULE;
++--------------+---------------+-------+
+| default_type | provider_type | props |
++--------------+---------------+-------+
+| LOCAL | | |
++--------------+---------------+-------+
+1 row in set (0.05 sec)
+```
+
+### Reserved word
+
+`SHOW`, `TRANSACTION`, `RULE`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git
a/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-rule.cn.md
b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-rule.cn.md
index d898f2aae0e..03fbef99936 100644
---
a/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-rule.cn.md
+++
b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-rule.cn.md
@@ -23,7 +23,7 @@ ShowMigrationRule ::=
|stream_channel |数据通道 |
### 示例
-- 查询 `SHARDING` 的 hint 设置
+- 查询数据迁移规则
```sql
SHOW MIGRATION RULE;
