You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by du...@apache.org on 2021/11/16 09:35:31 UTC
[shardingsphere] branch master updated: Refactor DistSQL doc (#13642)
This is an automated email from the ASF dual-hosted git repository.
duanzhengqiang 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 ed9dda7 Refactor DistSQL doc (#13642)
ed9dda7 is described below
commit ed9dda7bba16a2255ae134ad91956abd3f7a0eb2
Author: Liang Zhang <te...@163.com>
AuthorDate: Tue Nov 16 17:34:41 2021 +0800
Refactor DistSQL doc (#13642)
---
.../shardingsphere-proxy/distsql/_index.cn.md | 2 +-
.../shardingsphere-proxy/distsql/_index.en.md | 2 +-
.../distsql/syntax/rdl/rdl-single-table.cn.md | 31 ------------
.../distsql/syntax/rdl/rdl-single-table.en.md | 31 ------------
...dl-resource.cn.md => resource-definition.cn.md} | 4 +-
...dl-resource.en.md => resource-definition.en.md} | 4 +-
.../syntax/rdl/rule-definition/_index.cn.md | 7 +++
.../syntax/rdl/rule-definition/_index.en.md | 7 +++
.../db-discovery.cn.md} | 4 +-
.../db-discovery.en.md} | 4 +-
.../encrypt.cn.md} | 2 +-
.../encrypt.en.md} | 2 +-
.../readwrite-splitting.cn.md} | 4 +-
.../readwrite-splitting.en.md} | 4 +-
.../shadow.cn.md} | 6 +--
.../shadow.en.md} | 6 +--
.../sharding.cn.md} | 4 +-
.../sharding.en.md} | 4 +-
.../distsql/syntax/rql/_index.cn.md | 2 +-
.../distsql/syntax/rql/_index.en.md | 2 +-
.../{rql-resource.cn.md => resource-query.cn.md} | 2 +-
.../{rql-resource.en.md => resource-query.en.md} | 2 +-
.../distsql/syntax/rql/rql-single-table.cn.md | 58 ----------------------
.../distsql/syntax/rql/rql-single-table.en.md | 58 ----------------------
.../distsql/syntax/rql/rule-query/_index.cn.md | 7 +++
.../distsql/syntax/rql/rule-query/_index.en.md | 7 +++
.../db-discovery.cn.md} | 2 +-
.../db-discovery.en.md} | 2 +-
.../encrypt.cn.md} | 2 +-
.../encrypt.en.md} | 2 +-
.../readwrite-splitting.cn.md} | 0
.../readwrite-splitting.en.md} | 0
.../shadow.cn.md} | 2 +-
.../shadow.en.md} | 2 +-
.../sharding.cn.md} | 2 +-
.../sharding.en.md} | 2 +-
.../syntax/rql/rule-query/single-table.cn.md | 33 ++++++++++++
.../syntax/rql/rule-query/single-table.en.md | 33 ++++++++++++
38 files changed, 132 insertions(+), 216 deletions(-)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/_index.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/_index.cn.md
index be4008d..4ddf2b4 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/_index.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/_index.cn.md
@@ -4,4 +4,4 @@ weight = 3
chapter = true
+++
-本章节将介绍 [DistSQL](/cn/concepts/distsql/) 的详细语法和实战案例。
\ No newline at end of file
+本章节将介绍 [DistSQL](/cn/concepts/distsql/) 的详细语法。
\ No newline at end of file
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/_index.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/_index.en.md
index cf614bd..bdbc939 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/_index.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/_index.en.md
@@ -4,4 +4,4 @@ weight = 3
chapter = true
+++
-This chapter will introduce the detailed syntax and practical cases of [DistSQL](/en/concepts/distsql/).
+This chapter will introduce the detailed syntax of [DistSQL](/en/concepts/distsql/).
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-single-table.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-single-table.cn.md
deleted file mode 100644
index d704a88..0000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-single-table.cn.md
+++ /dev/null
@@ -1,31 +0,0 @@
-+++
-title = "单表"
-weight = 7
-+++
-
-## 定义
-
-```sql
-CREATE DEFAULT SINGLE TABLE RULE singleTableRuleDefinition
-
-ALTER DEFAULT SINGLE TABLE RULE singleTableRuleDefinition
-
-DROP DEFAULT SINGLE TABLE RULE
-
-singleTableRuleDefinition:
- RESOURCE = resourceName
-```
-- `RESOURCE` 需使用 RDL 管理的数据源资源
-
-
-## 示例
-
-### Single Table Rule
-
-```sql
-CREATE DEFAULT SINGLE TABLE RULE RESOURCE = ds_0
-
-ALTER DEFAULT SINGLE TABLE RULE RESOURCE = ds_1
-
-DROP DEFAULT SINGLE TABLE RULE
-```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-single-table.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-single-table.en.md
deleted file mode 100644
index e1be122..0000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-single-table.en.md
+++ /dev/null
@@ -1,31 +0,0 @@
-+++
-title = "Single Table"
-weight = 7
-+++
-
-## Definition
-
-```sql
-CREATE DEFAULT SINGLE TABLE RULE singleTableRuleDefinition
-
-ALTER DEFAULT SINGLE TABLE RULE singleTableRuleDefinition
-
-DROP DEFAULT SINGLE TABLE RULE
-
-singleTableRuleDefinition:
- RESOURCE = resourceName
-```
-- `RESOURCE` needs to use data source resource managed by RDL
-
-
-## Example
-
-### Single Table Rule
-
-```sql
-CREATE DEFAULT SINGLE TABLE RULE RESOURCE = ds_0
-
-ALTER DEFAULT SINGLE TABLE RULE RESOURCE = ds_1
-
-DROP DEFAULT SINGLE TABLE RULE
-```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-resource.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/resource-definition.cn.md
similarity index 98%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-resource.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/resource-definition.cn.md
index 4901f4f..8df4ac6 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-resource.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/resource-definition.cn.md
@@ -1,9 +1,9 @@
+++
-title = "数据源资源"
+title = "资源定义"
weight = 1
+++
-## 定义
+## 语法说明
```sql
ADD RESOURCE dataSource [, dataSource] ...
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-resource.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/resource-definition.en.md
similarity index 98%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-resource.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/resource-definition.en.md
index 4f57036..564e75f 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-resource.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/resource-definition.en.md
@@ -1,9 +1,9 @@
+++
-title = "Data Source"
+title = "Resource Definition"
weight = 1
+++
-## Definition
+## Syntax
```sql
ADD RESOURCE dataSource [, dataSource] ...
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/_index.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/_index.cn.md
new file mode 100644
index 0000000..88357ae
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/_index.cn.md
@@ -0,0 +1,7 @@
++++
+title = "规则定义"
+weight = 2
+chapter = true
++++
+
+本章节将对规则定义的语法进行详细说明。
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/_index.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/_index.en.md
new file mode 100644
index 0000000..94d0a99
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/_index.en.md
@@ -0,0 +1,7 @@
++++
+title = "Rule Definition"
+weight = 2
+chapter = true
++++
+
+This chapter describes the syntax of rule definition.
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-db-discovery-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/db-discovery.cn.md
similarity index 97%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-db-discovery-rule.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/db-discovery.cn.md
index af90c2b..74ee8fd 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-db-discovery-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/db-discovery.cn.md
@@ -1,9 +1,9 @@
+++
title = "数据库发现"
-weight = 5
+weight = 3
+++
-## 定义
+## 语法说明
```sql
CREATE DB_DISCOVERY RULE databaseDiscoveryRuleDefinition [, databaseDiscoveryRuleDefinition] ...
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-db-discovery-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/db-discovery.en.md
similarity index 97%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-db-discovery-rule.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/db-discovery.en.md
index 6dc510a..22bd621 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-db-discovery-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/db-discovery.en.md
@@ -1,9 +1,9 @@
+++
title = "DB Discovery"
-weight = 5
+weight = 3
+++
-## Definition
+## Syntax
```sql
CREATE DB_DISCOVERY RULE databaseDiscoveryRuleDefinition [, databaseDiscoveryRuleDefinition] ...
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-encrypt-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.cn.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-encrypt-rule.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.cn.md
index efcd971..4b819c1 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-encrypt-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.cn.md
@@ -3,7 +3,7 @@ title = "数据加密"
weight = 4
+++
-## 定义
+## 语法说明
```sql
CREATE ENCRYPT RULE encryptRuleDefinition [, encryptRuleDefinition] ...
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-encrypt-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.en.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-encrypt-rule.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.en.md
index cf32eb8..75b7b5e 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-encrypt-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.en.md
@@ -3,7 +3,7 @@ title = "Encrypt"
weight = 4
+++
-## Definition
+## Syntax
```sql
CREATE ENCRYPT RULE encryptRuleDefinition [, encryptRuleDefinition] ...
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-readwrite-splitting-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting.cn.md
similarity index 98%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-readwrite-splitting-rule.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting.cn.md
index 919903c..3b88ce9 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-readwrite-splitting-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting.cn.md
@@ -1,9 +1,9 @@
+++
title = "读写分离"
-weight = 3
+weight = 2
+++
-## 定义
+## 语法说明
```sql
CREATE READWRITE_SPLITTING RULE readwriteSplittingRuleDefinition [, readwriteSplittingRuleDefinition] ...
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-readwrite-splitting-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting.en.md
similarity index 98%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-readwrite-splitting-rule.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting.en.md
index 8767cd0..39c7ead 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-readwrite-splitting-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting.en.md
@@ -1,9 +1,9 @@
+++
title = "Readwrite-Splitting"
-weight = 3
+weight = 2
+++
-## Definition
+## Syntax
```sql
CREATE READWRITE_SPLITTING RULE readwriteSplittingRuleDefinition [, readwriteSplittingRuleDefinition] ...
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-shadow-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow.cn.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-shadow-rule.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow.cn.md
index b8bff65..dc58628 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-shadow-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow.cn.md
@@ -1,15 +1,15 @@
+++
title = "影子库压测"
-weight = 6
+weight = 5
+++
-## 定义
+## 语法说明
```sql
CREATE SHADOW RULE shadowRuleDefinition [, shadowRuleDefinition] ...
ALTER SHADOW RULE shadowRuleDefinition [, shadowRuleDefinition] ...
-
+``
CREATE SHADOW ALGORITHM shadowAlgorithm [, shadowAlgorithm] ...
ALTER SHADOW ALGORITHM shadowAlgorithm [, shadowAlgorithm] ...
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-shadow-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow.en.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-shadow-rule.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow.en.md
index 138c724..5d74141 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-shadow-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow.en.md
@@ -1,15 +1,15 @@
+++
title = "Shadow"
-weight = 6
+weight = 5
+++
-## Definition
+## Syntax
```sql
CREATE SHADOW RULE shadowRuleDefinition [, shadowRuleDefinition] ...
ALTER SHADOW RULE shadowRuleDefinition [, shadowRuleDefinition] ...
-
+```
CREATE SHADOW ALGORITHM shadowAlgorithm [, shadowAlgorithm] ...
ALTER SHADOW ALGORITHM shadowAlgorithm [, shadowAlgorithm] ...
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-sharding-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.cn.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-sharding-rule.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.cn.md
index 3bc64ee..700e777 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-sharding-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.cn.md
@@ -1,9 +1,9 @@
+++
title = "数据分片"
-weight = 2
+weight = 1
+++
-## 定义
+## 语法说明
### Sharding Table Rule
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-sharding-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.en.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-sharding-rule.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.en.md
index 9cdc612..9cccfac 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rdl-sharding-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.en.md
@@ -1,9 +1,9 @@
+++
title = "Sharding"
-weight = 2
+weight = 1
+++
-## Definition
+## Syntax
### Sharding Table Rule
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/_index.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/_index.cn.md
index 206958b..bd7b594 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/_index.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/_index.cn.md
@@ -4,4 +4,4 @@ weight = 2
chapter = true
+++
-本章节将对 RQL 的语法进行详细说明，列举所有查询列的含义，并通过示例展示所有的查询信息。
+本章节将对 RQL 的语法进行详细说明，并以实际的列子介绍 RQL 的使用。
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/_index.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/_index.en.md
index bb134e2..2bfc47a 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/_index.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/_index.en.md
@@ -4,4 +4,4 @@ weight = 2
chapter = true
+++
-This chapter will explain the syntax of RQL in detail, list the meaning of all query columns, and show all the query information through examples.
+This chapter describes the syntax of RQL in detail, and introduce the use of RQL with actual examples.
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-resource.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/resource-query.cn.md
similarity index 98%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-resource.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/resource-query.cn.md
index 3216efc..5bde5b2 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-resource.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/resource-query.cn.md
@@ -1,5 +1,5 @@
+++
-title = "数据源资源"
+title = "资源查询"
weight = 1
+++
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-resource.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/resource-query.en.md
similarity index 98%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-resource.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/resource-query.en.md
index 84e65d0..dcdede3 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-resource.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/resource-query.en.md
@@ -1,5 +1,5 @@
+++
-title = "Data Source"
+title = "Resource Query"
weight = 1
+++
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-single-table.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-single-table.cn.md
deleted file mode 100644
index 00bf2f7..0000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-single-table.cn.md
+++ /dev/null
@@ -1,58 +0,0 @@
-+++
-title = "单表"
-weight = 7
-+++
-
-## 定义
-
-```sql
-SHOW SINGLE TABLE RULES [FROM schemaName]
-
-SHOW SINGLE tableDefinition | TABLES [FROM schemaName]
-
-tableDefinition:
- TABLE tableName
-```
-
-## 说明
-
-### Single Table Rule
-
-| 列 | 说明 |
-| ------------- | ------------ |
-| name | 规则名称 |
-| resource_name | 数据源名称 |
-
-### Single Table
-
-| 列 | 说明 |
-| ------------- | ------------ |
-| table_name | 单表名称 |
-| resource_name | 数据源名称 |
-
-## 示例
-
-### Single Table Rule
-
-```sql
-mysql> show single table rules;
-+---------+---------------+
-| name | resource_name |
-+---------+---------------+
-| default | ds_0 |
-+---------+---------------+
-1 row in set (3.59 sec)
-```
-
-### Single Table
-
-```sql
-mysql> show single tables;
-+--------------+---------------+
-| table_name | resource_name |
-+--------------+---------------+
-| t_single_0 | ds_0 |
-| t_single_1 | ds_1 |
-+--------------+---------------+
-2 rows in set (0.02 sec)
-```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-single-table.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-single-table.en.md
deleted file mode 100644
index db747d8..0000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-single-table.en.md
+++ /dev/null
@@ -1,58 +0,0 @@
-+++
-title = "Single Table"
-weight = 7
-+++
-
-## Definition
-
-```sql
-SHOW SINGLE TABLE RULES [FROM schemaName]
-
-SHOW SINGLE tableDefinition | TABLES [FROM schemaName]
-
-tableDefinition:
- TABLE tableName
-```
-
-## Description
-
-### Single Table Rule
-
-| Column | Description |
-| ------------- | ------------------|
-| name | Rule name |
-| resource_name | Data source name |
-
-### Single Table
-
-| Column | Description |
-| ------------- | ------------------ |
-| table_name | Single table name |
-| resource_name | Data source name |
-
-## Example
-
-### Single Table Rule
-
-```sql
-mysql> show single table rules;
-+---------+---------------+
-| name | resource_name |
-+---------+---------------+
-| default | ds_0 |
-+---------+---------------+
-1 row in set (3.59 sec)
-```
-
-### Single Table
-
-```sql
-mysql> show single tables;
-+--------------+---------------+
-| table_name | resource_name |
-+--------------+---------------+
-| t_single_0 | ds_0 |
-| t_single_1 | ds_1 |
-+--------------+---------------+
-2 rows in set (0.02 sec)
-```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/_index.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/_index.cn.md
new file mode 100644
index 0000000..1fd2048
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/_index.cn.md
@@ -0,0 +1,7 @@
++++
+title = "规则查询"
+weight = 2
+chapter = true
++++
+
+本章节将对规则查询的语法进行详细说明。
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/_index.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/_index.en.md
new file mode 100644
index 0000000..fbed611
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/_index.en.md
@@ -0,0 +1,7 @@
++++
+title = "Rule Query"
+weight = 2
+chapter = true
++++
+
+This chapter describes the syntax of rule query.
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-db-discovery-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/db-discovery.cn.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-db-discovery-rule.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/db-discovery.cn.md
index 323a52e..7dffdca 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-db-discovery-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/db-discovery.cn.md
@@ -1,6 +1,6 @@
+++
title = "数据库发现"
-weight = 5
+weight = 4
+++
## 定义
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-db-discovery-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/db-discovery.en.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-db-discovery-rule.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/db-discovery.en.md
index c7653d8..6007abe 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-db-discovery-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/db-discovery.en.md
@@ -1,6 +1,6 @@
+++
title = "DB Discovery"
-weight = 5
+weight = 4
+++
## Definition
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-encrypt-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt.cn.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-encrypt-rule.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt.cn.md
index 358921d..435e176 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-encrypt-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt.cn.md
@@ -1,6 +1,6 @@
+++
title = "数据加密"
-weight = 4
+weight = 5
+++
## 定义
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-encrypt-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt.en.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-encrypt-rule.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt.en.md
index 7bde398..6f424a9 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-encrypt-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt.en.md
@@ -1,6 +1,6 @@
+++
title = "Encrypt"
-weight = 4
+weight = 5
+++
## Definition
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-readwrite-splitting-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/readwrite-splitting.cn.md
similarity index 100%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-readwrite-splitting-rule.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/readwrite-splitting.cn.md
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-readwrite-splitting-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/readwrite-splitting.en.md
similarity index 100%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-readwrite-splitting-rule.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/readwrite-splitting.en.md
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-shadow-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow.cn.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-shadow-rule.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow.cn.md
index 049984c..0135c6b 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-shadow-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow.cn.md
@@ -1,5 +1,5 @@
+++
-title = "影子库压测"
+title = "影子库压测"
weight = 6
+++
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-shadow-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow.en.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-shadow-rule.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow.en.md
index 889e7cd..3e10a61 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-shadow-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow.en.md
@@ -1,5 +1,5 @@
+++
-title = "Shadow"
+title = "Shadow"
weight = 6
+++
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-sharding-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.cn.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-sharding-rule.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.cn.md
index b60edbc..dfdc768 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-sharding-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.cn.md
@@ -1,6 +1,6 @@
+++
title = "数据分片"
-weight = 2
+weight = 1
+++
## 定义
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-sharding-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.en.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-sharding-rule.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.en.md
index c892fce..13a199e 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rql-sharding-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.en.md
@@ -1,6 +1,6 @@
+++
title = "Sharding"
-weight = 2
+weight = 1
+++
## Definition
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.cn.md
new file mode 100644
index 0000000..4b76661
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.cn.md
@@ -0,0 +1,33 @@
++++
+title = "单表"
+weight = 2
++++
+
+## 定义
+
+```sql
+SHOW SINGLE TABLE (tableRule | RULES) [FROM schemaName]
+
+tableRule:
+ RULE tableName
+```
+
+## 说明
+
+| 列 | 说明 |
+| ------------- | ------------ |
+| table_name | 单表名称 |
+| resource_name | 数据源名称 |
+
+## 示例
+
+```sql
+mysql> show single table rules;
++--------------+---------------+
+| table_name | resource_name |
++--------------+---------------+
+| t_single_0 | ds_0 |
+| t_single_1 | ds_1 |
++--------------+---------------+
+2 rows in set (0.02 sec)
+```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.en.md
new file mode 100644
index 0000000..0c4c37b
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.en.md
@@ -0,0 +1,33 @@
++++
+title = "Single Table"
+weight = 2
++++
+
+## Definition
+
+```sql
+SHOW SINGLE TABLE (tableRule | RULES) [FROM schemaName]
+
+tableRule:
+ RULE tableName
+```
+
+## Description
+
+| Column | Description |
+| ------------- | -------------------|
+| table_name | Single table name |
+| resource_name | Data source name |
+
+## Example
+
+```sql
+mysql> show single table rules;
++--------------+---------------+
+| table_name | resource_name |
++--------------+---------------+
+| t_single_0 | ds_0 |
+| t_single_1 | ds_1 |
++--------------+---------------+
+2 rows in set (0.02 sec)
+```