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 2026/06/30 03:56:01 UTC
(shardingsphere) branch master updated: Refine official docs against current source contracts (#38965)
This is an automated email from the ASF dual-hosted git repository.
terrymanu 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 ed3c442948c Refine official docs against current source contracts (#38965)
ed3c442948c is described below
commit ed3c442948c99fb80b470d9ef84518f5488fb8a3
Author: Liang Zhang <zh...@apache.org>
AuthorDate: Tue Jun 30 11:55:54 2026 +0800
Refine official docs against current source contracts (#38965)
* Refine official docs against current source contracts
- Align DistSQL syntax, result columns, and examples with current parser and executor behavior
- Remove stale FORMAT SQL, traffic rule, DB discovery, and temporary sharding cache docs
- Correct JDBC/YAML/Java API examples, built-in algorithm properties, and Proxy defaults
- Update migration, shadow, sharding, mask, encrypt, single table, and storage unit docs
* Refine official docs against current source contracts
- Align DistSQL syntax, result columns, and examples with current parser and executor behavior
- Remove stale FORMAT SQL, traffic rule, DB discovery, and temporary sharding cache docs
- Correct JDBC/YAML/Java API examples, built-in algorithm properties, and Proxy defaults
- Update migration, shadow, sharding, mask, encrypt, single table, and storage unit docs
---
.../content/reference/management/_index.cn.md | 4 +-
.../content/reference/management/_index.en.md | 4 +-
.../test-manual/module-test/rewrite-test.cn.md | 2 +-
.../test-manual/module-test/rewrite-test.en.md | 2 +-
.../common-config/builtin-algorithm/mask.cn.md | 4 +-
.../common-config/builtin-algorithm/mask.en.md | 2 +-
.../builtin-algorithm/metadata-repository.cn.md | 4 +-
.../builtin-algorithm/metadata-repository.en.md | 4 +-
.../common-config/builtin-algorithm/sharding.cn.md | 15 ++--
.../common-config/builtin-algorithm/sharding.en.md | 17 ++--
.../shardingsphere-jdbc/java-api/algorithm.en.md | 8 --
.../shardingsphere-jdbc/java-api/data-source.cn.md | 7 +-
.../shardingsphere-jdbc/java-api/data-source.en.md | 5 +-
.../java-api/rules/encrypt.cn.md | 2 -
.../java-api/rules/encrypt.en.md | 2 -
.../shardingsphere-jdbc/java-api/rules/mix.cn.md | 14 ++--
.../shardingsphere-jdbc/java-api/rules/mix.en.md | 14 ++--
.../java-api/rules/readwrite-splitting.cn.md | 4 +-
.../java-api/rules/readwrite-splitting.en.md | 4 +-
.../java-api/rules/sharding-cache.cn.md | 87 -------------------
.../java-api/rules/sharding-cache.en.md | 87 -------------------
.../java-api/rules/sql-translator.cn.md | 5 +-
.../java-api/rules/sql-translator.en.md | 5 +-
.../yaml-config/algorithm.en.md | 10 ---
.../yaml-config/data-source.cn.md | 12 +--
.../yaml-config/data-source.en.md | 12 +--
.../yaml-config/rules/broadcast.cn.md | 8 +-
.../yaml-config/rules/broadcast.en.md | 8 +-
.../yaml-config/rules/encrypt.cn.md | 9 +-
.../yaml-config/rules/encrypt.en.md | 9 +-
.../yaml-config/rules/mask.cn.md | 4 +-
.../yaml-config/rules/mask.en.md | 4 +-
.../yaml-config/rules/mix.cn.md | 5 --
.../yaml-config/rules/mix.en.md | 5 --
.../yaml-config/rules/readwrite-splitting.cn.md | 4 +-
.../yaml-config/rules/readwrite-splitting.en.md | 4 +-
.../yaml-config/rules/sharding-cache.cn.md | 37 ---------
.../yaml-config/rules/sharding-cache.en.md | 37 ---------
.../yaml-config/rules/sharding.cn.md | 8 +-
.../yaml-config/rules/sharding.en.md | 8 +-
.../shardingsphere-proxy/cdc/build.cn.md | 2 +-
.../shardingsphere-proxy/cdc/build.en.md | 2 +-
...r-readwrite-splitting-rule-enable-disable.cn.md | 6 +-
...r-readwrite-splitting-rule-enable-disable.en.md | 6 +-
.../ral/global-rule/alter-traffic-rule.cn.md | 71 ----------------
.../ral/global-rule/alter-traffic-rule.en.md | 71 ----------------
.../syntax/ral/global-rule/show-traffic-rule.cn.md | 81 ------------------
.../syntax/ral/global-rule/show-traffic-rule.en.md | 82 ------------------
.../distsql/syntax/ral/migration/_index.en.md | 2 +-
.../ral/migration/alter-migration-rule.cn.md | 6 +-
.../ral/migration/alter-migration-rule.en.md | 4 +-
.../syntax/ral/migration/check-migration.cn.md | 2 +-
.../syntax/ral/migration/check-migration.en.md | 2 +-
.../syntax/ral/migration/commit-migration.cn.md | 2 +-
.../syntax/ral/migration/commit-migration.en.md | 2 +-
...tion-check.cn.md => drop-migration-check.cn.md} | 20 ++---
...tion-check.en.md => drop-migration-check.en.md} | 18 ++--
.../register-migration-source-storage-unit.cn.md | 37 +++++++--
.../register-migration-source-storage-unit.en.md | 35 +++++++-
.../syntax/ral/migration/rollback-migration.cn.md | 2 +-
.../syntax/ral/migration/rollback-migration.en.md | 2 +-
.../migration/show-migration-check-algorithm.cn.md | 24 +++---
.../migration/show-migration-check-algorithm.en.md | 19 +++--
.../migration/show-migration-check-status.cn.md | 39 +++++----
.../migration/show-migration-check-status.en.md | 37 +++++----
.../syntax/ral/migration/show-migration-list.en.md | 2 +-
.../show-migration-source-storage-units.cn.md | 28 ++++---
.../show-migration-source-storage-units.en.md | 28 ++++---
.../ral/migration/show-migration-status.cn.md | 18 ++--
.../ral/migration/show-migration-status.en.md | 16 ++--
.../ral/migration/start-migration-check.cn.md | 2 +-
.../ral/migration/start-migration-check.en.md | 2 +-
.../syntax/ral/migration/start-migration.cn.md | 2 +-
.../syntax/ral/migration/start-migration.en.md | 2 +-
.../ral/migration/stop-migration-check.cn.md | 2 +-
.../ral/migration/stop-migration-check.en.md | 2 +-
.../syntax/ral/migration/stop-migration.cn.md | 2 +-
.../syntax/ral/migration/stop-migration.en.md | 2 +-
.../syntax/ral/show-compute-node-info.cn.md | 15 ++--
.../syntax/ral/show-compute-node-info.en.md | 14 ++--
.../distsql/syntax/ral/show-table-metadata.cn.md | 95 ++++++++++-----------
.../distsql/syntax/ral/show-table-metadata.en.md | 97 +++++++++++-----------
.../encrypt/alter-encrypt-rule.cn.md | 13 +--
.../encrypt/alter-encrypt-rule.en.md | 13 +--
.../encrypt/create-encrypt-rule.cn.md | 25 +++---
.../encrypt/create-encrypt-rule.en.md | 25 +++---
.../rdl/rule-definition/mask/alter-mask-rule.cn.md | 6 +-
.../rdl/rule-definition/mask/alter-mask-rule.en.md | 4 +-
.../rule-definition/mask/create-mask-rule.cn.md | 6 +-
.../rule-definition/mask/create-mask-rule.en.md | 4 +-
.../rdl/rule-definition/mask/drop-mask-rule.cn.md | 4 +-
.../rdl/rule-definition/mask/drop-mask-rule.en.md | 4 +-
.../drop-readwrite-splitting-rule.cn.md | 19 ++---
.../drop-readwrite-splitting-rule.en.md | 17 ++--
.../shadow/alter-default-shadow-algorithm.cn.md | 2 +-
.../shadow/alter-default-shadow-algorithm.en.md | 2 +-
.../rule-definition/shadow/alter-shadow-rule.cn.md | 6 +-
.../rule-definition/shadow/alter-shadow-rule.en.md | 6 +-
.../shadow/create-default-shadow-algorithm.cn.md | 2 +-
.../shadow/create-default-shadow-algorithm.en.md | 2 +-
.../shadow/create-shadow-rule.cn.md | 6 +-
.../shadow/create-shadow-rule.en.md | 6 +-
.../shadow/drop-default-shadow-algorithm.cn.md | 19 ++---
.../shadow/drop-default-shadow-algorithm.en.md | 17 +---
.../shadow/drop-shadow-algorithm.cn.md | 17 ++--
.../shadow/drop-shadow-algorithm.en.md | 15 ++--
.../rule-definition/shadow/drop-shadow-rule.cn.md | 19 ++---
.../rule-definition/shadow/drop-shadow-rule.en.md | 17 ++--
.../sharding/alter-default-sharding-strategy.cn.md | 9 +-
.../sharding/alter-default-sharding-strategy.en.md | 9 +-
.../sharding/alter-sharding-table-rule.cn.md | 9 +-
.../sharding/alter-sharding-table-rule.en.md | 9 +-
.../create-default-sharding-strategy.cn.md | 9 +-
.../create-default-sharding-strategy.en.md | 9 +-
.../sharding/create-sharding-table-rule.cn.md | 9 +-
.../sharding/create-sharding-table-rule.en.md | 9 +-
.../sharding/drop-default-sharding-strategy.cn.md | 17 ++--
.../sharding/drop-default-sharding-strategy.en.md | 15 ++--
.../sharding/drop-sharding-algorithm.cn.md | 19 ++---
.../sharding/drop-sharding-algorithm.en.md | 17 ++--
.../sharding/drop-sharding-auditor.cn.md | 55 ++++++++++++
.../sharding/drop-sharding-auditor.en.md | 55 ++++++++++++
.../sharding/drop-sharding-key-generator.cn.md | 19 ++---
.../sharding/drop-sharding-key-generator.en.md | 17 ++--
.../sharding/drop-sharding-table-rule.cn.md | 17 ++--
.../sharding/drop-sharding-table-rule.en.md | 15 ++--
.../single-table/unload-single-table.cn.md | 4 +-
.../single-table/unload-single-table.en.md | 2 +
.../distsql/syntax/reserved-word.cn.md | 14 +---
.../distsql/syntax/reserved-word.en.md | 14 +---
.../show-broadcast-table-rule.cn.md | 4 +-
.../show-broadcast-table-rule.en.md | 4 +-
.../rql/rule-query/encrypt/show-encrypt-rule.cn.md | 3 +-
.../rql/rule-query/encrypt/show-encrypt-rule.en.md | 2 +-
.../rql/rule-query/mask/show-mask-rule.cn.md | 29 ++++---
.../rql/rule-query/mask/show-mask-rule.en.md | 28 +++----
.../rql/rule-query/shadow/show-shadow-rule.cn.md | 55 ++++++------
.../rql/rule-query/shadow/show-shadow-rule.en.md | 58 +++++++------
.../rule-query/shadow/show-shadow-table-rule.cn.md | 20 +++--
.../rule-query/shadow/show-shadow-table-rule.en.md | 17 +++-
.../sharding/show-sharding-table-rule.cn.md | 2 +
.../sharding/show-sharding-table-rule.en.md | 2 +
.../single-table/count-single-table.cn.md | 3 +-
.../single-table/count-single-table.en.md | 2 +-
...> show-default-single-table-storage-unit.cn.md} | 0
...> show-default-single-table-storage-unit.en.md} | 0
.../single-table/show-single-table.cn.md | 52 +++---------
.../single-table/show-single-table.en.md | 51 +++---------
.../single-table/show-unloaded-single-tables.cn.md | 16 +++-
.../single-table/show-unloaded-single-tables.en.md | 15 +++-
.../storage-unit-query/show-logical-tables.cn.md | 73 ++++++++++++++++
.../storage-unit-query/show-logical-tables.en.md | 73 ++++++++++++++++
.../show-rules-used-storage-unit.cn.md | 6 +-
.../show-rules-used-storage-unit.en.md | 4 +-
.../distsql/syntax/rul/format-sql.cn.md | 55 ------------
.../distsql/syntax/rul/format-sql.en.md | 55 ------------
.../startup/graalvm-native-image.cn.md | 14 ++--
.../startup/graalvm-native-image.en.md | 14 ++--
.../shardingsphere-proxy/yaml-config/props.cn.md | 2 +-
.../shardingsphere-proxy/yaml-config/props.en.md | 2 +-
160 files changed, 1133 insertions(+), 1545 deletions(-)
diff --git a/docs/document/content/reference/management/_index.cn.md b/docs/document/content/reference/management/_index.cn.md
index 02eeecbf185..8e7975bbfbe 100644
--- a/docs/document/content/reference/management/_index.cn.md
+++ b/docs/document/content/reference/management/_index.cn.md
@@ -135,7 +135,7 @@ ds_0:
minimumIdle: 1
password: root
idleTimeout: 60000
- standardJdbcUrl: jdbc:mysql://127.0.0.1:3306/ds_0?serverTimezone=UTC&useSSL=false
+ jdbcUrl: jdbc:mysql://127.0.0.1:3306/ds_0?serverTimezone=UTC&useSSL=false
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
maximumPoolSize: 50
connectionTimeout: 30000
@@ -155,7 +155,7 @@ ds_0:
minimumIdle: 1
password: root
idleTimeout: 60000
- standardJdbcUrl: jdbc:mysql://127.0.0.1:3306/ds_0?serverTimezone=UTC&useSSL=false
+ jdbcUrl: jdbc:mysql://127.0.0.1:3306/ds_0?serverTimezone=UTC&useSSL=false
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
maximumPoolSize: 50
connectionTimeout: 30000
diff --git a/docs/document/content/reference/management/_index.en.md b/docs/document/content/reference/management/_index.en.md
index 8627002cef7..8961eb6708e 100644
--- a/docs/document/content/reference/management/_index.en.md
+++ b/docs/document/content/reference/management/_index.en.md
@@ -135,7 +135,7 @@ ds_0:
minimumIdle: 1
password: root
idleTimeout: 60000
- standardJdbcUrl: jdbc:mysql://127.0.0.1:3306/ds_0?serverTimezone=UTC&useSSL=false
+ jdbcUrl: jdbc:mysql://127.0.0.1:3306/ds_0?serverTimezone=UTC&useSSL=false
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
maximumPoolSize: 50
connectionTimeout: 30000
@@ -156,7 +156,7 @@ ds_0:
minimumIdle: 1
password: root
idleTimeout: 60000
- standardJdbcUrl: jdbc:mysql://127.0.0.1:3306/ds_0?serverTimezone=UTC&useSSL=false
+ jdbcUrl: jdbc:mysql://127.0.0.1:3306/ds_0?serverTimezone=UTC&useSSL=false
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
maximumPoolSize: 50
connectionTimeout: 30000
diff --git a/docs/document/content/test-manual/module-test/rewrite-test.cn.md b/docs/document/content/test-manual/module-test/rewrite-test.cn.md
index a2a6ceccce0..218e693c0f4 100644
--- a/docs/document/content/test-manual/module-test/rewrite-test.cn.md
+++ b/docs/document/content/test-manual/module-test/rewrite-test.cn.md
@@ -23,7 +23,7 @@ SQL 改写测试用例位于 `test/it/rewriter` 下的 test 中。SQL 改写的
dataSources:
db: !!com.zaxxer.hikari.HikariDataSource
driverClassName: org.h2.Driver
- standardJdbcUrl: jdbc:h2:mem:db;DB_CLOSE_DELAY=-1;DATABASE_TO_UPPER=false;MODE=MYSQL
+ jdbcUrl: jdbc:h2:mem:db;DB_CLOSE_DELAY=-1;DATABASE_TO_UPPER=false;MODE=MYSQL
username: sa
password:
diff --git a/docs/document/content/test-manual/module-test/rewrite-test.en.md b/docs/document/content/test-manual/module-test/rewrite-test.en.md
index ca8500cb8ba..323945edf8d 100644
--- a/docs/document/content/test-manual/module-test/rewrite-test.en.md
+++ b/docs/document/content/test-manual/module-test/rewrite-test.en.md
@@ -23,7 +23,7 @@ Environment configuration is the yaml file under test type under `test\resources
dataSources:
db: !!com.zaxxer.hikari.HikariDataSource
driverClassName: org.h2.Driver
- standardJdbcUrl: jdbc:h2:mem:db;DB_CLOSE_DELAY=-1;DATABASE_TO_UPPER=false;MODE=MYSQL
+ jdbcUrl: jdbc:h2:mem:db;DB_CLOSE_DELAY=-1;DATABASE_TO_UPPER=false;MODE=MYSQL
username: sa
password:
diff --git a/docs/document/content/user-manual/common-config/builtin-algorithm/mask.cn.md b/docs/document/content/user-manual/common-config/builtin-algorithm/mask.cn.md
index 7eb51f15321..66340342617 100644
--- a/docs/document/content/user-manual/common-config/builtin-algorithm/mask.cn.md
+++ b/docs/document/content/user-manual/common-config/builtin-algorithm/mask.cn.md
@@ -32,7 +32,7 @@ weight = 9
| *名称* | *数据类型* | *说明* |
|--------------|--------|-------|
| first-n | int | 前 n 位 |
-| last-m | int | 后 n 位 |
+| last-m | int | 后 m 位 |
| replace-char | String | 替换字符 |
#### 保留自 X 至 Y 脱敏算法
@@ -56,7 +56,7 @@ weight = 9
| *名称* | *数据类型* | *说明* |
|--------------|--------|-------|
| first-n | int | 前 n 位 |
-| last-m | int | 后 n 位 |
+| last-m | int | 后 m 位 |
| replace-char | String | 替换字符 |
#### 遮盖自 X 至 Y 脱敏算法
diff --git a/docs/document/content/user-manual/common-config/builtin-algorithm/mask.en.md b/docs/document/content/user-manual/common-config/builtin-algorithm/mask.en.md
index d29b40d51ca..53a8db134f2 100644
--- a/docs/document/content/user-manual/common-config/builtin-algorithm/mask.en.md
+++ b/docs/document/content/user-manual/common-config/builtin-algorithm/mask.en.md
@@ -105,7 +105,7 @@ Attributes:
|------------------------|------------|------------------------------------------------------------------------------------------------------------------|
| uppercase-letter-codes | String | Uppercase letter codes (separate with comma, default value: A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z) |
| lowercase-letter-codes | String | Lowercase-letter codes (separate with comma, default value: a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z) |
-| digital-random-codes | String | Numbers (separate with comma, default value: 0,1,2,3,4,5,6,7,8,9) |
+| digital-codes | String | Numbers (separate with comma, default value: 0,1,2,3,4,5,6,7,8,9) |
| special-codes | String | Special codes (separate with comma, default value: ~,!,@,#,$,%,^,&,*,:,<,>,¦) |
## Operating Procedure
diff --git a/docs/document/content/user-manual/common-config/builtin-algorithm/metadata-repository.cn.md b/docs/document/content/user-manual/common-config/builtin-algorithm/metadata-repository.cn.md
index ecc3b32c841..43d7b5e3b94 100644
--- a/docs/document/content/user-manual/common-config/builtin-algorithm/metadata-repository.cn.md
+++ b/docs/document/content/user-manual/common-config/builtin-algorithm/metadata-repository.cn.md
@@ -42,7 +42,7 @@ mode:
| *名称* | *数据类型* | *说明* | *默认值* |
|----------|--------|----------|-------------------------------------------------------------------------|
| provider | String | 元数据存储类型 | H2 |
-| jdbc_url | String | JDBC URL | jdbc:h2:mem:config;DB_CLOSE_DELAY=-1;DATABASE_TO_UPPER=false;MODE=MYSQL |
+| jdbc_url | String | JDBC URL | jdbc:h2:mem:config;DB_CLOSE_DELAY=0;DATABASE_TO_UPPER=false;MODE=MYSQL |
| username | String | 账号 | sa |
| password | String | 密码 | |
@@ -91,7 +91,7 @@ mode:
type: JDBC
props:
provider: H2
- jdbc_url: jdbc:h2:mem:config;DB_CLOSE_DELAY=-1;DATABASE_TO_UPPER=false;MODE=MYSQL
+ jdbc_url: jdbc:h2:mem:config;DB_CLOSE_DELAY=0;DATABASE_TO_UPPER=false;MODE=MYSQL
username: test
password: Test@9876
```
diff --git a/docs/document/content/user-manual/common-config/builtin-algorithm/metadata-repository.en.md b/docs/document/content/user-manual/common-config/builtin-algorithm/metadata-repository.en.md
index 33f81bf4ac2..f820a57f39f 100644
--- a/docs/document/content/user-manual/common-config/builtin-algorithm/metadata-repository.en.md
+++ b/docs/document/content/user-manual/common-config/builtin-algorithm/metadata-repository.en.md
@@ -42,7 +42,7 @@ Attributes:
| *Name* | *Type* | *Description* | *Default Value* |
|----------|--------|---------------------------|-------------------------------------------------------------------------|
| provider | String | Type for metadata persist | H2 |
-| jdbc_url | String | JDBC URL | jdbc:h2:mem:config;DB_CLOSE_DELAY=-1;DATABASE_TO_UPPER=false;MODE=MYSQL |
+| jdbc_url | String | JDBC URL | jdbc:h2:mem:config;DB_CLOSE_DELAY=0;DATABASE_TO_UPPER=false;MODE=MYSQL |
| username | String | username | sa |
| password | String | password | |
@@ -91,7 +91,7 @@ mode:
type: JDBC
props:
provider: H2
- jdbc_url: jdbc:h2:mem:config;DB_CLOSE_DELAY=-1;DATABASE_TO_UPPER=false;MODE=MYSQL
+ jdbc_url: jdbc:h2:mem:config;DB_CLOSE_DELAY=0;DATABASE_TO_UPPER=false;MODE=MYSQL
username: test
password: Test@9876
```
diff --git a/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.cn.md b/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.cn.md
index 6634fbd9d09..c9eeb7150ac 100644
--- a/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.cn.md
+++ b/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.cn.md
@@ -18,9 +18,12 @@ ShardingSphere 内置提供了多种分片算法，按照类型可以划分为
可配置属性：
-| *属性名称* | *数据类型* | *说明* |
-|----------------|--------|------|
-| sharding-count | int | 分片数量 |
+| *属性名称* | *数据类型* | *说明* | *默认值* |
+|-----------------|---------|-------------|-------|
+| sharding-count | int | 分片数量 | - |
+| start-offset (?) | int | 提取分片值的起始偏移量 | 0 |
+| stop-offset (?) | int | 提取分片值的结束偏移量 | 0 |
+| zero-padding (?) | boolean | 是否对分片后缀补零 | false |
#### 哈希取模分片算法
@@ -29,9 +32,9 @@ ShardingSphere 内置提供了多种分片算法，按照类型可以划分为
可配置属性：
-| *属性名称* | *数据类型* | *说明* |
-|---------------------------------|---------|-------------------------------------------------------------------|
-| sharding-count | int | 分片数量 |
+| *属性名称* | *数据类型* | *说明* | *默认值* |
+|---------------------------------|---------|-------------------------------------------------------------------|-------|
+| sharding-count | int | 分片数量 | - |
| normalize-numeric-int-range (?) | boolean | 是否将整型范围内的 `Long` 和 `BigInteger` 按 `Integer` 语义统一计算，以保证相同数值跨类型路由一致 | false |
#### 基于分片容量的范围分片算法
diff --git a/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.en.md b/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.en.md
index 80b269d6ec2..cfba6534db4 100644
--- a/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.en.md
+++ b/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.en.md
@@ -21,9 +21,12 @@ Type: MOD
Attributes:
-| *Name* | *DataType* | *Description* |
-|----------------|------------|----------------|
-| sharding-count | int | Sharding count |
+| *Name* | *DataType* | *Description* | *Default Value* |
+|------------------|------------|------------------------------------------------|-----------------|
+| sharding-count | int | Sharding count | - |
+| start-offset (?) | int | Start offset for extracting the sharding value | 0 |
+| stop-offset (?) | int | Stop offset for extracting the sharding value | 0 |
+| zero-padding (?) | boolean | Whether to pad the sharding suffix with zeros | false |
#### Hash Modulo Sharding Algorithm
@@ -31,10 +34,10 @@ Type: HASH_MOD
Attributes:
-| *Name* | *DataType* | *Description* |
-|---------------------------------|------------|---------------------------------------------------------------------------------------------------------------------------------------|
-| sharding-count | int | Sharding count |
-| normalize-numeric-int-range (?) | boolean | Whether to normalize `Long` and `BigInteger` values in integer range to integer semantics for consistent routing across numeric types | false |
+| *Name* | *DataType* | *Description* | *Default Value* |
+|---------------------------------|------------|---------------------------------------------------------------------------------------------------------------------------------------|-----------------|
+| sharding-count | int | Sharding count | - |
+| normalize-numeric-int-range (?) | boolean | Whether to normalize `Long` and `BigInteger` values in integer range to integer semantics for consistent routing across numeric types | false |
#### Volume Based Range Sharding Algorithm
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/algorithm.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/algorithm.en.md
index ff2770f35e3..b9e6895ba45 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/algorithm.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/algorithm.en.md
@@ -40,14 +40,6 @@ Map<String, AlgorithmConfiguration> algorithmConfigs = new HashMap<>();
algorithmConfigs.put("shadowAlgorithmName", new AlgorithmConfiguration("xxx", new Properties()));
```
-## High Availability
-
-```
-// discoveryTypeName is specified by users, and its property has to be consistent with that of discoveryTypeName in database discovery rules.
-Map<String, AlgorithmConfiguration> algorithmConfigs = new HashMap<>();
-algorithmConfigs.put("discoveryTypeName", new AlgorithmConfiguration("xxx", new Properties()));
-```
-
## Data Masking
```java
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/data-source.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/data-source.cn.md
index cac806802c7..6accc519c4f 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/data-source.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/data-source.cn.md
@@ -37,7 +37,7 @@ private Map<String, DataSource> createDataSources() {
Map<String, DataSource> dataSourceMap = new HashMap<>();
// 配置第 1 个数据源
HikariDataSource dataSource1 = new HikariDataSource();
- dataSource1.setDriverClassName("com.mysql.jdbc.Driver");
+ dataSource1.setDriverClassName("com.mysql.cj.jdbc.Driver");
dataSource1.setJdbcUrl("jdbc:mysql://localhost:3306/ds_1");
dataSource1.setUsername("root");
dataSource1.setPassword("");
@@ -45,10 +45,11 @@ private Map<String, DataSource> createDataSources() {
// 配置第 2 个数据源
HikariDataSource dataSource2 = new HikariDataSource();
- dataSource2.setDriverClassName("com.mysql.jdbc.Driver");
+ dataSource2.setDriverClassName("com.mysql.cj.jdbc.Driver");
dataSource2.setJdbcUrl("jdbc:mysql://localhost:3306/ds_2");
dataSource2.setUsername("root");
dataSource2.setPassword("");
dataSourceMap.put("ds_2", dataSource2);
+ return dataSourceMap;
}
-```
\ No newline at end of file
+```
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/data-source.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/data-source.en.md
index cca6366123e..64ee7d5fb5e 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/data-source.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/data-source.en.md
@@ -37,7 +37,7 @@ private Map<String, DataSource> createDataSources() {
Map<String, DataSource> dataSourceMap = new HashMap<>();
// Configure the 1st data source
HikariDataSource dataSource1 = new HikariDataSource();
- dataSource1.setDriverClassName("com.mysql.jdbc.Driver");
+ dataSource1.setDriverClassName("com.mysql.cj.jdbc.Driver");
dataSource1.setJdbcUrl("jdbc:mysql://localhost:3306/ds_1");
dataSource1.setUsername("root");
dataSource1.setPassword("");
@@ -45,10 +45,11 @@ private Map<String, DataSource> createDataSources() {
// Configure the 2nd data source
HikariDataSource dataSource2 = new HikariDataSource();
- dataSource2.setDriverClassName("com.mysql.jdbc.Driver");
+ dataSource2.setDriverClassName("com.mysql.cj.jdbc.Driver");
dataSource2.setJdbcUrl("jdbc:mysql://localhost:3306/ds_2");
dataSource2.setUsername("root");
dataSource2.setPassword("");
dataSourceMap.put("ds_2", dataSource2);
+ return dataSourceMap;
}
```
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.cn.md
index 476ee9f5306..224c63215c6 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.cn.md
@@ -87,12 +87,10 @@ public final class EncryptDatabasesConfiguration {
EncryptColumnRuleConfiguration columnConfigAes = new EncryptColumnRuleConfiguration("username", new EncryptColumnItemRuleConfiguration("username", "name_encryptor"));
EncryptColumnRuleConfiguration columnConfigTest = new EncryptColumnRuleConfiguration("pwd", new EncryptColumnItemRuleConfiguration("pwd", "pwd_encryptor"));
columnConfigTest.setAssistedQuery(new EncryptColumnItemRuleConfiguration("assisted_query_pwd", "pwd_encryptor"));
- columnConfigTest.setLikeQuery(new EncryptColumnItemRuleConfiguration("like_pwd", "like_encryptor"));
EncryptTableRuleConfiguration encryptTableRuleConfig = new EncryptTableRuleConfiguration("t_user", Arrays.asList(columnConfigAes, columnConfigTest));
Map<String, AlgorithmConfiguration> encryptAlgorithmConfigs = new HashMap<>();
encryptAlgorithmConfigs.put("name_encryptor", new AlgorithmConfiguration("AES", props));
encryptAlgorithmConfigs.put("pwd_encryptor", new AlgorithmConfiguration("assistedTest", props));
- encryptAlgorithmConfigs.put("like_encryptor", new AlgorithmConfiguration("CHAR_DIGEST_LIKE", new Properties()));
EncryptRuleConfiguration encryptRuleConfig = new EncryptRuleConfiguration(Collections.singleton(encryptTableRuleConfig), encryptAlgorithmConfigs);
return ShardingSphereDataSourceFactory.createDataSource(DataSourceUtil.createDataSource("demo_ds"), Collections.singleton(encryptRuleConfig), props);
}
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.en.md
index 4491b9d5938..4307b0c6e1f 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.en.md
@@ -87,12 +87,10 @@ public final class EncryptDatabasesConfiguration {
EncryptColumnRuleConfiguration columnConfigAes = new EncryptColumnRuleConfiguration("username", new EncryptColumnItemRuleConfiguration("username", "name_encryptor"));
EncryptColumnRuleConfiguration columnConfigTest = new EncryptColumnRuleConfiguration("pwd", new EncryptColumnItemRuleConfiguration("pwd", "pwd_encryptor"));
columnConfigTest.setAssistedQuery(new EncryptColumnItemRuleConfiguration("assisted_query_pwd", "pwd_encryptor"));
- columnConfigTest.setLikeQuery(new EncryptColumnItemRuleConfiguration("like_pwd", "like_encryptor"));
EncryptTableRuleConfiguration encryptTableRuleConfig = new EncryptTableRuleConfiguration("t_user", Arrays.asList(columnConfigAes, columnConfigTest));
Map<String, AlgorithmConfiguration> encryptAlgorithmConfigs = new HashMap<>();
encryptAlgorithmConfigs.put("name_encryptor", new AlgorithmConfiguration("AES", props));
encryptAlgorithmConfigs.put("pwd_encryptor", new AlgorithmConfiguration("assistedTest", props));
- encryptAlgorithmConfigs.put("like_encryptor", new AlgorithmConfiguration("CHAR_DIGEST_LIKE", new Properties()));
EncryptRuleConfiguration encryptRuleConfig = new EncryptRuleConfiguration(Collections.singleton(encryptTableRuleConfig), encryptAlgorithmConfigs);
return ShardingSphereDataSourceFactory.createDataSource(DataSourceUtil.createDataSource("demo_ds"), Collections.singleton(encryptRuleConfig), props);
}
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/mix.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/mix.cn.md
index 8a20487d7cf..172a4438e6b 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/mix.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/mix.cn.md
@@ -32,12 +32,12 @@ private ShardingTableRuleConfiguration getOrderTableRuleConfiguration() {
// 读写分离配置
private static ReadwriteSplittingRuleConfiguration createReadwriteSplittingConfiguration() {
- ReadwriteSplittingDataSourceRuleConfiguration dataSourceConfiguration1 = new ReadwriteSplittingDataSourceRuleConfiguration("replica_ds_0", Arrays.asList("readwrite_ds_0"), true), "");
- ReadwriteSplittingDataSourceRuleConfiguration dataSourceConfiguration2 = new ReadwriteSplittingDataSourceRuleConfiguration("replica_ds_1", Arrays.asList("readwrite_ds_1"), true), "");
- Collection<ReadwriteSplittingDataSourceRuleConfiguration> dataSources = new LinkedList<>();
- dataSources.add(dataSourceRuleConfiguration1);
- dataSources.add(dataSourceRuleConfiguration2);
- return new ReadwriteSplittingRuleConfiguration(dataSources, Collections.emptyMap());
+ ReadwriteSplittingDataSourceGroupRuleConfiguration dataSourceGroupConfiguration1 = new ReadwriteSplittingDataSourceGroupRuleConfiguration("replica_ds_0", "write_ds_0", Arrays.asList("read_ds_0", "read_ds_1"), null);
+ ReadwriteSplittingDataSourceGroupRuleConfiguration dataSourceGroupConfiguration2 = new ReadwriteSplittingDataSourceGroupRuleConfiguration("replica_ds_1", "write_ds_1", Arrays.asList("read_ds_2", "read_ds_3"), null);
+ Collection<ReadwriteSplittingDataSourceGroupRuleConfiguration> dataSourceGroups = new LinkedList<>();
+ dataSourceGroups.add(dataSourceGroupConfiguration1);
+ dataSourceGroups.add(dataSourceGroupConfiguration2);
+ return new ReadwriteSplittingRuleConfiguration(dataSourceGroups, Collections.emptyMap());
}
// 数据加密配置
@@ -48,12 +48,10 @@ private static EncryptRuleConfiguration createEncryptRuleConfiguration() {
EncryptColumnRuleConfiguration columnConfigAes = new EncryptColumnRuleConfiguration("username", new EncryptColumnItemRuleConfiguration("username", "name_encryptor"));
EncryptColumnRuleConfiguration columnConfigTest = new EncryptColumnRuleConfiguration("pwd", new EncryptColumnItemRuleConfiguration("pwd", "pwd_encryptor"));
columnConfigTest.setAssistedQuery(new EncryptColumnItemRuleConfiguration("assisted_query_pwd", "pwd_encryptor"));
- columnConfigTest.setLikeQuery(new EncryptColumnItemRuleConfiguration("like_pwd", "like_encryptor"));
EncryptTableRuleConfiguration encryptTableRuleConfig = new EncryptTableRuleConfiguration("t_user", Arrays.asList(columnConfigAes, columnConfigTest));
Map<String, AlgorithmConfiguration> encryptAlgorithmConfigs = new HashMap<>();
encryptAlgorithmConfigs.put("name_encryptor", new AlgorithmConfiguration("AES", props));
encryptAlgorithmConfigs.put("pwd_encryptor", new AlgorithmConfiguration("assistedTest", props));
- encryptAlgorithmConfigs.put("like_encryptor", new AlgorithmConfiguration("CHAR_DIGEST_LIKE", new Properties()));
return new EncryptRuleConfiguration(Collections.singleton(encryptTableRuleConfig), encryptAlgorithmConfigs);
}
```
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/mix.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/mix.en.md
index 69160e3d74d..21649d65d4c 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/mix.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/mix.en.md
@@ -33,12 +33,12 @@ private ShardingTableRuleConfiguration getOrderTableRuleConfiguration() {
// Read/write splitting configuration
private static ReadwriteSplittingRuleConfiguration createReadwriteSplittingConfiguration() {
- ReadwriteSplittingDataSourceRuleConfiguration dataSourceConfiguration1 = new ReadwriteSplittingDataSourceRuleConfiguration("replica_ds_0", Arrays.asList("readwrite_ds_0"), true), "");
- ReadwriteSplittingDataSourceRuleConfiguration dataSourceConfiguration2 = new ReadwriteSplittingDataSourceRuleConfiguration("replica_ds_1", Arrays.asList("readwrite_ds_1"), true), "");
- Collection<ReadwriteSplittingDataSourceRuleConfiguration> dataSources = new LinkedList<>();
- dataSources.add(dataSourceRuleConfiguration1);
- dataSources.add(dataSourceRuleConfiguration2);
- return new ReadwriteSplittingRuleConfiguration(dataSources, Collections.emptyMap());
+ ReadwriteSplittingDataSourceGroupRuleConfiguration dataSourceGroupConfiguration1 = new ReadwriteSplittingDataSourceGroupRuleConfiguration("replica_ds_0", "write_ds_0", Arrays.asList("read_ds_0", "read_ds_1"), null);
+ ReadwriteSplittingDataSourceGroupRuleConfiguration dataSourceGroupConfiguration2 = new ReadwriteSplittingDataSourceGroupRuleConfiguration("replica_ds_1", "write_ds_1", Arrays.asList("read_ds_2", "read_ds_3"), null);
+ Collection<ReadwriteSplittingDataSourceGroupRuleConfiguration> dataSourceGroups = new LinkedList<>();
+ dataSourceGroups.add(dataSourceGroupConfiguration1);
+ dataSourceGroups.add(dataSourceGroupConfiguration2);
+ return new ReadwriteSplittingRuleConfiguration(dataSourceGroups, Collections.emptyMap());
}
// Data encryption configuration
@@ -49,12 +49,10 @@ private static EncryptRuleConfiguration createEncryptRuleConfiguration() {
EncryptColumnRuleConfiguration columnConfigAes = new EncryptColumnRuleConfiguration("username", new EncryptColumnItemRuleConfiguration("username", "name_encryptor"));
EncryptColumnRuleConfiguration columnConfigTest = new EncryptColumnRuleConfiguration("pwd", new EncryptColumnItemRuleConfiguration("pwd", "pwd_encryptor"));
columnConfigTest.setAssistedQuery(new EncryptColumnItemRuleConfiguration("assisted_query_pwd", "pwd_encryptor"));
- columnConfigTest.setLikeQuery(new EncryptColumnItemRuleConfiguration("like_pwd", "like_encryptor"));
EncryptTableRuleConfiguration encryptTableRuleConfig = new EncryptTableRuleConfiguration("t_user", Arrays.asList(columnConfigAes, columnConfigTest));
Map<String, AlgorithmConfiguration> encryptAlgorithmConfigs = new HashMap<>();
encryptAlgorithmConfigs.put("name_encryptor", new AlgorithmConfiguration("AES", props));
encryptAlgorithmConfigs.put("pwd_encryptor", new AlgorithmConfiguration("assistedTest", props));
- encryptAlgorithmConfigs.put("like_encryptor", new AlgorithmConfiguration("CHAR_DIGEST_LIKE", new Properties()));
return new EncryptRuleConfiguration(Collections.singleton(encryptTableRuleConfig), encryptAlgorithmConfigs);
}
```
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.cn.md
index f86a61f54bb..e77872045e3 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.cn.md
@@ -17,7 +17,7 @@ Java API 形式配置的读写分离可以方便的适用于各种场景，不
| *名称* | *数据类型* | *说明* |
|-------------------|-------------------------------------------------------------|------------|
-| dataSources (+) | Collection\<ReadwriteSplittingDataSourceRuleConfiguration\> | 读写数据源配置 |
+| dataSourceGroups (+) | Collection\<ReadwriteSplittingDataSourceGroupRuleConfiguration\> | 读写数据源组配置 |
| loadBalancers (*) | Map\<String, AlgorithmConfiguration\> | 从库负载均衡算法配置 |
## 主从数据源配置
@@ -46,7 +46,7 @@ Java API 形式配置的读写分离可以方便的适用于各种场景，不
```java
public DataSource getDataSource() throws SQLException {
- ReadwriteSplittingDataSourceRuleConfiguration dataSourceConfig = new ReadwriteSplittingDataSourceRuleConfiguration(
+ ReadwriteSplittingDataSourceGroupRuleConfiguration dataSourceConfig = new ReadwriteSplittingDataSourceGroupRuleConfiguration(
"demo_read_query_ds", "demo_write_ds", Arrays.asList("demo_read_ds_0", "demo_read_ds_1"), "demo_weight_lb");
Properties algorithmProps = new Properties();
algorithmProps.setProperty("demo_read_ds_0", "2");
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.en.md
index 9b7e6d64849..adc8e665574 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.en.md
@@ -17,7 +17,7 @@ Configurable Properties:
| *Name* | *DataType* | *Description* |
|-------------------|-------------------------------------------------------------|------------------------------------------------------------------------|
-| dataSources (+) | Collection\<ReadwriteSplittingDataSourceRuleConfiguration\> | Data sources of write and reads |
+| dataSourceGroups (+) | Collection\<ReadwriteSplittingDataSourceGroupRuleConfiguration\> | Data source groups of write and reads |
| loadBalancers (*) | Map\<String, AlgorithmConfiguration\> | Load balance algorithm name and configurations of replica data sources |
### Primary-secondary Data Source Configuration
@@ -46,7 +46,7 @@ Please refer to [Built-in Load Balance Algorithm List](/en/user-manual/common-co
```java
public DataSource getDataSource() throws SQLException {
- ReadwriteSplittingDataSourceRuleConfiguration dataSourceConfig = new ReadwriteSplittingDataSourceRuleConfiguration(
+ ReadwriteSplittingDataSourceGroupRuleConfiguration dataSourceConfig = new ReadwriteSplittingDataSourceGroupRuleConfiguration(
"demo_read_query_ds", "demo_write_ds", Arrays.asList("demo_read_ds_0", "demo_read_ds_1"), "demo_weight_lb");
Properties algorithmProps = new Properties();
algorithmProps.setProperty("demo_read_ds_0", "2");
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding-cache.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding-cache.cn.md
deleted file mode 100644
index c17d328bc18..00000000000
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding-cache.cn.md
+++ /dev/null
@@ -1,87 +0,0 @@
-+++
-title = "数据分片路由缓存"
-weight = 11
-+++
-
-## 背景信息
-
-该项功能为**实验性功能**，需要与数据分片功能同时使用。
-数据分片路由缓存会将逻辑 SQL、分片键实际参数值、路由结果放入缓存中，以空间换时间，减少路由逻辑对 CPU 的使用。
-
-建议仅在满足以下条件的情况下启用：
-- 纯 OLTP 场景
-- ShardingSphere 进程所在机器 CPU 已达到瓶颈
-- CPU 开销主要在于 ShardingSphere 路由逻辑
-- 所有 SQL 已经最优且每次 SQL 执行都能命中单一分片
-
-在不满足以上条件的情况下使用，可能对 SQL 的执行延时不会有明显改善，同时会增加内存的压力。
-
-## 参数解释
-
-类名称：org.apache.shardingsphere.sharding.api.config.cache.ShardingCacheConfiguration
-
-可配置属性：
-
-| *名称* | *数据类型* | *说明* | *默认值* |
-|-----------------------|------------------------------------------------------|----------------|-------|
-| allowedMaxSqlLength | int | 允许缓存的 SQL 长度限制 | - |
-| routeCache | org.apache.shardingsphere.sharding.api.config.cache.ShardingCacheOptionsConfiguration | 路由缓存 | - |
-
-类名称：org.apache.shardingsphere.sharding.api.config.cache.ShardingCacheOptionsConfiguration
-
-可配置属性：
-
-| *名称* | *数据类型* | *说明* | *默认值* |
-|-----------------------|------------------------------------------------------|----------------|-------|
-| softValues | boolean | 是否软引用缓存值 | - |
-| initialCapacity | int | 缓存初始容量 | - |
-| maximumSize | int | 缓存最大容量 | - |
-
-## 配置示例
-
-```java
-public final class ShardingDatabasesAndTablesConfigurationPrecise {
-
- @Override
- public DataSource getDataSource() throws SQLException {
- return ShardingSphereDataSourceFactory.createDataSource(createDataSourceMap(), Arrays.asList(createShardingRuleConfiguration(), createBroadcastRuleConfiguration()), new Properties());
- }
-
- private ShardingRuleConfiguration createShardingRuleConfiguration() {
- ShardingRuleConfiguration result = new ShardingRuleConfiguration();
- result.getTables().add(getOrderTableRuleConfiguration());
- result.getTables().add(getOrderItemTableRuleConfiguration());
- result.getKeyGenerateStrategies().put("t_order_order_id", new ColumnKeyGenerateStrategiesRuleConfiguration("snowflake", "t_order", "order_id"));
- result.getKeyGenerateStrategies().put("t_order_item_order_item_id", new ColumnKeyGenerateStrategiesRuleConfiguration("snowflake", "t_order_item", "order_item_id"));
- // ...
- result.setShardingCache(new ShardingCacheConfiguration(512, new ShardingCacheOptionsConfiguration(true, 65536, 262144)));
- return result;
- }
-
- private ShardingTableRuleConfiguration getOrderTableRuleConfiguration() {
- ShardingTableRuleConfiguration result = new ShardingTableRuleConfiguration("t_order", "demo_ds_${0..1}.t_order_${[0, 1]}");
- result.setAuditStrategy(new ShardingAuditStrategyConfiguration(Collections.singleton("sharding_key_required_auditor"), true));
- return result;
- }
-
- private ShardingTableRuleConfiguration getOrderItemTableRuleConfiguration() {
- ShardingTableRuleConfiguration result = new ShardingTableRuleConfiguration("t_order_item", "demo_ds_${0..1}.t_order_item_${[0, 1]}");
- return result;
- }
-
- private Map<String, DataSource> createDataSourceMap() {
- Map<String, DataSource> result = new HashMap<>();
- result.put("demo_ds_0", DataSourceUtil.createDataSource("demo_ds_0"));
- result.put("demo_ds_1", DataSourceUtil.createDataSource("demo_ds_1"));
- return result;
- }
-
- private BroadcastRuleConfiguration createBroadcastRuleConfiguration() {
- return new BroadcastRuleConfiguration(Collections.singletonList("t_address"));
- }
-}
-```
-
-## 相关参考
-
-- [核心特性：数据分片](/cn/features/sharding/)
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding-cache.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding-cache.en.md
deleted file mode 100644
index a2203efd47b..00000000000
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding-cache.en.md
+++ /dev/null
@@ -1,87 +0,0 @@
-+++
-title = "Cache for Sharding Route"
-weight = 11
-+++
-
-## Background
-
-This feature is **experimental** and needs to be used with the data sharding rule.
-The cache for sharding route will put the logical SQL, the parameter value of the shard key, and the routing result into the cache, exchange space for time, and reduce CPU usage of the routing logic.
-
-We recommend enabling it only if the following conditions are met:
-- Pure OLTP scenarios.
-- The CPU of the machine which deployed the ShardingSphere process has reached the bottleneck.
-- Most of the CPUs are used by ShardingSphere routing logic.
-- All SQLs are optimized and each SQL execution could be routed to a single data node.
-
-If the above conditions are not met, the execution delay of SQL may not be significantly improved, and the memory pressure will be increased.
-
-## Parameters
-
-Class：org.apache.shardingsphere.sharding.api.config.cache.ShardingCacheConfiguration
-
-Attributes：
-
-| *name* | *DataType* | *Description* | *Default Value* |
-|-----------------------|------------------------------------------------------|----------------|-------|
-| allowedMaxSqlLength | int | Maximum SQL length allowed for route cache | - |
-| routeCache | org.apache.shardingsphere.sharding.api.config.cache.ShardingCacheOptionsConfiguration | Route cache options | - |
-
-Class：org.apache.shardingsphere.sharding.api.config.cache.ShardingCacheOptionsConfiguration
-
-Attributes：
-
-| *name* | *DataType* | *Description* | *Default Value* |
-|-----------------------|------------------------------------------------------|----------------|-------|
-| softValues | boolean | Whether to use soft references for cached values | - |
-| initialCapacity | int | Initial cache capacity | - |
-| maximumSize | int | Maximum cache size | - |
-
-## Sample
-
-```java
-public final class ShardingDatabasesAndTablesConfigurationPrecise {
-
- @Override
- public DataSource getDataSource() throws SQLException {
- return ShardingSphereDataSourceFactory.createDataSource(createDataSourceMap(), Arrays.asList(createShardingRuleConfiguration(), createBroadcastRuleConfiguration()), new Properties());
- }
-
- private ShardingRuleConfiguration createShardingRuleConfiguration() {
- ShardingRuleConfiguration result = new ShardingRuleConfiguration();
- result.getTables().add(getOrderTableRuleConfiguration());
- result.getTables().add(getOrderItemTableRuleConfiguration());
- result.getKeyGenerateStrategies().put("t_order_order_id", new ColumnKeyGenerateStrategiesRuleConfiguration("snowflake", "t_order", "order_id"));
- result.getKeyGenerateStrategies().put("t_order_item_order_item_id", new ColumnKeyGenerateStrategiesRuleConfiguration("snowflake", "t_order_item", "order_item_id"));
- // ...
- result.setShardingCache(new ShardingCacheConfiguration(512, new ShardingCacheOptionsConfiguration(true, 65536, 262144)));
- return result;
- }
-
- private ShardingTableRuleConfiguration getOrderTableRuleConfiguration() {
- ShardingTableRuleConfiguration result = new ShardingTableRuleConfiguration("t_order", "demo_ds_${0..1}.t_order_${[0, 1]}");
- result.setAuditStrategy(new ShardingAuditStrategyConfiguration(Collections.singleton("sharding_key_required_auditor"), true));
- return result;
- }
-
- private ShardingTableRuleConfiguration getOrderItemTableRuleConfiguration() {
- ShardingTableRuleConfiguration result = new ShardingTableRuleConfiguration("t_order_item", "demo_ds_${0..1}.t_order_item_${[0, 1]}");
- return result;
- }
-
- private Map<String, DataSource> createDataSourceMap() {
- Map<String, DataSource> result = new HashMap<>();
- result.put("demo_ds_0", DataSourceUtil.createDataSource("demo_ds_0"));
- result.put("demo_ds_1", DataSourceUtil.createDataSource("demo_ds_1"));
- return result;
- }
-
- private BroadcastRuleConfiguration createBroadcastRuleConfiguration() {
- return new BroadcastRuleConfiguration(Collections.singletonList("t_address"));
- }
-}
-```
-
-## Related References
-
-- [Core Feature: Data Sharding](/en/features/sharding/)
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sql-translator.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sql-translator.cn.md
index a0bd3fabb9b..66fb11b8a55 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sql-translator.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sql-translator.cn.md
@@ -16,18 +16,19 @@ weight = 9
| *名称* | *数据类型* | *说明* |
|-----------------------------------------|---------|-------------------------|
| type | String | SQL 翻译器类型 |
+| props | Properties | SQL 翻译器属性 |
| useOriginalSQLWhenTranslatingFailed (?) | boolean | SQL 翻译失败是否使用原始 SQL 继续执行 |
## 操作步骤
1. 配置翻译类型 type
-2. 配置 useOriginalSQLWhenTranslatingFailed 参数，是否在 SQL 翻译失败后使用原始 SQL 继续执行
+2. 配置 SQL 翻译器属性。
+3. 配置 useOriginalSQLWhenTranslatingFailed 参数，是否在 SQL 翻译失败后使用原始 SQL 继续执行。
## 配置示例
```java
SQLTranslatorRuleConfiguration ruleConfig = new SQLTranslatorRuleConfiguration("Native", new Properties(), false);
-String translatedSQL = new SQLTranslatorRule(ruleConfig).translate();
```
## 相关参考
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sql-translator.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sql-translator.en.md
index 8073e200385..13452d8eb1f 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sql-translator.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sql-translator.en.md
@@ -16,18 +16,19 @@ Attributes:
| *name* | *DataType* | *Description* |
|-----------------------------------------|------------|--------------------------------------------------|
| type | String | SQL translator type |
+| props | Properties | SQL translator properties |
| useOriginalSQLWhenTranslatingFailed (?) | boolean | Whether use original SQL when translating failed |
## Procedure
1. Set SQL translator type.
-2. Set useOriginalSQLWhenTranslatingFailed to decide whether use original SQL when translating failed.
+2. Set SQL translator properties.
+3. Set useOriginalSQLWhenTranslatingFailed to decide whether use original SQL when translating failed.
## Sample
```java
SQLTranslatorRuleConfiguration ruleConfig = new SQLTranslatorRuleConfiguration("Native", new Properties(), false);
-String translatedSQL = new SQLTranslatorRule(ruleConfig).translate();
```
## Related References
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/algorithm.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/algorithm.en.md
index 0045734ae13..1e35448309b 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/algorithm.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/algorithm.en.md
@@ -50,16 +50,6 @@ shadowAlgorithms:
xxx: xxx
```
-## High Availability
-
-```yaml
-discoveryTypes:
- # discoveryTypeName is specified by users, and its property has to be consistent with that of discoveryTypeName in the database discovery rules.
- type: xxx
- props:
- xxx: xxx
-```
-
## Data Masking
```yaml
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/data-source.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/data-source.cn.md
index c33e62a3050..82261576054 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/data-source.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/data-source.cn.md
@@ -8,7 +8,7 @@ chapter = true
ShardingSphere-JDBC 支持所有的数据库 JDBC 驱动和连接池。
-示例的数据库驱动为 MySQL，连接池为 HikariCP，可以更换为其他数据库驱动和连接池。当使用 ShardingSphere-JDBC 时，JDBC 池的属性名取决于各自 JDBC 池自己的定义，并不由 ShardingSphere 定义，相关的处理可以参考类`org.apache.shardingsphere.infra.datasource.pool.creator.DataSourcePoolCreator`。例如对于 Alibaba Druid 1.2.9 而言，使用 `url` 代替如下示例中的 `standardJdbcUrl` 是预期行为。
+示例的数据库驱动为 MySQL，连接池为 HikariCP，可以更换为其他数据库驱动和连接池。当使用 ShardingSphere-JDBC 时，JDBC 池的属性名取决于各自 JDBC 池自己的定义，并不由 ShardingSphere 定义，相关的处理可以参考类`org.apache.shardingsphere.infra.datasource.pool.creator.DataSourcePoolCreator`。例如对于 Alibaba Druid 1.2.9 而言，使用 `url` 代替如下示例中的 `jdbcUrl` 是预期行为。
## 参数解释
@@ -17,7 +17,7 @@ dataSources: # 数据源配置，可配置多个 <data-source-name>
<data_source_name>: # 数据源名称
dataSourceClassName: # 数据源完整类名
driverClassName: # 数据库驱动类名，以数据库连接池自身配置为准
- standardJdbcUrl: # 数据库 URL 连接，以数据库连接池自身配置为准
+ jdbcUrl: # 数据库 URL 连接，以数据库连接池自身配置为准
username: # 数据库用户名，以数据库连接池自身配置为准
password: # 数据库密码，以数据库连接池自身配置为准
# ... 数据库连接池的其它属性
@@ -28,14 +28,14 @@ dataSources: # 数据源配置，可配置多个 <data-source-name>
dataSources:
ds_1:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/ds_1
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/ds_1
username: root
password:
ds_2:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/ds_2
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/ds_2
username: root
password:
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/data-source.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/data-source.en.md
index 6e69a0bbc6b..44e57744f6e 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/data-source.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/data-source.en.md
@@ -10,7 +10,7 @@ ShardingSphere-JDBC Supports all JDBC drivers and data source connection pools.
In this example, the database driver is MySQL, and the connection pool is HikariCP, which can be replaced with other database drivers and connection pools.
When using ShardingSphere JDBC, the property name of the JDBC pool depends on the definition of the respective JDBC pool and is not defined by ShardingSphere. For related processing, please refer to the class `org.apache.shardingsphere.infra.datasource.pool.creator.DataSourcePoolCreator`.
-For example, with Alibaba Druid 1.2.9, using url instead of standardJdbcUrl in the example below is the expected behavior.
+For example, with Alibaba Druid 1.2.9, using url instead of jdbcUrl in the example below is the expected behavior.
## Parameters
@@ -19,7 +19,7 @@ dataSources: # Data sources configuration, multiple <data-source-name> available
<data_source_name>: # Data source name
dataSourceClassName: # Data source class name
driverClassName: # The database driver class name is subject to the configuration of the data source connection pool itself
- standardJdbcUrl: # The database URL connection is subject to the configuration of the data source connection pool itself
+ jdbcUrl: # The database URL connection is subject to the configuration of the data source connection pool itself
username: # Database username, subject to the configuration of the data source connection pool itself
password: # The database password is subject to the configuration of the data source connection pool itself
# ... Other properties of data source pool
@@ -30,14 +30,14 @@ dataSources: # Data sources configuration, multiple <data-source-name> available
dataSources:
ds_1:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/ds_1
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/ds_1
username: root
password:
ds_2:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/ds_2
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/ds_2
username: root
password:
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.cn.md
index 9f8db25f3dc..5c11c0148bc 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.cn.md
@@ -28,14 +28,14 @@ rules:
dataSources:
ds_0:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds_0?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds_0?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
username: root
password:
ds_1:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds_1?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds_1?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
username: root
password:
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.en.md
index 8f5c11d166e..db48c10c4bd 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.en.md
@@ -30,14 +30,14 @@ The YAML configuration sample of the broadcast table is as follows:
dataSources:
ds_0:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds_0?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds_0?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
username: root
password:
ds_1:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds_1?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds_1?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
username: root
password:
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.cn.md
index c9e03dcd70a..da587983265 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.cn.md
@@ -49,8 +49,8 @@ rules:
dataSources:
unique_ds:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
username: root
password:
@@ -66,9 +66,6 @@ rules:
assistedQuery:
name: assisted_query_username
encryptorName: assisted_encryptor
- likeQuery:
- name: like_query_username
- encryptorName: like_encryptor
pwd:
cipher:
name: pwd
@@ -84,8 +81,6 @@ rules:
digest-algorithm-name: SHA-1
assisted_encryptor:
type: MD5
- like_encryptor:
- type: CHAR_DIGEST_LIKE
```
然后通过 YamlShardingSphereDataSourceFactory 的 createDataSource 方法创建数据源。
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.en.md
index 1cabe06ba51..fbbae372363 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.en.md
@@ -50,8 +50,8 @@ The data encryption YAML configurations are as follows:
dataSources:
unique_ds:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
username: root
password:
@@ -67,9 +67,6 @@ rules:
assistedQuery:
name: assisted_query_username
encryptorName: assisted_encryptor
- likeQuery:
- name: like_query_username
- encryptorName: like_encryptor
pwd:
cipher:
name: pwd
@@ -85,8 +82,6 @@ rules:
digest-algorithm-name: SHA-1
assisted_encryptor:
type: MD5
- like_encryptor:
- type: CHAR_DIGEST_LIKE
```
Read the YAML configuration to create a data source according to the createDataSource method of YamlShardingSphereDataSourceFactory.
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.cn.md
index f15b1001d3b..d64f4c81340 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.cn.md
@@ -41,8 +41,8 @@ rules:
dataSources:
unique_ds:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
username: root
password:
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.en.md
index 6d5e8896ed9..eff920ba6ca 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.en.md
@@ -42,8 +42,8 @@ The data masking YAML configurations are as follows:
dataSources:
unique_ds:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
username: root
password:
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.cn.md
index 69b77d58495..8d2a7ceb42b 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.cn.md
@@ -112,8 +112,6 @@ rules:
digest-algorithm-name: SHA-1
assisted_encryptor:
type: MD5
- like_encryptor:
- type: CHAR_DIGEST_LIKE
tables:
t_encrypt:
columns:
@@ -124,9 +122,6 @@ rules:
assistedQuery:
name: assisted_query_user
encryptorName: assisted_encryptor
- likeQuery:
- name: like_query_user
- encryptorName: like_encryptor
order_id:
cipher:
name: order_cipher
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.en.md
index 3f80a57f14a..4bd3f66d28e 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.en.md
@@ -113,8 +113,6 @@ rules:
digest-algorithm-name: SHA-1
assisted_encryptor:
type: MD5
- like_encryptor:
- type: CHAR_DIGEST_LIKE
tables:
t_encrypt:
columns:
@@ -125,9 +123,6 @@ rules:
assistedQuery:
name: assisted_query_user
encryptorName: assisted_encryptor
- likeQuery:
- name: like_query_user
- encryptorName: like_encryptor
order_id:
cipher:
name: order_cipher
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.cn.md
index 6c0b87514dd..802af38ac18 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.cn.md
@@ -16,8 +16,8 @@ rules:
- !READWRITE_SPLITTING
dataSourceGroups:
<data_source_name> (+): # 读写分离逻辑数据源名称，默认使用 Groovy 的行表达式 SPI 实现来解析
- write_data_source_name: # 写库数据源名称，默认使用 Groovy 的行表达式 SPI 实现来解析
- read_data_source_names: # 读库数据源名称，多个从数据源用逗号分隔，默认使用 Groovy 的行表达式 SPI 实现来解析
+ writeDataSourceName: # 写库数据源名称，默认使用 Groovy 的行表达式 SPI 实现来解析
+ readDataSourceNames: # 读库数据源名称，多个从数据源用逗号分隔，默认使用 Groovy 的行表达式 SPI 实现来解析
transactionalReadQueryStrategy (?): # 事务内读请求的路由策略，可选值：PRIMARY（路由至主库）、FIXED（同一事务内路由至固定数据源）、DYNAMIC（同一事务内路由至非固定数据源）。默认值：PRIMARY，**注意：`FIXED` 和 `DYNAMIC` 需要数据库支持主从强一致同步能力才能使用，例如：openGauss。**
loadBalancerName: # 负载均衡算法名称
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.en.md
index 28738792d8f..61300aa1d20 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.en.md
@@ -15,8 +15,8 @@ rules:
- !READWRITE_SPLITTING
dataSourceGroups:
<data_source_group_name> (+): # Logic data source group name of readwrite-splitting, which uses Groovy's Row Value Expressions SPI implementation to parse by default
- write_data_source_name: # Write data source name, which uses Groovy's Row Value Expressions SPI implementation to parse by default
- read_data_source_names: # Read data source names, multiple data source names separated with comma, which uses Groovy's Row Value Expressions SPI implementation to parse by default
+ writeDataSourceName: # Write data source name, which uses Groovy's Row Value Expressions SPI implementation to parse by default
+ readDataSourceNames: # Read data source names, multiple data source names separated with comma, which uses Groovy's Row Value Expressions SPI implementation to parse by default
transactionalReadQueryStrategy (?): # Routing strategy for read query within a transaction, values include: PRIMARY (to primary), FIXED (to fixed data source), DYNAMIC (to any data source), default value: PRIMARY, **Note: `FIXED` and `DYNAMIC` require a database that supports strong primary-replica synchronization, such as openGauss.**
loadBalancerName: # Load balance algorithm name
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.cn.md
deleted file mode 100644
index d8522840077..00000000000
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.cn.md
+++ /dev/null
@@ -1,37 +0,0 @@
-+++
-title = "数据分片路由缓存"
-weight = 11
-+++
-
-## 背景信息
-
-该项功能为**实验性功能**，需要与数据分片功能同时使用。
-数据分片路由缓存会将逻辑 SQL、分片键实际参数值、路由结果放入缓存中，以空间换时间，减少路由逻辑对 CPU 的使用。
-
-建议仅在满足以下条件的情况下启用：
-- 纯 OLTP 场景
-- ShardingSphere 进程所在机器 CPU 已达到瓶颈
-- CPU 开销主要在于 ShardingSphere 路由逻辑
-- 所有 SQL 已经最优且每次 SQL 执行都能命中单一分片
-
-在不满足以上条件的情况下使用，可能对 SQL 的执行延时不会有明显改善，同时会增加内存的压力。
-
-## 参数解释
-
-```yaml
-rules:
-- !SHARDING
- tables:
- shardingAlgorithms:
- # ...
- shardingCache:
- allowedMaxSqlLength: 512 # 允许缓存的 SQL 长度限制
- routeCache:
- initialCapacity: 65536 # 缓存初始容量
- maximumSize: 262144 # 缓存最大容量
- softValues: true # 是否软引用缓存值
-```
-
-## 相关参考
-
-- [核心特性：数据分片](/cn/features/sharding/)
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.en.md
deleted file mode 100644
index 98a906ae0de..00000000000
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.en.md
+++ /dev/null
@@ -1,37 +0,0 @@
-+++
-title = "Cache for Sharding Route"
-weight = 11
-+++
-
-## Background
-
-This feature is **experimental** and needs to be used with the data sharding rule.
-The cache for sharding route will put the logical SQL, the parameter value of the shard key, and the routing result into the cache, exchange space for time, and reduce CPU usage of the routing logic.
-
-We recommend enabling it only if the following conditions are met:
-- Pure OLTP scenarios.
-- The CPU of the machine which deployed the ShardingSphere process has reached the bottleneck.
-- Most of the CPUs are used by ShardingSphere routing logic.
-- All SQLs are optimized and each SQL execution could be routed to a single data node.
-
-If the above conditions are not met, the execution delay of SQL may not be significantly improved, and the memory pressure will be increased.
-
-## Parameters
-
-```yaml
-rules:
-- !SHARDING
- tables:
- shardingAlgorithms:
- # ...
- shardingCache:
- allowedMaxSqlLength: 512 # Allow cached SQL length limit
- routeCache:
- initialCapacity: 65536 # Initial capacity
- maximumSize: 262144 # Maximum capacity
- softValues: true # Whether to use soft references
-```
-
-## Related References
-
-- [Core Feature: Data Sharding](/en/features/sharding/)
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.cn.md
index b902925fdce..df36fec2a60 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.cn.md
@@ -92,14 +92,14 @@ rules:
dataSources:
ds_0:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds_0?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds_0?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
username: root
password:
ds_1:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds_1?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds_1?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
username: root
password:
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.en.md
index 1ea2eaaaf59..72820d042ed 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.en.md
@@ -93,14 +93,14 @@ The YAML configuration sample of data sharding is as follows:
dataSources:
ds_0:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds_0?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds_0?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
username: root
password:
ds_1:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
- driverClassName: com.mysql.jdbc.Driver
- standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds_1?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ driverClassName: com.mysql.cj.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds_1?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
username: root
password:
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/cdc/build.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/cdc/build.cn.md
index 6ac4b7a95b0..405eadd2bec 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/cdc/build.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/cdc/build.cn.md
@@ -211,7 +211,7 @@ CDC Client 不需要额外部署，只需要通过 maven 引入 CDC Client 的
| 方法名 | 返回值 | 说明 |
|-----------------------------------------------------------------------------------------------------------------------------|-------------|--------------------------------------------------------------------------------------------------------------|
-| connect(Consumer<List<Record>> dataConsumer, ExceptionHandler exceptionHandler, ServerErrorResultHandler errorResultHandler | void | 和服务端进行连接，连接的时候需要指定 <br/>1. 数据的消费处理逻辑 <br/>2. 消费时候的异常处理逻辑 <br/>3. 服务端错误的异常处理逻辑 |
+| connect(Consumer<List<Record>> dataConsumer, ExceptionHandler exceptionHandler, ServerErrorResultHandler errorResultHandler) | void | 和服务端进行连接，连接的时候需要指定 <br/>1. 数据的消费处理逻辑 <br/>2. 消费时候的异常处理逻辑 <br/>3. 服务端错误的异常处理逻辑 |
| login(CDCLoginParameter parameter) | void | CDC登陆，参数 <br/>username：用户名 <br/>password：密码 |
| startStreaming(StartStreamingParameter parameter) | streamingId | 开启 CDC 订阅 <br/> StartStreamingParameter 参数 <br/> database：逻辑库名称 <br/> schemaTables：订阅的表名 <br/> full：是否订阅全量数据 |
| restartStreaming(String streamingId) | void | 重启订阅 |
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/cdc/build.en.md b/docs/document/content/user-manual/shardingsphere-proxy/cdc/build.en.md
index 2021ab3b1dc..0df9b342fe7 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/cdc/build.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/cdc/build.en.md
@@ -210,7 +210,7 @@ If necessary, users can also implement a CDC Client themselves to consume data a
| Method Name | Return Value | Description |
|-----------------------------------------------------------------------------------------------------------------------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| connect(Consumer<List<Record>> dataConsumer, ExceptionHandler exceptionHandler, ServerErrorResultHandler errorResultHandler | void | Connect with the server, when connecting, you need to specify <br/>1. Data consumption processing function <br/>2. Exception handling logic during consumption <br/>3. Server error exception handling function |
+| connect(Consumer<List<Record>> dataConsumer, ExceptionHandler exceptionHandler, ServerErrorResultHandler errorResultHandler) | void | Connect with the server, when connecting, you need to specify <br/>1. Data consumption processing function <br/>2. Exception handling logic during consumption <br/>3. Server error exception handling function |
| login(CDCLoginParameter parameter) | void | CDC login, parameters <br/>username: username <br/>password: password |
| startStreaming(StartStreamingParameter parameter) | streamingId | Start CDC subscription<br/> StartStreamingParameter parameters <br/> database: logical database name <br/> schemaTables: subscribed table name <br/> full: whether to subscribe to full data |
| restartStreaming(String streamingId) | void | Restart subscription |
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.cn.md
index 6be372efcc9..5de68e93788 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.cn.md
@@ -13,9 +13,9 @@ weight = 1
{{% tab name="语法" %}}
```sql
AlterReadwriteSplittingRule ::=
- 'ALTER' 'READWRITE_SPLITTING' 'RULE' groupName ('ENABLE' | 'DISABLE') storageUnitName 'FROM' databaseName
+ 'ALTER' 'READWRITE_SPLITTING' 'RULE' ruleName ('ENABLE' | 'DISABLE') storageUnitName ('FROM' databaseName)?
-groupName ::=
+ruleName ::=
identifier
storageUnitName ::=
@@ -62,7 +62,7 @@ ALTER READWRITE_SPLITTING RULE ms_group_1 ENABLE read_ds_0;
### 保留字
-`ALTER`、`READWRITE_SPLITTING`、`RULE`、`ENABLE`、`DISABLE`
+`ALTER`、`READWRITE_SPLITTING`、`RULE`、`ENABLE`、`DISABLE`、`FROM`
### 相关链接
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.en.md
index b61db54f99d..40037fba371 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/circuit-breaker/alter-readwrite-splitting-rule-enable-disable.en.md
@@ -13,9 +13,9 @@ The `ALTER READWRITE_SPLITTING RULE ENABLE/DISABLE` syntax is used enable/disabl
{{% tab name="Grammar" %}}
```sql
AlterReadwriteSplittingRule ::=
- 'ALTER' 'READWRITE_SPLITTING' 'RULE' groupName ('ENABLE' | 'DISABLE') storageUnitName 'FROM' databaseName
+ 'ALTER' 'READWRITE_SPLITTING' 'RULE' ruleName ('ENABLE' | 'DISABLE') storageUnitName ('FROM' databaseName)?
-groupName ::=
+ruleName ::=
identifier
storageUnitName ::=
@@ -62,7 +62,7 @@ ALTER READWRITE_SPLITTING RULE ms_group_1 ENABLE read_ds_0;
### Reserved word
-`ALTER`, `READWRITE_SPLITTING`, `RULE`, `ENABLE`, `DISABLE`
+`ALTER`, `READWRITE_SPLITTING`, `RULE`, `ENABLE`, `DISABLE`, `FROM`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/global-rule/alter-traffic-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/global-rule/alter-traffic-rule.cn.md
deleted file mode 100644
index 7d653df1343..00000000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/global-rule/alter-traffic-rule.cn.md
+++ /dev/null
@@ -1,71 +0,0 @@
-+++
-title = "ALTER TRAFFIC RULE"
-weight = 7
-+++
-
-## 描述
-
-`ALTER TRAFFIC RULE` 语法用于修改双路由规则。
-
-### 语法定义
-
-{{< tabs >}}
-{{% tab name="语法" %}}
-```sql
-AlterTrafficRule ::=
- 'ALTER' 'TRAFFIC' 'RULE' '(' 'LABELS' '(' lableName ')' ',' trafficAlgorithmDefinition ',' loadBalancerDefinition ')'
-
-lableName ::=
- identifier
-
-trafficAlgorithmDefinition ::=
- 'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' trafficAlgorithmTypeName (',' propertiesDefinition)? ')' ')'
-
-loadBalancerDefinition ::=
- 'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' '=' loadBalancerName (',' propertiesDefinition)? ')' ')'
-
-propertiesDefinition ::=
- 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'
-
-trafficAlgorithmTypeName ::=
- string
-
-loadBalancerTypeName ::=
- string
-
-key ::=
- string
-
-value ::=
- literal
-```
-{{% /tab %}}
-{{% tab name="铁路图" %}}
-<iframe frameborder="0" name="diagram" id="diagram" width="100%" height="100%"></iframe>
-{{% /tab %}}
-{{< /tabs >}}
-
-### 补充说明
-
-- `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/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/global-rule/alter-traffic-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/global-rule/alter-traffic-rule.en.md
deleted file mode 100644
index 5d10d420988..00000000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/global-rule/alter-traffic-rule.en.md
+++ /dev/null
@@ -1,71 +0,0 @@
-+++
-title = "ALTER TRAFFIC RULE"
-weight = 7
-+++
-
-### Description
-
-The `ALTER TRAFFIC RULE` syntax is used to alter dual routing rule.
-
-### Syntax
-
-{{< tabs >}}
-{{% tab name="Grammar" %}}
-```sql
-AlterTrafficRule ::=
- 'ALTER' 'TRAFFIC' 'RULE' '(' 'LABELS' '(' lableName ')' ',' trafficAlgorithmDefinition ',' loadBalancerDefinition ')'
-
-lableName ::=
- identifier
-
-trafficAlgorithmDefinition ::=
- 'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' trafficAlgorithmTypeName (',' propertiesDefinition)? ')' ')'
-
-loadBalancerDefinition ::=
- 'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' '=' loadBalancerName (',' propertiesDefinition)? ')' ')'
-
-propertiesDefinition ::=
- 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'
-
-trafficAlgorithmTypeName ::=
- string
-
-loadBalancerTypeName ::=
- string
-
-key ::=
- string
-
-value ::=
- literal
-```
-{{% /tab %}}
-{{% tab name="Railroad diagram" %}}
-<iframe frameborder="0" name="diagram" id="diagram" width="100%" height="100%"></iframe>
-{{% /tab %}}
-{{< /tabs >}}
-
-### 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/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/global-rule/show-traffic-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/global-rule/show-traffic-rule.cn.md
deleted file mode 100644
index 0361e1c5b1e..00000000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/global-rule/show-traffic-rule.cn.md
+++ /dev/null
@@ -1,81 +0,0 @@
-+++
-title = "SHOW TRAFFIC RULE"
-weight = 6
-+++
-
-### 描述
-
-`SHOW TRAFFIC RULE` 语法用于查询指定的双路由规则。
-### 语法
-
-{{< tabs >}}
-{{% tab name="语法" %}}
-```sql
-ShowTrafficRule ::=
- 'SHOW' 'TRAFFIC' ('RULES' | 'RULE' ruleName)?
-
-ruleName ::=
- identifier
-```
-{{% /tab %}}
-{{% tab name="铁路图" %}}
-<iframe frameborder="0" name="diagram" id="diagram" width="100%" height="100%"></iframe>
-{{% /tab %}}
-{{< /tabs >}}
-
-### 补充说明
-
-- 未指定 `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/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/global-rule/show-traffic-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/global-rule/show-traffic-rule.en.md
deleted file mode 100644
index d0e09a562b5..00000000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/global-rule/show-traffic-rule.en.md
+++ /dev/null
@@ -1,82 +0,0 @@
-+++
-title = "SHOW TRAFFIC RULE"
-weight = 6
-+++
-
-### Description
-
-The `SHOW TRAFFIC RULE` syntax is used to query specified dual routing rule.
-
-### Syntax
-
-{{< tabs >}}
-{{% tab name="Grammar" %}}
-```sql
-ShowTrafficRule ::=
- 'SHOW' 'TRAFFIC' ('RULES' | 'RULE' ruleName)?
-
-ruleName ::=
- identifier
-```
-{{% /tab %}}
-{{% tab name="Railroad diagram" %}}
-<iframe frameborder="0" name="diagram" id="diagram" width="100%" height="100%"></iframe>
-{{% /tab %}}
-{{< /tabs >}}
-
-### Supplement
-
-- When `ruleName` not specified, the default is show all traffic rules
-
-### Return Value Description
-
-| Column | 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/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/_index.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/_index.en.md
index d86d2654994..e111093c893 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/_index.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/_index.en.md
@@ -1,5 +1,5 @@
+++
-title = "MIGRATUION"
+title = "MIGRATION"
weight = 3
chapter = true
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/alter-migration-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/alter-migration-rule.cn.md
index 60295c174b8..73945bc701b 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/alter-migration-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/alter-migration-rule.cn.md
@@ -13,13 +13,13 @@ weight = 2
{{% tab name="语法" %}}
```sql
AlterMigrationRule ::=
- 'ALTER' 'MIGRATION' 'RULE' ('(' (readConfiguration ',')? (writeConfiguration ',')? (dataChannel)? ')')?
+ 'ALTER' 'MIGRATION' 'RULE' '(' readConfiguration? (','? writeConfiguration)? (','? dataChannel)? ')'
readConfiguration ::=
'READ' '(' ('WORKER_THREAD' '=' workerThreadPoolSize ',')? ('BATCH_SIZE' '=' batchSize ',')? ('SHARDING_SIZE' '=' shardingSize ',')? (rateLimiter)? ')'
writeConfiguration ::=
- 'WRITE' '(' ('WORKER_THREAD' '=' workerThreadPoolSize ',')? ('BATCH_SIZE' '=' batchSize ',')? ('SHARDING_SIZE' '=' shardingSize ',')? (rateLimiter)? ')'
+ 'WRITE' '(' ('WORKER_THREAD' '=' workerThreadPoolSize ',')? ('BATCH_SIZE' '=' batchSize ',')? (rateLimiter)? ')'
dataChannel ::=
'STREAM_CHANNEL' '(' 'TYPE' '(' 'NAME' '=' algorithmName ',' propertiesDefinition ')' ')'
@@ -70,4 +70,4 @@ ALTER MIGRATION RULE (
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/alter-migration-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/alter-migration-rule.en.md
index 08d993a1635..d8b4b21223e 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/alter-migration-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/alter-migration-rule.en.md
@@ -13,13 +13,13 @@ The `ALTER MIGRATION RULE` syntax is used to alter migration rule.
{{% tab name="Grammar" %}}
```sql
AlterMigrationRule ::=
- 'ALTER' 'MIGRATION' 'RULE' ('(' (readConfiguration ',')? (writeConfiguration ',')? (dataChannel)? ')')?
+ 'ALTER' 'MIGRATION' 'RULE' '(' readConfiguration? (','? writeConfiguration)? (','? dataChannel)? ')'
readConfiguration ::=
'READ' '(' ('WORKER_THREAD' '=' workerThreadPoolSize ',')? ('BATCH_SIZE' '=' batchSize ',')? ('SHARDING_SIZE' '=' shardingSize ',')? (rateLimiter)? ')'
writeConfiguration ::=
- 'WRITE' '(' ('WORKER_THREAD' '=' workerThreadPoolSize ',')? ('BATCH_SIZE' '=' batchSize ',')? ('SHARDING_SIZE' '=' shardingSize ',')? (rateLimiter)? ')'
+ 'WRITE' '(' ('WORKER_THREAD' '=' workerThreadPoolSize ',')? ('BATCH_SIZE' '=' batchSize ',')? (rateLimiter)? ')'
dataChannel ::=
'STREAM_CHANNEL' '(' 'TYPE' '(' 'NAME' '=' algorithmName ',' propertiesDefinition ')' ')'
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/check-migration.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/check-migration.cn.md
index cca9e85dcdf..4b10567e76b 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/check-migration.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/check-migration.cn.md
@@ -17,7 +17,7 @@ ShowMigrationList ::=
'CHECK' 'MIGRATION' migrationJobId 'BY' 'TYPE' '(' 'NAME' '=' migrationCheckAlgorithmType ')'
migrationJobId ::=
- string
+ integer | identifier | string
migrationCheckAlgorithmType ::=
string
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/check-migration.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/check-migration.en.md
index 90d7925d9c9..df3b26a5bf8 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/check-migration.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/check-migration.en.md
@@ -16,7 +16,7 @@ ShowMigrationList ::=
'CHECK' 'MIGRATION' migrationJobId 'BY' 'TYPE' '(' 'NAME' '=' migrationCheckAlgorithmType ')'
migrationJobId ::=
- string
+ integer | identifier | string
migrationCheckAlgorithmType ::=
string
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/commit-migration.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/commit-migration.cn.md
index b81c5b31cb1..c8e8e8665af 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/commit-migration.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/commit-migration.cn.md
@@ -16,7 +16,7 @@ CommitMigration ::=
'COMMIT' 'MIGRATION' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="铁路图" %}}
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/commit-migration.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/commit-migration.en.md
index 36dac10a939..28ea0e630e1 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/commit-migration.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/commit-migration.en.md
@@ -16,7 +16,7 @@ CommitMigration ::=
'COMMIT' 'MIGRATION' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/drop-migration-check.cn.md
similarity index 59%
copy from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.cn.md
copy to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/drop-migration-check.cn.md
index 9057cdfc750..0720e5a66b0 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/drop-migration-check.cn.md
@@ -1,22 +1,22 @@
+++
-title = "STOP MIGRATION CHECK"
+title = "DROP MIGRATION CHECK"
weight = 13
+++
### 描述
-`STOP MIGRATION CHECK` 语法用于停止指定数据迁移作业的数据校验。
+`DROP MIGRATION CHECK` 语法用于删除指定迁移任务的一致性校验结果。
### 语法
{{< tabs >}}
{{% tab name="语法" %}}
```sql
-StopMigrationCheck ::=
- 'STOP' 'MIGRATION' 'CHECK' migrationJobId
+DropMigrationCheck ::=
+ 'DROP' 'MIGRATION' 'CHECK' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="铁路图" %}}
@@ -26,21 +26,21 @@ migrationJobId ::=
### 补充说明
-- `migrationJobId` 需要通过 [SHOW MIGRATION LIST](/cn/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-list/) 语法查询获得
+- `migrationJobId` 需要通过 [SHOW MIGRATION LIST](/cn/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-list/) 语法查询获得。
### 示例
-- 停止指定数据迁移作业的数据校验
+- 删除迁移一致性校验结果
```sql
-STOP MIGRATION CHECK 'j010180026753ef0e25d3932d94d1673ba551';
+DROP MIGRATION CHECK 'j010180026753ef0e25d3932d94d1673ba551';
```
### 保留字
-`STOP`、`MIGRATION`、`CHECK`
+`DROP`、`MIGRATION`、`CHECK`
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-- [SHOW MIGRATION LIST](/cn/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-list/)
\ No newline at end of file
+- [SHOW MIGRATION LIST](/cn/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-list/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/drop-migration-check.en.md
similarity index 64%
copy from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.en.md
copy to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/drop-migration-check.en.md
index 1a4be763b64..11978efbaf4 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/drop-migration-check.en.md
@@ -1,22 +1,22 @@
+++
-title = "STOP MIGRATION CHECK"
+title = "DROP MIGRATION CHECK"
weight = 13
+++
### Description
-The `STOP MIGRATION CHECK` syntax is used to stop migration check process.
+The `DROP MIGRATION CHECK` syntax is used to drop migration check results for the specified migration job.
### Syntax
{{< tabs >}}
{{% tab name="Grammar" %}}
```sql
-StopMigrationCheck ::=
- 'STOP' 'MIGRATION' 'CHECK' migrationJobId
+DropMigrationCheck ::=
+ 'DROP' 'MIGRATION' 'CHECK' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
@@ -26,19 +26,19 @@ migrationJobId ::=
### Supplement
-- `migrationJobId` needs to be obtained through [SHOW MIGRATION LIST](/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-list/) syntax query
+- `migrationJobId` needs to be obtained through [SHOW MIGRATION LIST](/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-list/).
### Example
-- Stop migration check process
+- Drop migration check results
```sql
-STOP MIGRATION CHECK 'j010180026753ef0e25d3932d94d1673ba551';
+DROP MIGRATION CHECK 'j010180026753ef0e25d3932d94d1673ba551';
```
### Reserved word
-`STOP`, `MIGRATION`, `CHECK`
+`DROP`, `MIGRATION`, `CHECK`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/register-migration-source-storage-unit.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/register-migration-source-storage-unit.cn.md
index cad13c128f6..6724065e7a1 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/register-migration-source-storage-unit.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/register-migration-source-storage-unit.cn.md
@@ -12,15 +12,30 @@ weight = 3
{{< tabs >}}
{{% tab name="语法" %}}
```sql
-RegisterStorageUnit ::=
+RegisterMigrationSourceStorageUnit ::=
'REGISTER' 'MIGRATION' 'SOURCE' 'STORAGE' 'UNIT' storageUnitDefinition (',' storageUnitDefinition)*
storageUnitDefinition ::=
- StorageUnitName '(' 'URL' '=' url ',' 'USER' '=' user (',' 'PASSWORD' '=' password)? (',' propertiesDefinition)?')'
+ storageUnitName '(' (simpleSource | urlSource) ',' 'USER' '=' user (',' 'PASSWORD' '=' password)? (',' propertiesDefinition)? ')'
storageUnitName ::=
identifier
+simpleSource ::=
+ 'HOST' '=' hostname ',' 'PORT' '=' port ',' 'DB' '=' dbName
+
+urlSource ::=
+ 'URL' '=' url
+
+hostname ::=
+ string
+
+port ::=
+ int
+
+dbName ::=
+ string
+
url ::=
string
@@ -53,7 +68,7 @@ value ::=
- `storageUnitName` 命名只允许使用字母、数字以及 `_` ，且必须以字母开头；
- `poolProperty` 用于自定义连接池参数，`key` 必须和连接池参数名一致，`value` 支持 int 和 String 类型；
- 当 `password` 包含特殊字符时，建议使用 string 形式；例如 `password@123`的 string 形式为 `"password@123"`；
-- 数据迁移源存储单元暂时仅支持使用 `URL` 注册，暂时不支持使用 `HOST` 和 `PORT`。
+- 数据迁移源存储单元支持使用 `URL` 注册，也支持使用 `HOST`、`PORT` 和 `DB` 注册。
### 示例
@@ -67,6 +82,18 @@ REGISTER MIGRATION SOURCE STORAGE UNIT ds_0 (
);
```
+- 使用主机、端口和数据库名注册数据迁移源存储单元
+
+```sql
+REGISTER MIGRATION SOURCE STORAGE UNIT ds_0 (
+ HOST="127.0.0.1",
+ PORT=3306,
+ DB="migration_ds_0",
+ USER="root",
+ PASSWORD="123456"
+);
+```
+
- 注册数据迁移源存储单元并设置连接池参数
```sql
@@ -80,8 +107,8 @@ REGISTER MIGRATION SOURCE STORAGE UNIT ds_0 (
### 保留字
-`REGISTER`、`MIGRATION`、`SOURCE`、`STORAGE`、`UNIT`、`USER`、`PASSWORD`、`PROPERTIES`、`URL`
+`REGISTER`、`MIGRATION`、`SOURCE`、`STORAGE`、`UNIT`、`USER`、`PASSWORD`、`PROPERTIES`、`URL`、`HOST`、`PORT`、`DB`
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/register-migration-source-storage-unit.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/register-migration-source-storage-unit.en.md
index 6f98912e359..7d98627474b 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/register-migration-source-storage-unit.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/register-migration-source-storage-unit.en.md
@@ -12,15 +12,30 @@ The `REGISTER MIGRATION SOURCE STORAGE UNIT` syntax is used to register migratio
{{< tabs >}}
{{% tab name="Grammar" %}}
```sql
-RegisterStorageUnit ::=
+RegisterMigrationSourceStorageUnit ::=
'REGISTER' 'MIGRATION' 'SOURCE' 'STORAGE' 'UNIT' storageUnitDefinition (',' storageUnitDefinition)*
storageUnitDefinition ::=
- StorageUnitName '(' 'URL' '=' url ',' 'USER' '=' user (',' 'PASSWORD' '=' password)? (',' propertiesDefinition)?')'
+ storageUnitName '(' (simpleSource | urlSource) ',' 'USER' '=' user (',' 'PASSWORD' '=' password)? (',' propertiesDefinition)? ')'
storageUnitName ::=
identifier
+simpleSource ::=
+ 'HOST' '=' hostname ',' 'PORT' '=' port ',' 'DB' '=' dbName
+
+urlSource ::=
+ 'URL' '=' url
+
+hostname ::=
+ string
+
+port ::=
+ int
+
+dbName ::=
+ string
+
url ::=
string
@@ -55,7 +70,7 @@ value ::=
parameter name, `value` supports int and String types;
- When `password` contains special characters, it is recommended to use the string form; For example, the string form
of `password@123` is `"password@123"`.
-- The data migration source storage unit currently only supports registration using `URL`, and temporarily does not support using `HOST` and `PORT`.
+- The migration source storage unit supports registration using either `URL`, or `HOST`, `PORT`, and `DB`.
### Example
@@ -69,6 +84,18 @@ REGISTER MIGRATION SOURCE STORAGE UNIT ds_0 (
);
```
+- Register migration source storage unit using host, port, and database name
+
+```sql
+REGISTER MIGRATION SOURCE STORAGE UNIT ds_0 (
+ HOST="127.0.0.1",
+ PORT=3306,
+ DB="migration_ds_0",
+ USER="root",
+ PASSWORD="root"
+);
+```
+
- Register migration source storage unit and set connection pool parameters
```sql
@@ -82,7 +109,7 @@ REGISTER MIGRATION SOURCE STORAGE UNIT ds_0 (
### Reserved word
-`REGISTER`, `MIGRATION`, `SOURCE`, `STORAGE`, `UNIT`, `USER`, `PASSWORD`, `PROPERTIES`, `URL`
+`REGISTER`, `MIGRATION`, `SOURCE`, `STORAGE`, `UNIT`, `USER`, `PASSWORD`, `PROPERTIES`, `URL`, `HOST`, `PORT`, `DB`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/rollback-migration.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/rollback-migration.cn.md
index 0bbb19dd927..72de3f3af71 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/rollback-migration.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/rollback-migration.cn.md
@@ -16,7 +16,7 @@ RollbackMigration ::=
'ROLLBACK' 'MIGRATION' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="铁路图" %}}
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/rollback-migration.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/rollback-migration.en.md
index 9eba1baf849..e1d9ab5f4d9 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/rollback-migration.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/rollback-migration.en.md
@@ -16,7 +16,7 @@ RollbackMigration ::=
'ROLLBACK' 'MIGRATION' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-algorithm.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-algorithm.cn.md
index fb9a27d2ffd..a5e401994fa 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-algorithm.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-algorithm.cn.md
@@ -1,17 +1,18 @@
+++
-title = "SHOW MIGRATION CHECK ALGORITHM"
+title = "SHOW MIGRATION CHECK ALGORITHMS"
weight = 9
+++
### 描述
-`SHOW MIGRATION CHECK ALGORITHM` 语法用于查询数据迁移一致性校验算法。
+`SHOW MIGRATION CHECK ALGORITHMS` 语法用于查询数据迁移一致性校验算法。
+
### 语法
{{< tabs >}}
{{% tab name="语法" %}}
```sql
-ShowMigrationCheckAlgorithm ::=
+ShowMigrationCheckAlgorithms ::=
'SHOW' 'MIGRATION' 'CHECK' 'ALGORITHMS'
```
{{% /tab %}}
@@ -20,14 +21,15 @@ ShowMigrationCheckAlgorithm ::=
{{% /tab %}}
{{< /tabs >}}
-
### 返回值说明
| 列 | 说明 |
|--------------------------|-----------|
| type | 一致性校验算法类型 |
+| type_aliases | 一致性校验算法类型别名 |
| supported_database_types | 支持数据库类型 |
| description | 说明 |
+
### 示例
- 查询数据迁移一致性校验算法
@@ -38,12 +40,12 @@ SHOW MIGRATION CHECK ALGORITHMS;
```sql
mysql> SHOW MIGRATION CHECK ALGORITHMS;
-+-------------+--------------------------------------------------------------+----------------------------+
-| type | supported_database_types | description |
-+-------------+--------------------------------------------------------------+----------------------------+
-| CRC32_MATCH | MySQL | Match CRC32 of records. |
-| DATA_MATCH | SQL92,MySQL,MariaDB,PostgreSQL,openGauss,Oracle,SQLServer,H2 | Match raw data of records. |
-+-------------+--------------------------------------------------------------+----------------------------+
++-------------+--------------+--------------------------------------------------------------+----------------------------+
+| type | type_aliases | supported_database_types | description |
++-------------+--------------+--------------------------------------------------------------+----------------------------+
+| CRC32_MATCH | | MySQL | Match CRC32 of records. |
+| DATA_MATCH | | SQL92,MySQL,MariaDB,PostgreSQL,openGauss,Oracle,SQLServer,H2 | Match raw data of records. |
++-------------+--------------+--------------------------------------------------------------+----------------------------+
2 rows in set (0.03 sec)
```
@@ -53,4 +55,4 @@ mysql> SHOW MIGRATION CHECK ALGORITHMS;
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-algorithm.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-algorithm.en.md
index 9b00f19479a..71a217bd1a0 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-algorithm.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-algorithm.en.md
@@ -1,18 +1,18 @@
+++
-title = "SHOW MIGRATION CHECK ALGORITHM"
+title = "SHOW MIGRATION CHECK ALGORITHMS"
weight = 9
+++
### Description
-The `SHOW MIGRATION RULE` syntax is used to query migration check algorithm.
+The `SHOW MIGRATION CHECK ALGORITHMS` syntax is used to query migration check algorithms.
### Syntax
{{< tabs >}}
{{% tab name="Grammar" %}}
```sql
-ShowMigrationCheckAlgorithm ::=
+ShowMigrationCheckAlgorithms ::=
'SHOW' 'MIGRATION' 'CHECK' 'ALGORITHMS'
```
{{% /tab %}}
@@ -26,6 +26,7 @@ ShowMigrationCheckAlgorithm ::=
| Column | Description |
|--------------------------|--------------------------------------------|
| type | migration check algorithm type |
+| type_aliases | migration check algorithm type aliases |
| supported_database_types | supported database type |
| description | Description of migration check algorithm |
@@ -39,12 +40,12 @@ SHOW MIGRATION CHECK ALGORITHMS;
```sql
mysql> SHOW MIGRATION CHECK ALGORITHMS;
-+-------------+--------------------------------------------------------------+----------------------------+
-| type | supported_database_types | description |
-+-------------+--------------------------------------------------------------+----------------------------+
-| CRC32_MATCH | MySQL | Match CRC32 of records. |
-| DATA_MATCH | SQL92,MySQL,MariaDB,PostgreSQL,openGauss,Oracle,SQLServer,H2 | Match raw data of records. |
-+-------------+--------------------------------------------------------------+----------------------------+
++-------------+--------------+--------------------------------------------------------------+----------------------------+
+| type | type_aliases | supported_database_types | description |
++-------------+--------------+--------------------------------------------------------------+----------------------------+
+| CRC32_MATCH | | MySQL | Match CRC32 of records. |
+| DATA_MATCH | | SQL92,MySQL,MariaDB,PostgreSQL,openGauss,Oracle,SQLServer,H2 | Match raw data of records. |
++-------------+--------------+--------------------------------------------------------------+----------------------------+
2 rows in set (0.03 sec)
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-status.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-status.cn.md
index 62fd7a599e2..256373ec668 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-status.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-status.cn.md
@@ -16,7 +16,7 @@ ShowMigrationCheckStatus ::=
'SHOW' 'MIGRATION' 'CHECK' 'STATUS' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="铁路图" %}}
@@ -30,15 +30,22 @@ migrationJobId ::=
### 返回值说明
-| 列 | 说明 |
-|---------------------|--------|
-| tables | 校验表 |
-| result | 校验结果 |
-| finished_percentage | 校验完成度 |
-| remaining_seconds | 剩余时间 |
-| check_begin_time | 校验开始时间 |
-| check_end_time | 校验结束时间 |
-| error_message | 错误信息提示 |
+| 列 | 说明 |
+|-------------------------------|-----------|
+| tables | 校验表 |
+| result | 校验结果 |
+| check_failed_tables | 校验失败的表 |
+| ignored_tables | 忽略的表 |
+| active | 校验作业是否活跃 |
+| inventory_finished_percentage | 存量校验完成度 |
+| inventory_remaining_seconds | 存量校验剩余时间 |
+| incremental_idle_seconds | 增量闲置时间 |
+| check_begin_time | 校验开始时间 |
+| check_end_time | 校验结束时间 |
+| duration_seconds | 校验持续时间，单位秒 |
+| algorithm_type | 校验算法类型 |
+| algorithm_props | 校验算法属性 |
+| error_message | 错误信息提示 |
### 示例
@@ -50,11 +57,11 @@ SHOW MIGRATION CHECK STATUS 'j010180026753ef0e25d3932d94d1673ba551';
```sql
mysql> SHOW MIGRATION CHECK STATUS 'j010180026753ef0e25d3932d94d1673ba551';
-+---------+--------+---------------------+-------------------+-------------------------+-------------------------+------------------+---------------+
-| tables | result | finished_percentage | remaining_seconds | check_begin_time | check_end_time | duration_seconds | error_message |
-+---------+--------+---------------------+-------------------+-------------------------+-------------------------+------------------+---------------+
-| t_order | true | 100 | 0 | 2022-11-01 17:57:39.940 | 2022-11-01 17:57:40.587 | 0 | |
-+---------+--------+---------------------+-------------------+-------------------------+-------------------------+------------------+---------------+
++---------+--------+---------------------+----------------+--------+-------------------------------+-----------------------------+--------------------------+-------------------------+-------------------------+------------------+----------------+-----------------+---------------+
+| tables | result | check_failed_tables | ignored_tables | active | inventory_finished_percentage | inventory_remaining_seconds | incremental_idle_seconds | check_begin_time | check_end_time | duration_seconds | algorithm_type | algorithm_props | error_message |
++---------+--------+---------------------+----------------+--------+-------------------------------+-----------------------------+--------------------------+-------------------------+-------------------------+------------------+----------------+-----------------+---------------+
+| t_order | true | | | false | 100 | 0 | 0 | 2022-11-01 17:57:39.940 | 2022-11-01 17:57:40.587 | 0 | DATA_MATCH | | |
++---------+--------+---------------------+----------------+--------+-------------------------------+-----------------------------+--------------------------+-------------------------+-------------------------+------------------+----------------+-----------------+---------------+
1 row in set (0.01 sec)
```
@@ -65,4 +72,4 @@ mysql> SHOW MIGRATION CHECK STATUS 'j010180026753ef0e25d3932d94d1673ba551';
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-- [SHOW MIGRATION LIST](/cn/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-list/)
\ No newline at end of file
+- [SHOW MIGRATION LIST](/cn/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-list/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-status.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-status.en.md
index 8e5384fbb50..22a64479e03 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-status.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-status.en.md
@@ -16,7 +16,7 @@ ShowMigrationCheckStatus ::=
'SHOW' 'MIGRATION' 'CHECK' 'STATUS' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
@@ -30,15 +30,22 @@ migrationJobId ::=
### Return Value Description
-| Columns | Description |
-|---------------------|------------------------------------|
-| tables | migration check table |
-| result | check result |
-| finished_percentage | check finished finished_percentage |
-| remaining_seconds | check remaining time |
-| check_begin_time | check begin time |
-| check_end_time | check end time |
-| error_message | error message |
+| Column | Description |
+|-------------------------------|-------------------------------------|
+| tables | migration check tables |
+| result | check result |
+| check_failed_tables | tables that failed the check |
+| ignored_tables | ignored tables |
+| active | whether the check job is active |
+| inventory_finished_percentage | inventory check finished percentage |
+| inventory_remaining_seconds | inventory check remaining time |
+| incremental_idle_seconds | incremental idle time |
+| check_begin_time | check begin time |
+| check_end_time | check end time |
+| duration_seconds | check duration in seconds |
+| algorithm_type | check algorithm type |
+| algorithm_props | check algorithm properties |
+| error_message | error message |
### Example
@@ -50,11 +57,11 @@ SHOW MIGRATION CHECK STATUS 'j010180026753ef0e25d3932d94d1673ba551';
```sql
mysql> SHOW MIGRATION CHECK STATUS 'j010180026753ef0e25d3932d94d1673ba551';
-+---------+--------+---------------------+-------------------+-------------------------+-------------------------+------------------+---------------+
-| tables | result | finished_percentage | remaining_seconds | check_begin_time | check_end_time | duration_seconds | error_message |
-+---------+--------+---------------------+-------------------+-------------------------+-------------------------+------------------+---------------+
-| t_order | true | 100 | 0 | 2022-11-01 17:57:39.940 | 2022-11-01 17:57:40.587 | 0 | |
-+---------+--------+---------------------+-------------------+-------------------------+-------------------------+------------------+---------------+
++---------+--------+---------------------+----------------+--------+-------------------------------+-----------------------------+--------------------------+-------------------------+-------------------------+------------------+----------------+-----------------+---------------+
+| tables | result | check_failed_tables | ignored_tables | active | inventory_finished_percentage | inventory_remaining_seconds | incremental_idle_seconds | check_begin_time | check_end_time | duration_seconds | algorithm_type | algorithm_props | error_message |
++---------+--------+---------------------+----------------+--------+-------------------------------+-----------------------------+--------------------------+-------------------------+-------------------------+------------------+----------------+-----------------+---------------+
+| t_order | true | | | false | 100 | 0 | 0 | 2022-11-01 17:57:39.940 | 2022-11-01 17:57:40.587 | 0 | DATA_MATCH | | |
++---------+--------+---------------------+----------------+--------+-------------------------------+-----------------------------+--------------------------+-------------------------+-------------------------+------------------+----------------+-----------------+---------------+
1 row in set (0.01 sec)
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-list.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-list.en.md
index 80ed0773792..ae26474db19 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-list.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-list.en.md
@@ -27,10 +27,10 @@ ShowMigrationList ::=
|--------------------|-------------------------------|
| id | migration job id |
| tables | migration tables |
-| job_item_count | migration job sharding number |
| active | migration job states |
| create_time | migration job create time |
| stop_time | migration job stop time |
+| job_item_count | migration job sharding number |
| job_sharding_nodes | migration job sharding nodes |
### Example
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-source-storage-units.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-source-storage-units.cn.md
index 016b1deda05..da871314cb1 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-source-storage-units.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-source-storage-units.cn.md
@@ -12,7 +12,7 @@ weight = 5
{{< tabs >}}
{{% tab name="语法" %}}
```sql
-ShowStorageUnit ::=
+ShowMigrationSourceStorageUnits ::=
'SHOW' 'MIGRATION' 'SOURCE' 'STORAGE' 'UNITS'
```
{{% /tab %}}
@@ -23,18 +23,24 @@ ShowStorageUnit ::=
### 返回值说明
-| 列 | 说明 |
-|-----------|--------|
-| name | 存储单元名称 |
-| type | 存储单元类型 |
-| host | 存储单元地址 |
-| port | 存储单元端口 |
-| db | 数据库名称 |
-| attribute | 存储单元参数 |
+| 列 | 说明 |
+|---------------------------------|----------------|
+| name | 存储单元名称 |
+| type | 存储单元类型 |
+| host | 存储单元地址 |
+| port | 存储单元端口 |
+| db | 数据库名称 |
+| connection_timeout_milliseconds | 连接超时时间，单位毫秒 |
+| idle_timeout_milliseconds | 空闲超时时间，单位毫秒 |
+| max_lifetime_milliseconds | 最大生命周期，单位毫秒 |
+| max_pool_size | 最大连接池大小 |
+| min_pool_size | 最小连接池大小 |
+| read_only | 存储单元是否只读 |
+| other_attributes | 其他存储单元属性 |
### 示例
-- 查询指定逻辑库中未被使用的存储单元
+- 查询已注册的数据迁移源存储单元
```sql
SHOW MIGRATION SOURCE STORAGE UNITS;
@@ -56,4 +62,4 @@ mysql> SHOW MIGRATION SOURCE STORAGE UNITS;
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-source-storage-units.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-source-storage-units.en.md
index 45cb1a39739..3e8918d1439 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-source-storage-units.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-source-storage-units.en.md
@@ -12,7 +12,7 @@ The `SHOW MIGRATION SOURCE STORAGE UNITS` syntax is used to query the registered
{{< tabs >}}
{{% tab name="Grammar" %}}
```sql
-ShowStorageUnit ::=
+ShowMigrationSourceStorageUnits ::=
'SHOW' 'MIGRATION' 'SOURCE' 'STORAGE' 'UNITS'
```
{{% /tab %}}
@@ -23,16 +23,22 @@ ShowStorageUnit ::=
### Return Value Description
-| Column | Description |
-|-----------|------------------------|
-| name | Storage unit name |
-| type | Storage unit type |
-| host | Storage unit host |
-| port | Storage unit port |
-| db | Database name |
-| attribute | Storage unit attribute |
+| Column | Description |
+|---------------------------------|--------------------------------------|
+| name | Storage unit name |
+| type | Storage unit type |
+| host | Storage unit host |
+| port | Storage unit port |
+| db | Database name |
+| connection_timeout_milliseconds | Connection timeout in milliseconds |
+| idle_timeout_milliseconds | Idle timeout in milliseconds |
+| max_lifetime_milliseconds | Maximum lifetime in milliseconds |
+| max_pool_size | Maximum connection pool size |
+| min_pool_size | Minimum connection pool size |
+| read_only | Whether the storage unit is read-only |
+| other_attributes | Other storage unit attributes |
- ### Example
+### Example
- Query registered migration source storage units
@@ -56,4 +62,4 @@ mysql> SHOW MIGRATION SOURCE STORAGE UNITS;
### Related links
-- [Reserved word](/en/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [Reserved word](/en/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-status.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-status.cn.md
index b7a692a65c3..dfafc56dd56 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-status.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-status.cn.md
@@ -16,7 +16,7 @@ ShowMigrationStatus ::=
'SHOW' 'MIGRATION' 'STATUS' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="铁路图" %}}
@@ -33,8 +33,10 @@ migrationJobId ::=
| 列 | 说明 |
|-------------------------------|------------|
| item | 数据迁移作业分片编号 |
-| data source | 数据迁移源 |
+| data_source | 数据迁移源 |
+| tables | 数据迁移表 |
| status | 数据迁移作业状态 |
+| active | 数据迁移作业是否活跃 |
| processed_records_count | 处理数据行数 |
| inventory_finished_percentage | 数据迁移作业完成度 |
| incremental_idle_seconds | 增量闲置时间 |
@@ -50,11 +52,11 @@ SHOW MIGRATION STATUS 'j010180026753ef0e25d3932d94d1673ba551';
```sql
mysql> SHOW MIGRATION STATUS 'j010180026753ef0e25d3932d94d1673ba551';
-+------+-------------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
-| item | data_source | status | active | processed_records_count | inventory_finished_percentage | incremental_idle_seconds | error_message |
-+------+-------------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
-| 0 | ds_1 | EXECUTE_INCREMENTAL_TASK | true | 6 | 100 | 25 | |
-+------+-------------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
++------+-------------+---------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
+| item | data_source | tables | status | active | processed_records_count | inventory_finished_percentage | incremental_idle_seconds | error_message |
++------+-------------+---------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
+| 0 | ds_1 | t_order | EXECUTE_INCREMENTAL_TASK | true | 6 | 100 | 25 | |
++------+-------------+---------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
1 row in set (0.01 sec)
```
@@ -64,4 +66,4 @@ mysql> SHOW MIGRATION STATUS 'j010180026753ef0e25d3932d94d1673ba551';
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-status.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-status.en.md
index 9e9ffcb5c26..a4d72d9de1e 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-status.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-status.en.md
@@ -16,7 +16,7 @@ ShowMigrationStatus ::=
'SHOW' 'MIGRATION' 'STATUS' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
@@ -33,8 +33,10 @@ migrationJobId ::=
| column | Description |
|--------------------------------|--------------------------------------|
| item | migration job sharding serial number |
-| data source | migration source |
+| data_source | migration source |
+| tables | migration tables |
| status | migration job status |
+| active | whether the migration job is active |
| processed_records_count | number of processed rows |
| inventory_finished_percentage | finished percentage of migration job |
| incremental_idle_seconds | incremental idle time |
@@ -50,11 +52,11 @@ SHOW MIGRATION STATUS 'j010180026753ef0e25d3932d94d1673ba551';
```sql
mysql> SHOW MIGRATION STATUS 'j010180026753ef0e25d3932d94d1673ba551';
-+------+-------------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
-| item | data_source | status | active | processed_records_count | inventory_finished_percentage | incremental_idle_seconds | error_message |
-+------+-------------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
-| 0 | ds_1 | EXECUTE_INCREMENTAL_TASK | true | 6 | 100 | 25 | |
-+------+-------------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
++------+-------------+---------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
+| item | data_source | tables | status | active | processed_records_count | inventory_finished_percentage | incremental_idle_seconds | error_message |
++------+-------------+---------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
+| 0 | ds_1 | t_order | EXECUTE_INCREMENTAL_TASK | true | 6 | 100 | 25 | |
++------+-------------+---------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
1 row in set (0.01 sec)
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration-check.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration-check.cn.md
index 72f6bd5c1d0..0b01fdb2f5d 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration-check.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration-check.cn.md
@@ -16,7 +16,7 @@ StartMigrationCheck ::=
'START' 'MIGRATION' 'CHECK' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="铁路图" %}}
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration-check.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration-check.en.md
index 89fa7ba591b..05219ef1f3c 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration-check.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration-check.en.md
@@ -16,7 +16,7 @@ StartMigrationCheck ::=
'START' 'MIGRATION' 'CHECK' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration.cn.md
index f78fa1f493a..967a142eacf 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration.cn.md
@@ -16,7 +16,7 @@ StartMigration ::=
'START' 'MIGRATION' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="铁路图" %}}
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration.en.md
index 3e1b7f8c47b..83f4a97df99 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration.en.md
@@ -16,7 +16,7 @@ StartMigration ::=
'START' 'MIGRATION' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.cn.md
index 9057cdfc750..863b5d6f3cc 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.cn.md
@@ -16,7 +16,7 @@ StopMigrationCheck ::=
'STOP' 'MIGRATION' 'CHECK' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="铁路图" %}}
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.en.md
index 1a4be763b64..990b15eda74 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration-check.en.md
@@ -16,7 +16,7 @@ StopMigrationCheck ::=
'STOP' 'MIGRATION' 'CHECK' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration.cn.md
index 7f883aed735..641b1c63f1b 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration.cn.md
@@ -16,7 +16,7 @@ StopMigration ::=
'STOP' 'MIGRATION' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="铁路图" %}}
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration.en.md
index f3862fbafe8..b9d7dff5157 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/stop-migration.en.md
@@ -16,7 +16,7 @@ StopMigration ::=
'STOP' 'MIGRATION' migrationJobId
migrationJobId ::=
- string
+ integer | identifier | string
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-compute-node-info.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-compute-node-info.cn.md
index 7ad35809099..1e7e5b30c0e 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-compute-node-info.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-compute-node-info.cn.md
@@ -32,7 +32,7 @@ ShowComputeNodeInfo ::=
| mode_type | proxy 实例模式 |
| worker_id | worker id |
| labels | 标签 |
-| version | 版本 |
+| version | 版本 |
### 示例
@@ -44,12 +44,11 @@ SHOW COMPUTE NODE INFO;
```sql
mysql> SHOW COMPUTE NODE INFO;
-mysql> SHOW COMPUTE NODES;
-+--------------------------------------+---------------+------------+------+--------+------------+-----------+--------+----------+
-| instance_id | instance_type | host | port | status | mode_type | worker_id | labels | version |
-+--------------------------------------+---------------+------------+------+--------+------------+-----------+--------+----------+
-| 3e84d33e-cb97-42f2-b6ce-f78fea0ded89 | PROXY | 127.0.0.1 | 3307 | OK | Cluster | -1 | | 5.4.2 |
-+--------------------------------------+---------------+------------+------+--------+------------+-----------+--------+----------+
++--------------------------------------+-----------+------+--------+-----------+-----------+--------+----------+
+| instance_id | host | port | status | mode_type | worker_id | labels | version |
++--------------------------------------+-----------+------+--------+-----------+-----------+--------+----------+
+| 3e84d33e-cb97-42f2-b6ce-f78fea0ded89 | 127.0.0.1 | 3307 | OK | Cluster | -1 | | 5.4.2 |
++--------------------------------------+-----------+------+--------+-----------+-----------+--------+----------+
1 row in set (0.01 sec)
```
@@ -59,4 +58,4 @@ mysql> SHOW COMPUTE NODES;
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-compute-node-info.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-compute-node-info.en.md
index f996c879b92..963d2489e0e 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-compute-node-info.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-compute-node-info.en.md
@@ -31,7 +31,7 @@ ShowComputeNodeInfo ::=
| mode_type | proxy instance mode |
| worker_id | worker id |
| labels | labels |
-| version | version |
+| version | version |
### Example
@@ -42,12 +42,12 @@ SHOW COMPUTE NODE INFO;
```
```sql
-mysql> SHOW COMPUTE NODES;
-+--------------------------------------+---------------+------------+------+--------+------------+-----------+--------+----------+
-| instance_id | instance_type | host | port | status | mode_type | worker_id | labels | version |
-+--------------------------------------+---------------+------------+------+--------+------------+-----------+--------+----------+
-| 3e84d33e-cb97-42f2-b6ce-f78fea0ded89 | PROXY | 127.0.0.1 | 3307 | OK | Cluster | -1 | | 5.4.2 |
-+--------------------------------------+---------------+------------+------+--------+------------+-----------+--------+----------+
+mysql> SHOW COMPUTE NODE INFO;
++--------------------------------------+-----------+------+--------+-----------+-----------+--------+----------+
+| instance_id | host | port | status | mode_type | worker_id | labels | version |
++--------------------------------------+-----------+------+--------+-----------+-----------+--------+----------+
+| 3e84d33e-cb97-42f2-b6ce-f78fea0ded89 | 127.0.0.1 | 3307 | OK | Cluster | -1 | | 5.4.2 |
++--------------------------------------+-----------+------+--------+-----------+-----------+--------+----------+
1 row in set (0.01 sec)
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-table-metadata.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-table-metadata.cn.md
index a90db9c13b3..e83c083507f 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-table-metadata.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-table-metadata.cn.md
@@ -35,16 +35,17 @@ quotedIdentifier ::=
### 返回值说明
-| 列 | 说明 |
-|-------------|-------|
-| schema_name | 逻辑库名称 |
-| table_name | 表名称 |
-| type | 元数据类型 |
-| name | 元数据名称 |
+| 列 | 说明 |
+|---------------|-------|
+| database_name | 逻辑库名称 |
+| table_name | 表名称 |
+| type | 元数据类型 |
+| name | 元数据名称 |
+| value | 元数据值 |
### 补充说明
-- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE。` 如果也未使用 `DATABASE` 则会提示 `No database selected`。
+- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。如果也未使用 `DATABASE` 则会提示 `No database selected`。
- `tableName` 和 `databaseName` 可以写成不带引号的标识符、反引号包裹的标识符或双引号包裹的标识符。
@@ -58,18 +59,18 @@ SHOW TABLE METADATA t_order, `t_order_1` FROM "sharding_db";
```sql
mysql> SHOW TABLE METADATA t_order, t_order_1 FROM sharding_db;
-+-------------------+------------+--------+----------+
-| schema_name | table_name | type | name |
-+-------------------+------------+--------+----------+
-| sharding_db | t_order_1 | COLUMN | order_id |
-| sharding_db | t_order_1 | COLUMN | user_id |
-| sharding_db | t_order_1 | COLUMN | status |
-| sharding_db | t_order_1 | INDEX | PRIMARY |
-| sharding_db | t_order | COLUMN | order_id |
-| sharding_db | t_order | COLUMN | user_id |
-| sharding_db | t_order | COLUMN | status |
-| sharding_db | t_order | INDEX | PRIMARY |
-+-------------------+------------+--------+----------+
++---------------+------------+--------+----------+---------------------------+
+| database_name | table_name | type | name | value |
++---------------+------------+--------+----------+---------------------------+
+| sharding_db | t_order_1 | COLUMN | order_id | ShardingSphereColumn(...) |
+| sharding_db | t_order_1 | COLUMN | user_id | ShardingSphereColumn(...) |
+| sharding_db | t_order_1 | COLUMN | status | ShardingSphereColumn(...) |
+| sharding_db | t_order_1 | INDEX | PRIMARY | ShardingSphereIndex(...) |
+| sharding_db | t_order | COLUMN | order_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | user_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | status | ShardingSphereColumn(...) |
+| sharding_db | t_order | INDEX | PRIMARY | ShardingSphereIndex(...) |
++---------------+------------+--------+----------+---------------------------+
8 rows in set (0.01 sec)
```
@@ -81,14 +82,14 @@ SHOW TABLE METADATA "t_order" FROM `sharding_db`;
```sql
mysql> SHOW TABLE METADATA t_order FROM sharding_db;
-+-------------------+------------+--------+----------+
-| schema_name | table_name | type | name |
-+-------------------+------------+--------+----------+
-| sharding_db | t_order | COLUMN | order_id |
-| sharding_db | t_order | COLUMN | user_id |
-| sharding_db | t_order | COLUMN | status |
-| sharding_db | t_order | INDEX | PRIMARY |
-+-------------------+------------+--------+----------+
++---------------+------------+--------+----------+---------------------------+
+| database_name | table_name | type | name | value |
++---------------+------------+--------+----------+---------------------------+
+| sharding_db | t_order | COLUMN | order_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | user_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | status | ShardingSphereColumn(...) |
+| sharding_db | t_order | INDEX | PRIMARY | ShardingSphereIndex(...) |
++---------------+------------+--------+----------+---------------------------+
4 rows in set (0.00 sec)
```
@@ -100,18 +101,18 @@ SHOW TABLE METADATA `t_order`, "t_order_1";
```sql
mysql> SHOW TABLE METADATA t_order, t_order_1;
-+-------------------+------------+--------+----------+
-| schema_name | table_name | type | name |
-+-------------------+------------+--------+----------+
-| sharding_db | t_order_1 | COLUMN | order_id |
-| sharding_db | t_order_1 | COLUMN | user_id |
-| sharding_db | t_order_1 | COLUMN | status |
-| sharding_db | t_order_1 | INDEX | PRIMARY |
-| sharding_db | t_order | COLUMN | order_id |
-| sharding_db | t_order | COLUMN | user_id |
-| sharding_db | t_order | COLUMN | status |
-| sharding_db | t_order | INDEX | PRIMARY |
-+-------------------+------------+--------+----------+
++---------------+------------+--------+----------+---------------------------+
+| database_name | table_name | type | name | value |
++---------------+------------+--------+----------+---------------------------+
+| sharding_db | t_order_1 | COLUMN | order_id | ShardingSphereColumn(...) |
+| sharding_db | t_order_1 | COLUMN | user_id | ShardingSphereColumn(...) |
+| sharding_db | t_order_1 | COLUMN | status | ShardingSphereColumn(...) |
+| sharding_db | t_order_1 | INDEX | PRIMARY | ShardingSphereIndex(...) |
+| sharding_db | t_order | COLUMN | order_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | user_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | status | ShardingSphereColumn(...) |
+| sharding_db | t_order | INDEX | PRIMARY | ShardingSphereIndex(...) |
++---------------+------------+--------+----------+---------------------------+
8 rows in set (0.00 sec)
```
@@ -123,14 +124,14 @@ SHOW TABLE METADATA "t_order";
```sql
mysql> SHOW TABLE METADATA t_order;
-+-------------------+------------+--------+----------+
-| schema_name | table_name | type | name |
-+-------------------+------------+--------+----------+
-| sharding_db | t_order | COLUMN | order_id |
-| sharding_db | t_order | COLUMN | user_id |
-| sharding_db | t_order | COLUMN | status |
-| sharding_db | t_order | INDEX | PRIMARY |
-+-------------------+------------+--------+----------+
++---------------+------------+--------+----------+---------------------------+
+| database_name | table_name | type | name | value |
++---------------+------------+--------+----------+---------------------------+
+| sharding_db | t_order | COLUMN | order_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | user_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | status | ShardingSphereColumn(...) |
+| sharding_db | t_order | INDEX | PRIMARY | ShardingSphereIndex(...) |
++---------------+------------+--------+----------+---------------------------+
4 rows in set (0.01 sec)
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-table-metadata.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-table-metadata.en.md
index e7a5c1f0d0c..dc9ea893815 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-table-metadata.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-table-metadata.en.md
@@ -5,7 +5,7 @@ weight = 11
### Description
-The `SHOW TABLE METADATA` syntax is used to query tabe metadata.
+The `SHOW TABLE METADATA` syntax is used to query table metadata.
### Syntax
@@ -35,12 +35,13 @@ quotedIdentifier ::=
### Return Value Description
-| Columns | Description |
-|-------------|---------------|
-| schema_name | database name |
-| table_name | table name |
-| type | metadata type |
-| name | metadata name |
+| Columns | Description |
+|---------------|----------------|
+| database_name | database name |
+| table_name | table name |
+| type | metadata type |
+| name | metadata name |
+| value | metadata value |
### Supplement
@@ -50,7 +51,7 @@ quotedIdentifier ::=
### Example
-- Query matadata of multiple tables from specified database
+- Query metadata of multiple tables from specified database
```sql
SHOW TABLE METADATA t_order, `t_order_1` FROM "sharding_db";
@@ -58,18 +59,18 @@ SHOW TABLE METADATA t_order, `t_order_1` FROM "sharding_db";
```sql
mysql> SHOW TABLE METADATA t_order, `t_order_1` FROM "sharding_db";
-+-------------------+------------+--------+----------+
-| schema_name | table_name | type | name |
-+-------------------+------------+--------+----------+
-| sharding_db | t_order_1 | COLUMN | order_id |
-| sharding_db | t_order_1 | COLUMN | user_id |
-| sharding_db | t_order_1 | COLUMN | status |
-| sharding_db | t_order_1 | INDEX | PRIMARY |
-| sharding_db | t_order | COLUMN | order_id |
-| sharding_db | t_order | COLUMN | user_id |
-| sharding_db | t_order | COLUMN | status |
-| sharding_db | t_order | INDEX | PRIMARY |
-+-------------------+------------+--------+----------+
++---------------+------------+--------+----------+---------------------------+
+| database_name | table_name | type | name | value |
++---------------+------------+--------+----------+---------------------------+
+| sharding_db | t_order_1 | COLUMN | order_id | ShardingSphereColumn(...) |
+| sharding_db | t_order_1 | COLUMN | user_id | ShardingSphereColumn(...) |
+| sharding_db | t_order_1 | COLUMN | status | ShardingSphereColumn(...) |
+| sharding_db | t_order_1 | INDEX | PRIMARY | ShardingSphereIndex(...) |
+| sharding_db | t_order | COLUMN | order_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | user_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | status | ShardingSphereColumn(...) |
+| sharding_db | t_order | INDEX | PRIMARY | ShardingSphereIndex(...) |
++---------------+------------+--------+----------+---------------------------+
8 rows in set (0.01 sec)
```
@@ -81,14 +82,14 @@ SHOW TABLE METADATA "t_order" FROM `sharding_db`;
```sql
mysql> SHOW TABLE METADATA "t_order" FROM `sharding_db`;
-+-------------------+------------+--------+----------+
-| schema_name | table_name | type | name |
-+-------------------+------------+--------+----------+
-| sharding_db | t_order | COLUMN | order_id |
-| sharding_db | t_order | COLUMN | user_id |
-| sharding_db | t_order | COLUMN | status |
-| sharding_db | t_order | INDEX | PRIMARY |
-+-------------------+------------+--------+----------+
++---------------+------------+--------+----------+---------------------------+
+| database_name | table_name | type | name | value |
++---------------+------------+--------+----------+---------------------------+
+| sharding_db | t_order | COLUMN | order_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | user_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | status | ShardingSphereColumn(...) |
+| sharding_db | t_order | INDEX | PRIMARY | ShardingSphereIndex(...) |
++---------------+------------+--------+----------+---------------------------+
4 rows in set (0.00 sec)
```
@@ -100,18 +101,18 @@ SHOW TABLE METADATA `t_order`, "t_order_1";
```sql
mysql> SHOW TABLE METADATA `t_order`, "t_order_1";
-+-------------------+------------+--------+----------+
-| schema_name | table_name | type | name |
-+-------------------+------------+--------+----------+
-| sharding_db | t_order_1 | COLUMN | order_id |
-| sharding_db | t_order_1 | COLUMN | user_id |
-| sharding_db | t_order_1 | COLUMN | status |
-| sharding_db | t_order_1 | INDEX | PRIMARY |
-| sharding_db | t_order | COLUMN | order_id |
-| sharding_db | t_order | COLUMN | user_id |
-| sharding_db | t_order | COLUMN | status |
-| sharding_db | t_order | INDEX | PRIMARY |
-+-------------------+------------+--------+----------+
++---------------+------------+--------+----------+---------------------------+
+| database_name | table_name | type | name | value |
++---------------+------------+--------+----------+---------------------------+
+| sharding_db | t_order_1 | COLUMN | order_id | ShardingSphereColumn(...) |
+| sharding_db | t_order_1 | COLUMN | user_id | ShardingSphereColumn(...) |
+| sharding_db | t_order_1 | COLUMN | status | ShardingSphereColumn(...) |
+| sharding_db | t_order_1 | INDEX | PRIMARY | ShardingSphereIndex(...) |
+| sharding_db | t_order | COLUMN | order_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | user_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | status | ShardingSphereColumn(...) |
+| sharding_db | t_order | INDEX | PRIMARY | ShardingSphereIndex(...) |
++---------------+------------+--------+----------+---------------------------+
8 rows in set (0.00 sec)
```
@@ -123,14 +124,14 @@ SHOW TABLE METADATA "t_order";
```sql
mysql> SHOW TABLE METADATA "t_order";
-+-------------------+------------+--------+----------+
-| schema_name | table_name | type | name |
-+-------------+------------+--------+----------+
-| sharding_db | t_order | COLUMN | order_id |
-| sharding_db | t_order | COLUMN | user_id |
-| sharding_db | t_order | COLUMN | status |
-| sharding_db | t_order | INDEX | PRIMARY |
-+-------------------+------------+--------+----------+
++---------------+------------+--------+----------+---------------------------+
+| database_name | table_name | type | name | value |
++---------------+------------+--------+----------+---------------------------+
+| sharding_db | t_order | COLUMN | order_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | user_id | ShardingSphereColumn(...) |
+| sharding_db | t_order | COLUMN | status | ShardingSphereColumn(...) |
+| sharding_db | t_order | INDEX | PRIMARY | ShardingSphereIndex(...) |
++---------------+------------+--------+----------+---------------------------+
4 rows in set (0.01 sec)
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/alter-encrypt-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/alter-encrypt-rule.cn.md
index 4c4d119eb23..b4518529b02 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/alter-encrypt-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/alter-encrypt-rule.cn.md
@@ -22,13 +22,16 @@ columnDefinition ::=
'(' 'NAME' '=' columnName ',' 'CIPHER' '=' cipherColumnName (',' 'ASSISTED_QUERY' '=' assistedQueryColumnName)? (',' 'LIKE_QUERY' '=' likeQueryColumnName)? ',' encryptAlgorithmDefinition (',' assistedQueryAlgorithmDefinition)? (',' likeQueryAlgorithmDefinition)? ')'
encryptAlgorithmDefinition ::=
- 'ENCRYPT_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
+ 'ENCRYPT_ALGORITHM' '(' algorithmDefinition ')'
assistedQueryAlgorithmDefinition ::=
- 'ASSISTED_QUERY_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
+ 'ASSISTED_QUERY_ALGORITHM' '(' algorithmDefinition ')'
likeQueryAlgorithmDefinition ::=
- 'LIKE_QUERY_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
+ 'LIKE_QUERY_ALGORITHM' '(' algorithmDefinition ')'
+
+algorithmDefinition ::=
+ 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
propertiesDefinition ::=
'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'
@@ -76,8 +79,8 @@ value ::=
```sql
ALTER ENCRYPT RULE t_encrypt (
COLUMNS(
-(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,LIKE_QUERY=like_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE'))),
-(NAME=order_id,CIPHER=order_cipher,ASSISTED_QUERY=assisted_query_order,LIKE_QUERY=like_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE')))
+(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5'))),
+(NAME=order_id,CIPHER=order_cipher,ASSISTED_QUERY=assisted_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')))
));
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/alter-encrypt-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/alter-encrypt-rule.en.md
index 76a0414ea26..baed336f82f 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/alter-encrypt-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/alter-encrypt-rule.en.md
@@ -22,13 +22,16 @@ columnDefinition ::=
'(' 'NAME' '=' columnName ',' 'CIPHER' '=' cipherColumnName (',' 'ASSISTED_QUERY' '=' assistedQueryColumnName)? (',' 'LIKE_QUERY' '=' likeQueryColumnName)? ',' encryptAlgorithmDefinition (',' assistedQueryAlgorithmDefinition)? (',' likeQueryAlgorithmDefinition)? ')'
encryptAlgorithmDefinition ::=
- 'ENCRYPT_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
+ 'ENCRYPT_ALGORITHM' '(' algorithmDefinition ')'
assistedQueryAlgorithmDefinition ::=
- 'ASSISTED_QUERY_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
+ 'ASSISTED_QUERY_ALGORITHM' '(' algorithmDefinition ')'
likeQueryAlgorithmDefinition ::=
- 'LIKE_QUERY_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
+ 'LIKE_QUERY_ALGORITHM' '(' algorithmDefinition ')'
+
+algorithmDefinition ::=
+ 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
propertiesDefinition ::=
'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'
@@ -75,8 +78,8 @@ value ::=
```sql
ALTER ENCRYPT RULE t_encrypt (
COLUMNS(
-(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,LIKE_QUERY=like_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE'))),
-(NAME=order_id,CIPHER=order_cipher,ASSISTED_QUERY=assisted_query_order,LIKE_QUERY=like_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE')))
+(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5'))),
+(NAME=order_id,CIPHER=order_cipher,ASSISTED_QUERY=assisted_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')))
));
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/create-encrypt-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/create-encrypt-rule.cn.md
index 5722be0c1de..246b74b271a 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/create-encrypt-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/create-encrypt-rule.cn.md
@@ -25,13 +25,16 @@ columnDefinition ::=
'(' 'NAME' '=' columnName ',' 'CIPHER' '=' cipherColumnName (',' 'ASSISTED_QUERY' '=' assistedQueryColumnName)? (',' 'LIKE_QUERY' '=' likeQueryColumnName)? ',' encryptAlgorithmDefinition (',' assistedQueryAlgorithmDefinition)? (',' likeQueryAlgorithmDefinition)? ')'
encryptAlgorithmDefinition ::=
- 'ENCRYPT_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
+ 'ENCRYPT_ALGORITHM' '(' algorithmDefinition ')'
assistedQueryAlgorithmDefinition ::=
- 'ASSISTED_QUERY_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
+ 'ASSISTED_QUERY_ALGORITHM' '(' algorithmDefinition ')'
likeQueryAlgorithmDefinition ::=
- 'LIKE_QUERY_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
+ 'LIKE_QUERY_ALGORITHM' '(' algorithmDefinition ')'
+
+algorithmDefinition ::=
+ 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
propertiesDefinition ::=
'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'
@@ -80,13 +83,13 @@ value ::=
```sql
CREATE ENCRYPT RULE t_encrypt (
COLUMNS(
-(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,LIKE_QUERY=like_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE'))),
-(NAME=order_id,CIPHER =order_cipher,ASSISTED_QUERY=assisted_query_order,LIKE_QUERY=like_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE')))
+(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5'))),
+(NAME=order_id,CIPHER =order_cipher,ASSISTED_QUERY=assisted_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')))
)),
t_encrypt_2 (
COLUMNS(
-(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,LIKE_QUERY=like_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE'))),
-(NAME=order_id, CIPHER=order_cipher,ASSISTED_QUERY=assisted_query_order,LIKE_QUERY=like_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE')))
+(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5'))),
+(NAME=order_id, CIPHER=order_cipher,ASSISTED_QUERY=assisted_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')))
));
```
@@ -95,13 +98,13 @@ COLUMNS(
```sql
CREATE ENCRYPT RULE IF NOT EXISTS t_encrypt (
COLUMNS(
-(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,LIKE_QUERY=like_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE'))),
-(NAME=order_id,CIPHER =order_cipher,ASSISTED_QUERY=assisted_query_order,LIKE_QUERY=like_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE')))
+(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5'))),
+(NAME=order_id,CIPHER =order_cipher,ASSISTED_QUERY=assisted_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')))
)),
t_encrypt_2 (
COLUMNS(
-(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,LIKE_QUERY=like_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE'))),
-(NAME=order_id,CIPHER=order_cipher,ASSISTED_QUERY=assisted_query_order,LIKE_QUERY=like_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE')))
+(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5'))),
+(NAME=order_id,CIPHER=order_cipher,ASSISTED_QUERY=assisted_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')))
));
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/create-encrypt-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/create-encrypt-rule.en.md
index bf26dd9416a..f21cf85c792 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/create-encrypt-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt/create-encrypt-rule.en.md
@@ -25,13 +25,16 @@ columnDefinition ::=
'(' 'NAME' '=' columnName ',' 'CIPHER' '=' cipherColumnName (',' 'ASSISTED_QUERY' '=' assistedQueryColumnName)? (',' 'LIKE_QUERY' '=' likeQueryColumnName)? ',' encryptAlgorithmDefinition (',' assistedQueryAlgorithmDefinition)? (',' likeQueryAlgorithmDefinition)? ')'
encryptAlgorithmDefinition ::=
- 'ENCRYPT_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
+ 'ENCRYPT_ALGORITHM' '(' algorithmDefinition ')'
assistedQueryAlgorithmDefinition ::=
- 'ASSISTED_QUERY_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
+ 'ASSISTED_QUERY_ALGORITHM' '(' algorithmDefinition ')'
likeQueryAlgorithmDefinition ::=
- 'LIKE_QUERY_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
+ 'LIKE_QUERY_ALGORITHM' '(' algorithmDefinition ')'
+
+algorithmDefinition ::=
+ 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
propertiesDefinition ::=
'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'
@@ -80,13 +83,13 @@ value ::=
```sql
CREATE ENCRYPT RULE t_encrypt (
COLUMNS(
-(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,LIKE_QUERY=like_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE'))),
-(NAME=order_id,CIPHER =order_cipher,ASSISTED_QUERY=assisted_query_order,LIKE_QUERY=like_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE')))
+(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5'))),
+(NAME=order_id,CIPHER =order_cipher,ASSISTED_QUERY=assisted_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')))
)),
t_encrypt_2 (
COLUMNS(
-(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,LIKE_QUERY=like_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE'))),
-(NAME=order_id, CIPHER=order_cipher,ASSISTED_QUERY=assisted_query_order,LIKE_QUERY=like_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE')))
+(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5'))),
+(NAME=order_id, CIPHER=order_cipher,ASSISTED_QUERY=assisted_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')))
));
```
@@ -95,13 +98,13 @@ COLUMNS(
```sql
CREATE ENCRYPT RULE IF NOT EXISTS t_encrypt (
COLUMNS(
-(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,LIKE_QUERY=like_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE'))),
-(NAME=order_id,CIPHER =order_cipher,ASSISTED_QUERY=assisted_query_order,LIKE_QUERY=like_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE')))
+(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5'))),
+(NAME=order_id,CIPHER =order_cipher,ASSISTED_QUERY=assisted_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')))
)),
t_encrypt_2 (
COLUMNS(
-(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,LIKE_QUERY=like_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE'))),
-(NAME=order_id,CIPHER=order_cipher,ASSISTED_QUERY=assisted_query_order,LIKE_QUERY=like_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')),LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE')))
+(NAME=user_id,CIPHER=user_cipher,ASSISTED_QUERY=assisted_query_user,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5'))),
+(NAME=order_id,CIPHER=order_cipher,ASSISTED_QUERY=assisted_query_order,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))),ASSISTED_QUERY_ALGORITHM(TYPE(NAME='MD5')))
));
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.cn.md
index 88ec0b8d59d..856d29fdf2d 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.cn.md
@@ -13,7 +13,7 @@ weight = 2
{{% tab name="语法" %}}
```sql
AlterMaskRule ::=
- 'ALTER' 'MASK' 'RULE' maskRuleDefinition (',' maskRuleDefinition)*
+ 'ALTER' 'MASK' 'TABLE'? 'RULE' maskRuleDefinition (',' maskRuleDefinition)*
maskRuleDefinition ::=
ruleName '(' 'COLUMNS' '(' columnDefinition (',' columnDefinition)* ')' ')'
@@ -66,9 +66,9 @@ COLUMNS(
### 保留字
-`ALTER`、`MASK`、`RULE`、`COLUMNS`、`NAME`、`TYPE`
+`ALTER`、`MASK`、`TABLE`、`RULE`、`COLUMNS`、`NAME`、`TYPE`
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-- [数据脱敏算法](/cn/user-manual/common-config/builtin-algorithm/mask/)
\ No newline at end of file
+- [数据脱敏算法](/cn/user-manual/common-config/builtin-algorithm/mask/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.en.md
index 69cc5b2e5e8..a470be3d5dd 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/alter-mask-rule.en.md
@@ -13,7 +13,7 @@ The `ALTER MASK RULE` syntax is used to create a mask rule.
{{% tab name="Grammar" %}}
```sql
AlterMaskRule ::=
- 'ALTER' 'MASK' 'RULE' maskRuleDefinition (',' maskRuleDefinition)*
+ 'ALTER' 'MASK' 'TABLE'? 'RULE' maskRuleDefinition (',' maskRuleDefinition)*
maskRuleDefinition ::=
ruleName '(' 'COLUMNS' '(' columnDefinition (',' columnDefinition)* ')' ')'
@@ -66,7 +66,7 @@ COLUMNS(
### Reserved words
-`ALTER`, `MASK`, `RULE`, `COLUMNS`, `NAME`, `TYPE`
+`ALTER`, `MASK`, `TABLE`, `RULE`, `COLUMNS`, `NAME`, `TYPE`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.cn.md
index f86a1c838a3..31c15fd789b 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.cn.md
@@ -13,7 +13,7 @@ weight = 1
{{% tab name="语法" %}}
```sql
CreateMaskRule ::=
- 'CREATE' 'MASK' 'RULE' ifNotExists? maskRuleDefinition (',' maskRuleDefinition)*
+ 'CREATE' 'MASK' 'TABLE'? 'RULE' ifNotExists? maskRuleDefinition (',' maskRuleDefinition)*
ifNotExists ::=
'IF' 'NOT' 'EXISTS'
@@ -81,9 +81,9 @@ COLUMNS(
### 保留字
-`CREATE`、`MASK`、`RULE`、`COLUMNS`、`NAME`、`TYPE`
+`CREATE`、`MASK`、`TABLE`、`RULE`、`COLUMNS`、`NAME`、`TYPE`
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-- [数据脱敏算法](/cn/user-manual/common-config/builtin-algorithm/mask/)
\ No newline at end of file
+- [数据脱敏算法](/cn/user-manual/common-config/builtin-algorithm/mask/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.en.md
index a736ff7f8a9..c24c256ff90 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/create-mask-rule.en.md
@@ -13,7 +13,7 @@ The `CREATE MASK RULE` syntax is used to create a mask rule.
{{% tab name="Grammar" %}}
```sql
CreateMaskRule ::=
- 'CREATE' 'MASK' 'RULE' ifNotExists? maskRuleDefinition (',' maskRuleDefinition)*
+ 'CREATE' 'MASK' 'TABLE'? 'RULE' ifNotExists? maskRuleDefinition (',' maskRuleDefinition)*
ifNotExists ::=
'IF' 'NOT' 'EXISTS'
@@ -81,7 +81,7 @@ COLUMNS(
### Reserved words
-`CREATE`, `MASK`, `RULE`, `COLUMNS`, `NAME`, `TYPE`
+`CREATE`, `MASK`, `TABLE`, `RULE`, `COLUMNS`, `NAME`, `TYPE`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/drop-mask-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/drop-mask-rule.cn.md
index 8b30c581717..fb105a9f45a 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/drop-mask-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/drop-mask-rule.cn.md
@@ -13,7 +13,7 @@ weight = 3
{{% tab name="语法" %}}
```sql
DropMaskRule ::=
- 'DROP' 'MASK' 'RULE' ifExists? ruleName (',' ruleName)*
+ 'DROP' 'MASK' 'TABLE'? 'RULE' ifExists? ruleName (',' ruleName)*
ifExists ::=
'IF' 'EXISTS'
@@ -47,7 +47,7 @@ DROP MASK RULE IF EXISTS t_mask, t_mask_1;
### 保留字
-`DROP`, `MASK`, `RULE`
+`DROP`, `MASK`, `TABLE`, `RULE`
### 相关链接
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/drop-mask-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/drop-mask-rule.en.md
index e900d96613d..67e6cb9e0e7 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/drop-mask-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/mask/drop-mask-rule.en.md
@@ -13,7 +13,7 @@ The `DROP MASK RULE` syntax is used to drop existing mask rule.
{{% tab name="Grammar" %}}
```sql
DropMaskRule ::=
- 'DROP' 'MASK' 'RULE' ifExists? ruleName (',' ruleName)*
+ 'DROP' 'MASK' 'TABLE'? 'RULE' ifExists? ruleName (',' ruleName)*
ifExists ::=
'IF' 'EXISTS'
@@ -47,7 +47,7 @@ DROP MASK RULE IF EXISTS t_mask, t_mask_1;
### Reserved words
-`DROP`, `MASK`, `RULE`
+`DROP`, `MASK`, `TABLE`, `RULE`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting/drop-readwrite-splitting-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting/drop-readwrite-splitting-rule.cn.md
index 4855d26f808..12a38c30637 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting/drop-readwrite-splitting-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting/drop-readwrite-splitting-rule.cn.md
@@ -5,7 +5,7 @@ weight = 3
## 描述
-`DROP READWRITE_SPLITTING RULE` 语法用于为指定逻辑库删除读写分离。
+`DROP READWRITE_SPLITTING RULE` 语法用于从当前逻辑库中删除读写分离规则。
### 语法定义
@@ -13,7 +13,7 @@ weight = 3
{{% tab name="语法" %}}
```sql
DropReadwriteSplittingRule ::=
- 'DROP' 'READWRITE_SPLITTING' 'RULE' ifExists? ruleName (',' ruleName)* ('FROM' databaseName)?
+ 'DROP' 'READWRITE_SPLITTING' 'RULE' ifExists? ruleName (',' ruleName)*
ifExists ::=
'IF' 'EXISTS'
@@ -21,8 +21,6 @@ ifExists ::=
ruleName ::=
identifier
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="铁路图" %}}
@@ -32,21 +30,20 @@ databaseName ::=
### 补充说明
-- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。 如果也未使用 `DATABASE` 则会提示 `No database selected`；
- `ifExists` 子句用于避免 `Readwrite-splitting rule not exists` 错误。
### 示例
-- 为指定逻辑库删除读写分离规则
+- 删除读写分离规则
```sql
-DROP READWRITE_SPLITTING RULE ms_group_1 FROM readwrite_splitting_db;
+DROP READWRITE_SPLITTING RULE ms_group_1;
```
-- 为当前逻辑库删除读写分离规则
+- 删除多个读写分离规则
```sql
-DROP READWRITE_SPLITTING RULE ms_group_1;
+DROP READWRITE_SPLITTING RULE ms_group_1, ms_group_2;
```
- 使用 `ifExists` 子句删除读写分离规则
@@ -57,8 +54,8 @@ DROP READWRITE_SPLITTING RULE IF EXISTS ms_group_1;
### 保留字
-`DROP`、`READWRITE_SPLITTING`、`RULE`
+`DROP`、`READWRITE_SPLITTING`、`RULE`、`IF`、`EXISTS`
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting/drop-readwrite-splitting-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting/drop-readwrite-splitting-rule.en.md
index a8f474dee56..65fda275a25 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting/drop-readwrite-splitting-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/readwrite-splitting/drop-readwrite-splitting-rule.en.md
@@ -5,7 +5,7 @@ weight = 3
## Description
-The `DROP READWRITE_SPLITTING RULE` syntax is used to drop readwrite-splitting rule for specified database
+The `DROP READWRITE_SPLITTING RULE` syntax is used to drop readwrite-splitting rules from the current database.
### Syntax
@@ -13,7 +13,7 @@ The `DROP READWRITE_SPLITTING RULE` syntax is used to drop readwrite-splitting r
{{% tab name="Grammar" %}}
```sql
DropReadwriteSplittingRule ::=
- 'DROP' 'READWRITE_SPLITTING' 'RULE' ifExists? ruleName (',' ruleName)* ('FROM' databaseName)?
+ 'DROP' 'READWRITE_SPLITTING' 'RULE' ifExists? ruleName (',' ruleName)*
ifExists ::=
'IF' 'EXISTS'
@@ -21,8 +21,6 @@ ifExists ::=
ruleName ::=
identifier
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
@@ -32,21 +30,20 @@ databaseName ::=
### Supplement
-- When `databaseName` is not specified, the default is the currently used `DATABASE`. If `DATABASE` is not used, `No database selected` will be prompted;
- `ifExists` clause is used for avoid `Readwrite-splitting rule not exists` error.
### Example
-- Drop readwrite-splitting rule for specified database
+- Drop readwrite-splitting rule
```sql
-DROP READWRITE_SPLITTING RULE ms_group_1 FROM readwrite_splitting_db;
+DROP READWRITE_SPLITTING RULE ms_group_1;
```
-- Drop readwrite-splitting rule for current database
+- Drop multiple readwrite-splitting rules
```sql
-DROP READWRITE_SPLITTING RULE ms_group_1;
+DROP READWRITE_SPLITTING RULE ms_group_1, ms_group_2;
```
- Drop readwrite-splitting rule with `ifExists` clause
@@ -57,7 +54,7 @@ DROP READWRITE_SPLITTING RULE IF EXISTS ms_group_1;
### Reserved word
-`DROP`, `READWRITE_SPLITTING`, `RULE`
+`DROP`, `READWRITE_SPLITTING`, `RULE`, `IF`, `EXISTS`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.cn.md
index c80513c6f3a..4d53a8f2bcf 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.cn.md
@@ -16,7 +16,7 @@ AlterDefaultShadowAlgorithm ::=
'ALTER' 'DEFAULT' 'SHADOW' 'ALGORITHM' shadowAlgorithm
shadowAlgorithm ::=
- 'TYPE' '(' 'NAME' '=' algorithmType ',' propertiesDefiinition ')'
+ 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
algorithmType ::=
string
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.en.md
index 9528ef0f439..b4a55087f27 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-default-shadow-algorithm.en.md
@@ -16,7 +16,7 @@ AlterDefaultShadowAlgorithm ::=
'ALTER' 'DEFAULT' 'SHADOW' 'ALGORITHM' shadowAlgorithm
shadowAlgorithm ::=
- 'TYPE' '(' 'NAME' '=' algorithmType ',' propertiesDefiinition ')'
+ 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
algorithmType ::=
string
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.cn.md
index 6642b653c72..f1635586e76 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.cn.md
@@ -16,13 +16,13 @@ AlterShadowRule ::=
'ALTER' 'SHADOW' 'RULE' shadowRuleDefinition (',' shadowRuleDefinition)*
shadowRuleDefinition ::=
- ruleName '(' storageUnitMapping shadowTableRule (',' shadowTableRule)* ')'
+ ruleName '(' storageUnitMapping ',' shadowTableRule (',' shadowTableRule)* ')'
storageUnitMapping ::=
'SOURCE' '=' storageUnitName ',' 'SHADOW' '=' storageUnitName
shadowTableRule ::=
- tableName '(' shadowAlgorithm ')'
+ tableName '(' shadowAlgorithm (',' shadowAlgorithm)* ')'
shadowAlgorithm ::=
'TYPE' '(' 'NAME' '=' shadowAlgorithmType ',' propertiesDefinition ')'
@@ -85,4 +85,4 @@ ALTER SHADOW RULE shadow_rule(
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-- [存储单元](https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-proxy/distsql/syntax/rdl/storage-unit-definition/)
\ No newline at end of file
+- [存储单元](https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-proxy/distsql/syntax/rdl/storage-unit-definition/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.en.md
index eefc9585a2a..bfd37e81faa 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule.en.md
@@ -16,13 +16,13 @@ AlterShadowRule ::=
'ALTER' 'SHADOW' 'RULE' shadowRuleDefinition (',' shadowRuleDefinition)*
shadowRuleDefinition ::=
- ruleName '(' storageUnitMapping shadowTableRule (',' shadowTableRule)* ')'
+ ruleName '(' storageUnitMapping ',' shadowTableRule (',' shadowTableRule)* ')'
storageUnitMapping ::=
'SOURCE' '=' storageUnitName ',' 'SHADOW' '=' storageUnitName
shadowTableRule ::=
- tableName '(' shadowAlgorithm ')'
+ tableName '(' shadowAlgorithm (',' shadowAlgorithm)* ')'
shadowAlgorithm ::=
'TYPE' '(' 'NAME' '=' shadowAlgorithmType ',' propertiesDefinition ')'
@@ -87,4 +87,4 @@ ALTER SHADOW RULE shadow_rule(
### Related links
- [Reserved word](/en/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-- [STORAGE UNIT](https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/rdl/storage-unit-definition/)
\ No newline at end of file
+- [STORAGE UNIT](https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/rdl/storage-unit-definition/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.cn.md
index cff98c97ee2..45122af1ee4 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.cn.md
@@ -19,7 +19,7 @@ ifNotExists ::=
'IF' 'NOT' 'EXISTS'
shadowAlgorithm ::=
- 'TYPE' '(' 'NAME' '=' algorithmType ',' propertiesDefiinition ')'
+ 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
algorithmType ::=
string
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.en.md
index 95054878bb4..8f77a92cadb 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-default-shadow-algorithm.en.md
@@ -19,7 +19,7 @@ ifNotExists ::=
'IF' 'NOT' 'EXISTS'
shadowAlgorithm ::=
- 'TYPE' '(' 'NAME' '=' algorithmType ',' propertiesDefiinition ')'
+ 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
algorithmType ::=
string
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.cn.md
index 082ace56c7f..73803e72af3 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.cn.md
@@ -19,13 +19,13 @@ ifNotExists ::=
'IF' 'NOT' 'EXISTS'
shadowRuleDefinition ::=
- ruleName '(' storageUnitMapping shadowTableRule (',' shadowTableRule)* ')'
+ ruleName '(' storageUnitMapping ',' shadowTableRule (',' shadowTableRule)* ')'
storageUnitMapping ::=
'SOURCE' '=' storageUnitName ',' 'SHADOW' '=' storageUnitName
shadowTableRule ::=
- tableName '(' shadowAlgorithm ')'
+ tableName '(' shadowAlgorithm (',' shadowAlgorithm)* ')'
shadowAlgorithm ::=
'TYPE' '(' 'NAME' '=' algorithmType ',' propertiesDefinition ')'
@@ -101,4 +101,4 @@ CREATE SHADOW RULE IF NOT EXISTS shadow_rule(
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-- [存储单元](https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-proxy/distsql/syntax/rdl/storage-unit-definition/)
\ No newline at end of file
+- [存储单元](https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-proxy/distsql/syntax/rdl/storage-unit-definition/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.en.md
index e27c1b1b2a7..1c8d5a83bff 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/create-shadow-rule.en.md
@@ -19,13 +19,13 @@ ifNotExists ::=
'IF' 'NOT' 'EXISTS'
shadowRuleDefinition ::=
- ruleName '(' storageUnitMapping shadowTableRule (',' shadowTableRule)* ')'
+ ruleName '(' storageUnitMapping ',' shadowTableRule (',' shadowTableRule)* ')'
storageUnitMapping ::=
'SOURCE' '=' storageUnitName ',' 'SHADOW' '=' storageUnitName
shadowTableRule ::=
- tableName '(' shadowAlgorithm ')'
+ tableName '(' shadowAlgorithm (',' shadowAlgorithm)* ')'
shadowAlgorithm ::=
'TYPE' '(' 'NAME' '=' algorithmType ',' propertiesDefinition ')'
@@ -103,4 +103,4 @@ CREATE SHADOW RULE IF NOT EXISTS shadow_rule(
### Related links
- [Reserved word](/en/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-- [STORAGE UNIT](https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/rdl/storage-unit-definition/)
\ No newline at end of file
+- [STORAGE UNIT](https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/rdl/storage-unit-definition/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-default-shadow-algorithm.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-default-shadow-algorithm.cn.md
index c8c59d75adb..33e115c6bcb 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-default-shadow-algorithm.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-default-shadow-algorithm.cn.md
@@ -5,7 +5,7 @@ weight = 6
## 描述
-`DROP DEFAULT SHADOW ALGORITHM` 语法用于为指定逻辑库删除默认影子库压测算法。
+`DROP DEFAULT SHADOW ALGORITHM` 语法用于从当前逻辑库中删除默认影子库压测算法。
### 语法定义
@@ -13,13 +13,11 @@ weight = 6
{{% tab name="语法" %}}
```sql
DropDefaultShadowAlgorithm ::=
- 'DROP' 'DEFAULT' 'SHADOW' 'ALGORITHM' ifExists? ('FROM' databaseName)?
+ 'DROP' 'DEFAULT' 'SHADOW' 'ALGORITHM' ifExists?
ifExists ::=
'IF' 'EXISTS'
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="铁路图" %}}
@@ -29,18 +27,11 @@ databaseName ::=
### 补充说明
-- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。 如果也未使用 `DATABASE` 则会提示 `No database selected`；
- `ifExists` 子句用于避免 `Default shadow algorithm not exists` 错误。
### 示例
-- 为指定数据库删除默认影子库压测算法
-
-```sql
-DROP DEFAULT SHADOW ALGORITHM FROM shadow_db;
-```
-
-- 为当前数据库删除默认影子库压测算法
+- 删除默认影子库压测算法
```sql
DROP DEFAULT SHADOW ALGORITHM;
@@ -54,8 +45,8 @@ DROP DEFAULT SHADOW ALGORITHM IF EXISTS;
### 保留字
-`DROP`、`DEFAULT`、`SHADOW`、`ALGORITHM`、`FROM`
+`DROP`、`DEFAULT`、`SHADOW`、`ALGORITHM`、`IF`、`EXISTS`
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-default-shadow-algorithm.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-default-shadow-algorithm.en.md
index cd0ff998e2c..0f49ba1e7a9 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-default-shadow-algorithm.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-default-shadow-algorithm.en.md
@@ -5,7 +5,7 @@ weight = 6
## Description
-The `DROP DEFAULT SHADOW ALGORITHM` syntax is used to drop default shadow algorithm for specified database
+The `DROP DEFAULT SHADOW ALGORITHM` syntax is used to drop the default shadow algorithm from the current database.
### Syntax
@@ -13,13 +13,11 @@ The `DROP DEFAULT SHADOW ALGORITHM` syntax is used to drop default shadow algori
{{% tab name="Grammar" %}}
```sql
DropDefaultShadowAlgorithm ::=
- 'DROP' 'DEFAULT' 'SHADOW' 'ALGORITHM' ifExists? ('FROM' databaseName)?
+ 'DROP' 'DEFAULT' 'SHADOW' 'ALGORITHM' ifExists?
ifExists ::=
'IF' 'EXISTS'
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
@@ -29,18 +27,11 @@ databaseName ::=
### Supplement
-- When databaseName is not specified, the default is the currently used DATABASE. If DATABASE is not used, No database selected will be prompted;
- `ifExists` clause used for avoid `Default shadow algorithm not exists` error.
### Example
-- Drop default shadow algorithm for specified database
-
-```sql
-DROP DEFAULT SHADOW ALGORITHM FROM shadow_db;
-```
-
-- Drop default shadow algorithm for current database
+- Drop default shadow algorithm
```sql
DROP DEFAULT SHADOW ALGORITHM;
@@ -54,7 +45,7 @@ DROP DEFAULT SHADOW ALGORITHM IF EXISTS;
### Reserved word
-`DROP`, `DEFAULT`, `SHODOW`, `ALGORITHM`, `FROM`
+`DROP`, `DEFAULT`, `SHADOW`, `ALGORITHM`, `IF`, `EXISTS`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.cn.md
index 1aac8d8bf2a..8733fbfaeeb 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.cn.md
@@ -5,7 +5,7 @@ weight = 7
## 描述
-`DROP SHADOW ALGORITHM` 语法用于为指定逻辑库删除影子库压测算法。
+`DROP SHADOW ALGORITHM` 语法用于从当前逻辑库中删除影子库压测算法。
### 语法定义
@@ -13,7 +13,7 @@ weight = 7
{{% tab name="语法" %}}
```sql
DropShadowAlgorithm ::=
- 'DROP' 'SHADOW' 'ALGORITHM' ifExists? algorithmName (',' algorithmName)* ('FROM' databaseName)?
+ 'DROP' 'SHADOW' 'ALGORITHM' ifExists? algorithmName (',' algorithmName)*
ifExists ::=
'IF' 'EXISTS'
@@ -21,8 +21,6 @@ ifExists ::=
algorithmName ::=
identifier
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="铁路图" %}}
@@ -32,18 +30,17 @@ databaseName ::=
### 补充说明
-- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。 如果也未使用 `DATABASE` 则会提示 `No database selected`；
- `ifExists` 子句用于避免 `shadow algorithm not exists` 错误。
### 示例
-- 为指定数据库删除多个影子库压测算法
+- 删除多个影子库压测算法
```sql
-DROP SHADOW ALGORITHM shadow_rule_t_order_sql_hint_0, shadow_rule_t_order_item_sql_hint_0 FROM shadow_db;
+DROP SHADOW ALGORITHM shadow_rule_t_order_sql_hint_0, shadow_rule_t_order_item_sql_hint_0;
```
-- 为当前数据库删除单个影子库压测算法
+- 删除单个影子库压测算法
```sql
DROP SHADOW ALGORITHM shadow_rule_t_order_sql_hint_0;
@@ -57,8 +54,8 @@ DROP SHADOW ALGORITHM IF EXISTS shadow_rule_t_order_sql_hint_0;
### 保留字
-`DROP`、`SHADOW`、`ALGORITHM`、`FROM`
+`DROP`、`SHADOW`、`ALGORITHM`、`IF`、`EXISTS`
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.en.md
index f1a487a3871..4ae8efc92fc 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-algorithm.en.md
@@ -5,7 +5,7 @@ weight = 7
## Description
-The `DROP SHADOW ALGORITHM` syntax is used to drop shadow algorithm for specified database
+The `DROP SHADOW ALGORITHM` syntax is used to drop shadow algorithms from the current database.
### Syntax
@@ -13,7 +13,7 @@ The `DROP SHADOW ALGORITHM` syntax is used to drop shadow algorithm for specifie
{{% tab name="Grammar" %}}
```sql
DropShadowAlgorithm ::=
- 'DROP' 'SHADOW' 'ALGORITHM' ifExists? algorithmName (',' algorithmName)* ('FROM' databaseName)?
+ 'DROP' 'SHADOW' 'ALGORITHM' ifExists? algorithmName (',' algorithmName)*
ifExists ::=
'IF' 'EXISTS'
@@ -21,8 +21,6 @@ ifExists ::=
algorithmName ::=
identifier
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
@@ -32,18 +30,17 @@ databaseName ::=
### Supplement
-- When databaseName is not specified, the default is the currently used DATABASE. If DATABASE is not used, No database selected will be prompted;
- `ifExists` clause is used for avoid `shadow algorithm not exists` error.
### Example
-- Drop mutiple shadow algorithm for specified database
+- Drop multiple shadow algorithms
```sql
-DROP SHADOW ALGORITHM shadow_rule_t_order_sql_hint_0, shadow_rule_t_order_item_sql_hint_0 FROM shadow_db;
+DROP SHADOW ALGORITHM shadow_rule_t_order_sql_hint_0, shadow_rule_t_order_item_sql_hint_0;
```
-- Drop single shadow algorithm for current database
+- Drop a shadow algorithm
```sql
DROP SHADOW ALGORITHM shadow_rule_t_order_sql_hint_0;
@@ -57,7 +54,7 @@ DROP SHADOW ALGORITHM IF EXISTS shadow_rule_t_order_sql_hint_0;
### Reserved word
-`DROP`, `SHODOW`, `ALGORITHM`, `FROM`
+`DROP`, `SHADOW`, `ALGORITHM`, `IF`, `EXISTS`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-rule.cn.md
index cb0cab56985..c1e5e9826a7 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-rule.cn.md
@@ -5,7 +5,7 @@ weight = 3
## 描述
-`DROP SHADOW RULE` 语法用于为指定逻辑库删除影子库压测规则。
+`DROP SHADOW RULE` 语法用于从当前逻辑库中删除影子库压测规则。
### 语法定义
@@ -13,7 +13,7 @@ weight = 3
{{% tab name="语法" %}}
```sql
DropShadowRule ::=
- 'DROP' 'SHADOW' 'RULE' ifExists? ruleName ('FROM' databaseName)?
+ 'DROP' 'SHADOW' 'RULE' ifExists? ruleName (',' ruleName)*
ifExists ::=
'IF' 'EXISTS'
@@ -21,8 +21,6 @@ ifExists ::=
ruleName ::=
identifier
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="铁路图" %}}
@@ -32,21 +30,20 @@ databaseName ::=
### 补充说明
-- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。 如果也未使用 `DATABASE` 则会提示 `No database selected`；
- `ifExists` 子句用于避免 `Shadow rule not exists` 错误。
### 示例
-- 为指定数据库删除影子库压测规则
+- 删除影子库压测规则
```sql
-DROP SHADOW RULE shadow_rule FROM shadow_db;
+DROP SHADOW RULE shadow_rule;
```
-- 为当前数据库删除影子库压测规则
+- 删除多个影子库压测规则
```sql
-DROP SHADOW RULE shadow_rule;
+DROP SHADOW RULE shadow_rule, shadow_rule_1;
```
- 使用 `ifExists` 子句删除影子库压测规则
@@ -57,8 +54,8 @@ DROP SHADOW RULE IF EXISTS shadow_rule;
### 保留字
-`DROP`、`SHADOW`、`RULE`、`FROM`
+`DROP`、`SHADOW`、`RULE`、`IF`、`EXISTS`
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-rule.en.md
index 012f53acece..705c7120ef1 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/drop-shadow-rule.en.md
@@ -5,7 +5,7 @@ weight = 3
## Description
-The `DROP SHADOW RULE` syntax is used to drop shadow rule for specified database
+The `DROP SHADOW RULE` syntax is used to drop shadow rules from the current database.
### Syntax
@@ -13,7 +13,7 @@ The `DROP SHADOW RULE` syntax is used to drop shadow rule for specified database
{{% tab name="Grammar" %}}
```sql
DropShadowRule ::=
- 'DROP' 'SHADOW' 'RULE' ifExists? ruleName ('FROM' databaseName)?
+ 'DROP' 'SHADOW' 'RULE' ifExists? ruleName (',' ruleName)*
ifExists ::=
'IF' 'EXISTS'
@@ -21,8 +21,6 @@ ifExists ::=
ruleName ::=
identifier
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
@@ -32,21 +30,20 @@ databaseName ::=
### Supplement
-- When databaseName is not specified, the default is the currently used DATABASE. If DATABASE is not used, No database selected will be prompted;
- `ifExists` clause is used for avoid `Shadow rule not exists` error.
### Example
-- Drop shadow rule for specified database
+- Drop shadow rule
```sql
-DROP SHADOW RULE shadow_rule FROM shadow_db;
+DROP SHADOW RULE shadow_rule;
```
-- Drop shadow rule for current database
+- Drop multiple shadow rules
```sql
-DROP SHADOW RULE shadow_rule;
+DROP SHADOW RULE shadow_rule, shadow_rule_1;
```
- Drop shadow rule with `ifExists` clause
@@ -57,7 +54,7 @@ DROP SHADOW RULE IF EXISTS shadow_rule;
### Reserved word
-`DROP`, `SHODOW`, `RULE`, `FROM`
+`DROP`, `SHADOW`, `RULE`, `IF`, `EXISTS`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-default-sharding-strategy.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-default-sharding-strategy.cn.md
index cfb99eb0b60..7fe68a443db 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-default-sharding-strategy.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-default-sharding-strategy.cn.md
@@ -16,13 +16,16 @@ AlterDefaultShardingStrategy ::=
'ALTER' 'DEFAULT' 'SHARDING' ('DATABASE' | 'TABLE') 'STRATEGY' '(' shardingStrategy ')'
shardingStrategy ::=
- 'TYPE' '=' strategyType ',' ('SHARDING_COLUMN' '=' columnName | 'SHARDING_COLUMNS' '=' columnNames) ',' 'SHARDING_ALGORITHM' '=' algorithmDefinition
+ 'TYPE' '=' strategyType ((',' ('SHARDING_COLUMN' '=' columnName | 'SHARDING_COLUMNS' '=' columnNames))? ',' shardingAlgorithm)?
strategyType ::=
- string
+ string | 'STANDARD' | 'COMPLEX' | 'HINT' | 'NONE'
+
+shardingAlgorithm ::=
+ 'SHARDING_ALGORITHM' '(' algorithmDefinition ')'
algorithmDefinition ::=
- 'TYPE' '(' 'NAME' '=' algorithmType ',' propertiesDefinition ')'
+ 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
columnNames ::=
columnName (',' columnName)+
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-default-sharding-strategy.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-default-sharding-strategy.en.md
index 20c3806751c..b6e3cd794c8 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-default-sharding-strategy.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-default-sharding-strategy.en.md
@@ -16,13 +16,16 @@ AlterDefaultShardingStrategy ::=
'ALTER' 'DEFAULT' 'SHARDING' ('DATABASE' | 'TABLE') 'STRATEGY' '(' shardingStrategy ')'
shardingStrategy ::=
- 'TYPE' '=' strategyType ',' ('SHARDING_COLUMN' '=' columnName | 'SHARDING_COLUMNS' '=' columnNames) ',' 'SHARDING_ALGORITHM' '=' algorithmDefinition
+ 'TYPE' '=' strategyType ((',' ('SHARDING_COLUMN' '=' columnName | 'SHARDING_COLUMNS' '=' columnNames))? ',' shardingAlgorithm)?
strategyType ::=
- string
+ string | 'STANDARD' | 'COMPLEX' | 'HINT' | 'NONE'
+
+shardingAlgorithm ::=
+ 'SHARDING_ALGORITHM' '(' algorithmDefinition ')'
algorithmDefinition ::=
- 'TYPE' '(' 'NAME' '=' algorithmType ',' propertiesDefinition ')'
+ 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
columnNames ::=
columnName (',' columnName)+
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-sharding-table-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-sharding-table-rule.cn.md
index 88783b428b0..375640fb8e8 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-sharding-table-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-sharding-table-rule.cn.md
@@ -16,10 +16,10 @@ AlterShardingTableRule ::=
'ALTER' 'SHARDING' 'TABLE' 'RULE' (tableRuleDefinition | autoTableRuleDefinition) (',' (tableRuleDefinition | autoTableRuleDefinition))*
tableRuleDefinition ::=
- ruleName '(' 'DATANODES' '(' dataNode (',' dataNode)* ')' (',' 'DATABASE_STRATEGY' '(' strategyDefinition ')')? (',' 'TABLE_STRATEGY' '(' strategyDefinition ')')? (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' 'AUDIT_STRATEGY' '(' auditStrategyDefinition ')')? ')'
+ ruleName '(' 'DATANODES' '(' dataNode (',' dataNode)* ')' (',' 'DATABASE_STRATEGY' '(' strategyDefinition ')')? (',' 'TABLE_STRATEGY' '(' strategyDefinition ')')? (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' auditStrategyDefinition)? ')'
autoTableRuleDefinition ::=
- ruleName '(' 'STORAGE_UNITS' '(' storageUnitName (',' storageUnitName)* ')' ',' 'SHARDING_COLUMN' '=' columnName ',' algorithmDefinition (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' 'AUDIT_STRATEGY' '(' auditStrategyDefinition ')')? ')'
+ ruleName '(' 'STORAGE_UNITS' '(' storageUnitName (',' storageUnitName)* ')' ',' 'SHARDING_COLUMN' '=' columnName ',' algorithmDefinition (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' auditStrategyDefinition)? ')'
strategyDefinition ::=
'TYPE' '=' strategyType ',' ('SHARDING_COLUMN' | 'SHARDING_COLUMNS') '=' columnName ',' algorithmDefinition
@@ -32,7 +32,10 @@ keyGenerateAlgorithmDefinition ::=
| 'GENERATOR' '=' keyGeneratorName
auditStrategyDefinition ::=
- 'AUDIT_STRATEGY' '(' algorithmDefinition (',' algorithmDefinition)* ')'
+ 'AUDIT_STRATEGY' '(' algorithmDefinition (',' algorithmDefinition)* ',' 'ALLOW_HINT_DISABLE' '=' boolean ')'
+
+boolean ::=
+ 'TRUE' | 'FALSE'
algorithmDefinition ::=
'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)?')'
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-sharding-table-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-sharding-table-rule.en.md
index 08067bd0fed..128f73fbdbc 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-sharding-table-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/alter-sharding-table-rule.en.md
@@ -16,10 +16,10 @@ AlterShardingTableRule ::=
'ALTER' 'SHARDING' 'TABLE' 'RULE' (tableRuleDefinition | autoTableRuleDefinition) (',' (tableRuleDefinition | autoTableRuleDefinition))*
tableRuleDefinition ::=
- ruleName '(' 'DATANODES' '(' dataNode (',' dataNode)* ')' (',' 'DATABASE_STRATEGY' '(' strategyDefinition ')')? (',' 'TABLE_STRATEGY' '(' strategyDefinition ')')? (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' 'AUDIT_STRATEGY' '(' auditStrategyDefinition ')')? ')'
+ ruleName '(' 'DATANODES' '(' dataNode (',' dataNode)* ')' (',' 'DATABASE_STRATEGY' '(' strategyDefinition ')')? (',' 'TABLE_STRATEGY' '(' strategyDefinition ')')? (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' auditStrategyDefinition)? ')'
autoTableRuleDefinition ::=
- ruleName '(' 'STORAGE_UNITS' '(' storageUnitName (',' storageUnitName)* ')' ',' 'SHARDING_COLUMN' '=' columnName ',' algorithmDefinition (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' 'AUDIT_STRATEGY' '(' auditStrategyDefinition ')')? ')'
+ ruleName '(' 'STORAGE_UNITS' '(' storageUnitName (',' storageUnitName)* ')' ',' 'SHARDING_COLUMN' '=' columnName ',' algorithmDefinition (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' auditStrategyDefinition)? ')'
strategyDefinition ::=
'TYPE' '=' strategyType ',' ('SHARDING_COLUMN' | 'SHARDING_COLUMNS') '=' columnName ',' algorithmDefinition
@@ -32,7 +32,10 @@ keyGenerateAlgorithmDefinition ::=
| 'GENERATOR' '=' keyGeneratorName
auditStrategyDefinition ::=
- 'AUDIT_STRATEGY' '(' algorithmDefinition (',' algorithmDefinition)* ')'
+ 'AUDIT_STRATEGY' '(' algorithmDefinition (',' algorithmDefinition)* ',' 'ALLOW_HINT_DISABLE' '=' boolean ')'
+
+boolean ::=
+ 'TRUE' | 'FALSE'
algorithmDefinition ::=
'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)?')'
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-default-sharding-strategy.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-default-sharding-strategy.cn.md
index a89c7bb9eb5..1784e59212d 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-default-sharding-strategy.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-default-sharding-strategy.cn.md
@@ -19,13 +19,16 @@ ifNotExists ::=
'IF' 'NOT' 'EXISTS'
shardingStrategy ::=
- 'TYPE' '=' strategyType ',' ('SHARDING_COLUMN' '=' columnName | 'SHARDING_COLUMNS' '=' columnNames) ',' 'SHARDING_ALGORITHM' '=' algorithmDefinition
+ 'TYPE' '=' strategyType ((',' ('SHARDING_COLUMN' '=' columnName | 'SHARDING_COLUMNS' '=' columnNames))? ',' shardingAlgorithm)?
strategyType ::=
- string
+ string | 'STANDARD' | 'COMPLEX' | 'HINT' | 'NONE'
+
+shardingAlgorithm ::=
+ 'SHARDING_ALGORITHM' '(' algorithmDefinition ')'
algorithmDefinition ::=
- 'TYPE' '(' 'NAME' '=' algorithmType ',' propertiesDefinition ')'
+ 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
columnNames ::=
columnName (',' columnName)+
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-default-sharding-strategy.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-default-sharding-strategy.en.md
index b304a59d13f..df171601f77 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-default-sharding-strategy.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-default-sharding-strategy.en.md
@@ -19,13 +19,16 @@ ifNotExists ::=
'IF' 'NOT' 'EXISTS'
shardingStrategy ::=
- 'TYPE' '=' strategyType ',' ('SHARDING_COLUMN' '=' columnName | 'SHARDING_COLUMNS' '=' columnNames) ',' 'SHARDING_ALGORITHM' '=' algorithmDefinition
+ 'TYPE' '=' strategyType ((',' ('SHARDING_COLUMN' '=' columnName | 'SHARDING_COLUMNS' '=' columnNames))? ',' shardingAlgorithm)?
strategyType ::=
- string
+ string | 'STANDARD' | 'COMPLEX' | 'HINT' | 'NONE'
+
+shardingAlgorithm ::=
+ 'SHARDING_ALGORITHM' '(' algorithmDefinition ')'
algorithmDefinition ::=
- 'TYPE' '(' 'NAME' '=' algorithmType ',' propertiesDefinition ')'
+ 'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)? ')'
columnNames ::=
columnName (',' columnName)+
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-sharding-table-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-sharding-table-rule.cn.md
index 8c49097ef10..c308a27729f 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-sharding-table-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-sharding-table-rule.cn.md
@@ -19,10 +19,10 @@ ifNotExists ::=
'IF' 'NOT' 'EXISTS'
tableRuleDefinition ::=
- ruleName '(' 'DATANODES' '(' dataNode (',' dataNode)* ')' (',' 'DATABASE_STRATEGY' '(' strategyDefinition ')')? (',' 'TABLE_STRATEGY' '(' strategyDefinition ')')? (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' 'AUDIT_STRATEGY' '(' auditStrategyDefinition ')')? ')'
+ ruleName '(' 'DATANODES' '(' dataNode (',' dataNode)* ')' (',' 'DATABASE_STRATEGY' '(' strategyDefinition ')')? (',' 'TABLE_STRATEGY' '(' strategyDefinition ')')? (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' auditStrategyDefinition)? ')'
autoTableRuleDefinition ::=
- ruleName '(' 'STORAGE_UNITS' '(' storageUnitName (',' storageUnitName)* ')' ',' 'SHARDING_COLUMN' '=' columnName ',' algorithmDefinition (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' 'AUDIT_STRATEGY' '(' auditStrategyDefinition ')')? ')'
+ ruleName '(' 'STORAGE_UNITS' '(' storageUnitName (',' storageUnitName)* ')' ',' 'SHARDING_COLUMN' '=' columnName ',' algorithmDefinition (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' auditStrategyDefinition)? ')'
strategyDefinition ::=
'TYPE' '=' strategyType ',' ('SHARDING_COLUMN' | 'SHARDING_COLUMNS') '=' columnName ',' algorithmDefinition
@@ -35,7 +35,10 @@ keyGenerateAlgorithmDefinition ::=
| 'GENERATOR' '=' keyGeneratorName
auditStrategyDefinition ::=
- 'AUDIT_STRATEGY' '(' algorithmDefinition (',' algorithmDefinition)* ')'
+ 'AUDIT_STRATEGY' '(' algorithmDefinition (',' algorithmDefinition)* ',' 'ALLOW_HINT_DISABLE' '=' boolean ')'
+
+boolean ::=
+ 'TRUE' | 'FALSE'
algorithmDefinition ::=
'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)?')'
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-sharding-table-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-sharding-table-rule.en.md
index 3401ae3afdc..a7f4a9337fb 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-sharding-table-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/create-sharding-table-rule.en.md
@@ -19,10 +19,10 @@ ifNotExists ::=
'IF' 'NOT' 'EXISTS'
tableRuleDefinition ::=
- ruleName '(' 'DATANODES' '(' dataNode (',' dataNode)* ')' (',' 'DATABASE_STRATEGY' '(' strategyDefinition ')')? (',' 'TABLE_STRATEGY' '(' strategyDefinition ')')? (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' 'AUDIT_STRATEGY' '(' auditStrategyDefinition ')')? ')'
+ ruleName '(' 'DATANODES' '(' dataNode (',' dataNode)* ')' (',' 'DATABASE_STRATEGY' '(' strategyDefinition ')')? (',' 'TABLE_STRATEGY' '(' strategyDefinition ')')? (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' auditStrategyDefinition)? ')'
autoTableRuleDefinition ::=
- ruleName '(' 'STORAGE_UNITS' '(' storageUnitName (',' storageUnitName)* ')' ',' 'SHARDING_COLUMN' '=' columnName ',' algorithmDefinition (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' 'AUDIT_STRATEGY' '(' auditStrategyDefinition ')')? ')'
+ ruleName '(' 'STORAGE_UNITS' '(' storageUnitName (',' storageUnitName)* ')' ',' 'SHARDING_COLUMN' '=' columnName ',' algorithmDefinition (',' 'KEY_GENERATE_STRATEGY' '(' keyGenerateStrategyDefinition ')')? (',' auditStrategyDefinition)? ')'
strategyDefinition ::=
'TYPE' '=' strategyType ',' ('SHARDING_COLUMN' | 'SHARDING_COLUMNS') '=' columnName ',' algorithmDefinition
@@ -35,7 +35,10 @@ keyGenerateAlgorithmDefinition ::=
| 'GENERATOR' '=' keyGeneratorName
auditStrategyDefinition ::=
- 'AUDIT_STRATEGY' '(' algorithmDefinition (',' algorithmDefinition)* ')'
+ 'AUDIT_STRATEGY' '(' algorithmDefinition (',' algorithmDefinition)* ',' 'ALLOW_HINT_DISABLE' '=' boolean ')'
+
+boolean ::=
+ 'TRUE' | 'FALSE'
algorithmDefinition ::=
'TYPE' '(' 'NAME' '=' algorithmType (',' propertiesDefinition)?')'
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-default-sharding-strategy.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-default-sharding-strategy.cn.md
index b0f39272e20..68cb9bf9ee9 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-default-sharding-strategy.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-default-sharding-strategy.cn.md
@@ -5,7 +5,7 @@ weight = 6
## 描述
-`DROP DEFAULT SHARDING STRATEGY` 语法用于删除指定逻辑库的默认分片策略。
+`DROP DEFAULT SHARDING STRATEGY` 语法用于从当前逻辑库中删除默认分片策略。
### 语法定义
@@ -13,13 +13,11 @@ weight = 6
{{% tab name="语法" %}}
```sql
DropDefaultShardingStrategy ::=
- 'DROP' 'DEFAULT' 'SHARDING' ('TABLE' | 'DATABASE') 'STRATEGY' ifExists? ('FROM' databaseName)?
+ 'DROP' 'DEFAULT' 'SHARDING' ('TABLE' | 'DATABASE') 'STRATEGY' ifExists?
ifExists ::=
'IF' 'EXISTS'
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="铁路图" %}}
@@ -29,18 +27,17 @@ databaseName ::=
### 补充说明
-- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。 如果也未使用 `DATABASE` 则会提示 `No database selected`；
- `ifExists` 子句用于避免 `Default sharding strategy not exists` 错误。
### 示例
-- 为指定逻辑库删除默认表分片策略
+- 删除默认表分片策略
```sql
-DROP DEFAULT SHARDING TABLE STRATEGY FROM sharding_db;
+DROP DEFAULT SHARDING TABLE STRATEGY;
```
-- 为当前逻辑库删除默认库分片策略
+- 删除默认库分片策略
```sql
DROP DEFAULT SHARDING DATABASE STRATEGY;
@@ -60,7 +57,7 @@ DROP DEFAULT SHARDING DATABASE STRATEGY IF EXISTS;
### 保留字
-`DROP`、`DEFAULT`、`SHARDING`、`TABLE`、`DATABASE`、`STRATEGY`、`FROM`
+`DROP`、`DEFAULT`、`SHARDING`、`TABLE`、`DATABASE`、`STRATEGY`、`IF`、`EXISTS`
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-default-sharding-strategy.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-default-sharding-strategy.en.md
index a2aad12b72d..f762845dc1a 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-default-sharding-strategy.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-default-sharding-strategy.en.md
@@ -5,7 +5,7 @@ weight = 6
## Description
-The `DROP DEFAULT SHARDING STRATEGY` syntax is used to drop default sharding strategy for specified database.
+The `DROP DEFAULT SHARDING STRATEGY` syntax is used to drop the default sharding strategy from the current database.
### Syntax
@@ -13,13 +13,11 @@ The `DROP DEFAULT SHARDING STRATEGY` syntax is used to drop default sharding str
{{% tab name="Grammar" %}}
```sql
DropDefaultShardingStrategy ::=
- 'DROP' 'DEFAULT' 'SHARDING' ('TABLE' | 'DATABASE') 'STRATEGY' ifExists? ('FROM' databaseName)?
+ 'DROP' 'DEFAULT' 'SHARDING' ('TABLE' | 'DATABASE') 'STRATEGY' ifExists?
ifExists ::=
'IF' 'EXISTS'
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
@@ -29,18 +27,17 @@ databaseName ::=
### Supplement
-- When `databaseName` is not specified, the default is the currently used `DATABASE`. If `DATABASE` is not used, `No database selected` will be prompted;
- `ifExists` clause is used for avoid `Default sharding strategy not exists` error.
### Example
-- Drop default sharding table strategy for specified database
+- Drop default sharding table strategy
```sql
-DROP DEFAULT SHARDING TABLE STRATEGY FROM sharding_db;
+DROP DEFAULT SHARDING TABLE STRATEGY;
```
-- Drop default sharding database strategy for current database
+- Drop default sharding database strategy
```sql
DROP DEFAULT SHARDING DATABASE STRATEGY;
@@ -60,7 +57,7 @@ DROP DEFAULT SHARDING DATABASE STRATEGY IF EXISTS;
### Reserved word
-`DROP`, `DEFAULT` , `SHARDING`, `TABLE`, `DATABASE` ,`STRATEGY`, `FROM`
+`DROP`, `DEFAULT`, `SHARDING`, `TABLE`, `DATABASE`, `STRATEGY`, `IF`, `EXISTS`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-algorithm.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-algorithm.cn.md
index 11e19b57fab..48ceafc0c8c 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-algorithm.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-algorithm.cn.md
@@ -5,7 +5,7 @@ weight = 11
## 描述
-`DROP SHARDING ALGORITHM` 语法用于删除指定逻辑库的指定分片算法。
+`DROP SHARDING ALGORITHM` 语法用于从当前逻辑库中删除分片算法。
### 语法定义
@@ -13,7 +13,7 @@ weight = 11
{{% tab name="语法" %}}
```sql
DropShardingAlgorithm ::=
- 'DROP' 'SHARDING' 'ALGORITHM' algorithmName ifExists? ('FROM' databaseName)?
+ 'DROP' 'SHARDING' 'ALGORITHM' ifExists? algorithmName (',' algorithmName)*
ifExists ::=
'IF' 'EXISTS'
@@ -21,8 +21,6 @@ ifExists ::=
algorithmName ::=
identifier
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="铁路图" %}}
@@ -32,21 +30,20 @@ databaseName ::=
### 补充说明
-- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。 如果也未使用 `DATABASE` 则会提示 `No database selected`；
- `ifExists` 子句用于避免 `Sharding algorithm not exists` 错误。
### 示例
-- 删除指定逻辑库的指定分片算法
+- 删除分片算法
```sql
-DROP SHARDING ALGORITHM t_order_hash_mod FROM sharding_db;
+DROP SHARDING ALGORITHM t_order_hash_mod;
```
-- 删除当前逻辑库的指定分片算法
+- 删除多个分片算法
```sql
-DROP SHARDING ALGORITHM t_order_hash_mod;
+DROP SHARDING ALGORITHM t_order_hash_mod, t_item_hash_mod;
```
- 使用 `ifExists` 子句删除分片算法
@@ -57,8 +54,8 @@ DROP SHARDING ALGORITHM IF EXISTS t_order_hash_mod;
### 保留字
-`DROP`、`SHARDING`、`ALGORITHM`、`FROM`
+`DROP`、`SHARDING`、`ALGORITHM`、`IF`、`EXISTS`
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-algorithm.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-algorithm.en.md
index 7efeb24ab4a..ed342b953a7 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-algorithm.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-algorithm.en.md
@@ -5,7 +5,7 @@ weight = 11
## Description
-The `DROP SHARDING ALGORITHM` syntax is used to drop sharding algorithm for specified database.
+The `DROP SHARDING ALGORITHM` syntax is used to drop sharding algorithms from the current database.
### Syntax
@@ -13,7 +13,7 @@ The `DROP SHARDING ALGORITHM` syntax is used to drop sharding algorithm for spec
{{% tab name="Grammar" %}}
```sql
DropShardingAlgorithm ::=
- 'DROP' 'SHARDING' 'ALGORITHM' algorithmName ifExists? ('FROM' databaseName)?
+ 'DROP' 'SHARDING' 'ALGORITHM' ifExists? algorithmName (',' algorithmName)*
ifExists ::=
'IF' 'EXISTS'
@@ -21,8 +21,6 @@ ifExists ::=
algorithmName ::=
identifier
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
@@ -32,21 +30,20 @@ databaseName ::=
### Supplement
-- When `databaseName` is not specified, the default is the currently used `DATABASE`. If `DATABASE` is not used, `No database selected` will be prompted;
- `ifExists` clause used for avoid `Sharding algorithm not exists` error.
### Example
-- Drop sharding algorithm for specified database
+- Drop sharding algorithm
```sql
-DROP SHARDING ALGORITHM t_order_hash_mod FROM sharding_db;
+DROP SHARDING ALGORITHM t_order_hash_mod;
```
-- Drop sharding algorithm for current database
+- Drop multiple sharding algorithms
```sql
-DROP SHARDING ALGORITHM t_order_hash_mod;
+DROP SHARDING ALGORITHM t_order_hash_mod, t_item_hash_mod;
```
- Drop sharding algorithm with `ifExists` clause
@@ -57,7 +54,7 @@ DROP SHARDING ALGORITHM IF EXISTS t_order_hash_mod;
### Reserved word
-`DROP`, `SHARDING`, `ALGORITHM`, `FROM`
+`DROP`, `SHARDING`, `ALGORITHM`, `IF`, `EXISTS`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-auditor.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-auditor.cn.md
new file mode 100644
index 00000000000..d428c431409
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-auditor.cn.md
@@ -0,0 +1,55 @@
++++
+title = "DROP SHARDING AUDITOR"
+weight = 17
++++
+
+## 描述
+
+`DROP SHARDING AUDITOR` 语法用于从当前逻辑库中删除分片审计算法。
+
+### 语法
+
+{{< tabs >}}
+{{% tab name="语法" %}}
+```sql
+DropShardingAuditor ::=
+ 'DROP' 'SHARDING' 'AUDITOR' ifExists? auditorName (',' auditorName)*
+
+ifExists ::=
+ 'IF' 'EXISTS'
+
+auditorName ::=
+ identifier
+```
+{{% /tab %}}
+{{% tab name="铁路图" %}}
+<iframe frameborder="0" name="diagram" id="diagram" width="100%" height="100%"></iframe>
+{{% /tab %}}
+{{< /tabs >}}
+
+### 补充说明
+
+- `ifExists` 子句用于避免 `Sharding auditor not exists` 错误。
+- 分片表规则或默认审计策略正在引用的分片审计算法不能被删除。
+
+### 示例
+
+- 删除分片审计算法
+
+```sql
+DROP SHARDING AUDITOR sharding_key_required_auditor;
+```
+
+- 使用 `ifExists` 子句删除多个分片审计算法
+
+```sql
+DROP SHARDING AUDITOR IF EXISTS sharding_key_required_auditor, custom_auditor;
+```
+
+### 保留字
+
+`DROP`、`SHARDING`、`AUDITOR`、`IF`、`EXISTS`
+
+### 相关链接
+
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-auditor.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-auditor.en.md
new file mode 100644
index 00000000000..5ebdee80fcb
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-auditor.en.md
@@ -0,0 +1,55 @@
++++
+title = "DROP SHARDING AUDITOR"
+weight = 17
++++
+
+## Description
+
+The `DROP SHARDING AUDITOR` syntax is used to drop sharding auditors from the current database.
+
+### Syntax
+
+{{< tabs >}}
+{{% tab name="Grammar" %}}
+```sql
+DropShardingAuditor ::=
+ 'DROP' 'SHARDING' 'AUDITOR' ifExists? auditorName (',' auditorName)*
+
+ifExists ::=
+ 'IF' 'EXISTS'
+
+auditorName ::=
+ identifier
+```
+{{% /tab %}}
+{{% tab name="Railroad diagram" %}}
+<iframe frameborder="0" name="diagram" id="diagram" width="100%" height="100%"></iframe>
+{{% /tab %}}
+{{< /tabs >}}
+
+### Supplement
+
+- `ifExists` clause is used to avoid a `Sharding auditor not exists` error.
+- Sharding auditors referenced by sharding table rules or the default audit strategy cannot be dropped.
+
+### Example
+
+- Drop a sharding auditor
+
+```sql
+DROP SHARDING AUDITOR sharding_key_required_auditor;
+```
+
+- Drop multiple sharding auditors with `ifExists` clause
+
+```sql
+DROP SHARDING AUDITOR IF EXISTS sharding_key_required_auditor, custom_auditor;
+```
+
+### Reserved word
+
+`DROP`, `SHARDING`, `AUDITOR`, `IF`, `EXISTS`
+
+### Related links
+
+- [Reserved word](/en/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-key-generator.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-key-generator.cn.md
index f301b8c8630..3e2fedfacd7 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-key-generator.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-key-generator.cn.md
@@ -5,7 +5,7 @@ weight = 10
## 描述
-`DROP SHARDING KEY GENERATOR` 语法用于删除指定逻辑库的指定分片主键生成器。
+`DROP SHARDING KEY GENERATOR` 语法用于从当前逻辑库中删除分片主键生成器。
### 语法定义
@@ -13,7 +13,7 @@ weight = 10
{{% tab name="语法" %}}
```sql
DropShardingKeyGenerator ::=
- 'DROP' 'SHARDING' 'KEY' 'GENERATOR' ifExists? keyGeneratorName (keyGeneratorName)* ('FROM' databaseName)?
+ 'DROP' 'SHARDING' 'KEY' 'GENERATOR' ifExists? keyGeneratorName (',' keyGeneratorName)*
ifExists ::=
'IF' 'EXISTS'
@@ -21,8 +21,6 @@ ifExists ::=
keyGeneratorName ::=
identifier
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="铁路图" %}}
@@ -32,21 +30,20 @@ databaseName ::=
### 补充说明
-- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。 如果也未使用 `DATABASE` 则会提示 `No database selected`；
- `ifExists` 子句用于避免 `Sharding key generator not exists` 错误。
### 示例
-- 删除指定逻辑库的指定分片主键生成器
+- 删除分片主键生成器
```sql
-DROP SHARDING KEY GENERATOR t_order_snowflake FROM sharding_db;
+DROP SHARDING KEY GENERATOR t_order_snowflake;
```
-- 删除当前逻辑库的指定分片主键生成器
+- 删除多个分片主键生成器
```sql
-DROP SHARDING KEY GENERATOR t_order_snowflake;
+DROP SHARDING KEY GENERATOR t_order_snowflake, t_item_snowflake;
```
- 使用 `ifExists` 子句删除分片主键生成器
@@ -57,8 +54,8 @@ DROP SHARDING KEY GENERATOR IF EXISTS t_order_snowflake;
### 保留字
-`DROP`、`SHARDING`、`KEY`、`GENERATOR`、`FROM`
+`DROP`、`SHARDING`、`KEY`、`GENERATOR`、`IF`、`EXISTS`
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-key-generator.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-key-generator.en.md
index b39d5ab2627..1d08470ddad 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-key-generator.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-key-generator.en.md
@@ -5,7 +5,7 @@ weight = 10
## Description
-The `DROP SHARDING KEY GENERATOR` syntax is used to drop sharding key generator for specified database.
+The `DROP SHARDING KEY GENERATOR` syntax is used to drop sharding key generators from the current database.
### Syntax
@@ -13,7 +13,7 @@ The `DROP SHARDING KEY GENERATOR` syntax is used to drop sharding key generator
{{% tab name="Grammar" %}}
```sql
DropShardingKeyGenerator ::=
- 'DROP' 'SHARDING' 'KEY' 'GENERATOR' ifExists? keyGeneratorName (keyGeneratorName)* ('FROM' databaseName)?
+ 'DROP' 'SHARDING' 'KEY' 'GENERATOR' ifExists? keyGeneratorName (',' keyGeneratorName)*
ifExists ::=
'IF' 'EXISTS'
@@ -21,8 +21,6 @@ ifExists ::=
keyGeneratorName ::=
identifier
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
@@ -32,21 +30,20 @@ databaseName ::=
### Supplement
-- When `databaseName` is not specified, the default is the currently used `DATABASE`. If `DATABASE` is not used, `No database selected` will be prompted;
- `ifExists` clause is used for avoid `Sharding key generator not exists` error.
### Example
-- Drop sharding key generator for specified database
+- Drop sharding key generator
```sql
-DROP SHARDING KEY GENERATOR t_order_snowflake FROM sharding_db;
+DROP SHARDING KEY GENERATOR t_order_snowflake;
```
-- Drop sharding key generator for current database
+- Drop multiple sharding key generators
```sql
-DROP SHARDING KEY GENERATOR t_order_snowflake;
+DROP SHARDING KEY GENERATOR t_order_snowflake, t_item_snowflake;
```
- Drop sharding key generator with `ifExists` clause
@@ -57,7 +54,7 @@ DROP SHARDING KEY GENERATOR IF EXISTS t_order_snowflake;
### Reserved word
-`DROP`, `SHARDING`, `KEY`, `GENERATOR`, `FROM`
+`DROP`, `SHARDING`, `KEY`, `GENERATOR`, `IF`, `EXISTS`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-table-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-table-rule.cn.md
index 7e8658dc9be..6bef7e3a344 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-table-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-table-rule.cn.md
@@ -5,7 +5,7 @@ weight = 3
## 描述
-`DROP SHARDING TABLE RULE` 语法用于删除指定逻辑库的指定分片规则。
+`DROP SHARDING TABLE RULE` 语法用于从当前逻辑库中删除分片表规则。
### 语法定义
@@ -13,7 +13,7 @@ weight = 3
{{% tab name="语法" %}}
```sql
DropShardingTableRule ::=
- 'DROP' 'SHARDING' 'TABLE' 'RULE' ifExists? ruleName (',' ruleName)* ('FROM' databaseName)?
+ 'DROP' 'SHARDING' 'TABLE' 'RULE' ifExists? ruleName (',' ruleName)*
ifExists ::=
'IF' 'EXISTS'
@@ -21,8 +21,6 @@ ifExists ::=
ruleName ::=
identifier
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="铁路图" %}}
@@ -32,18 +30,17 @@ databaseName ::=
### 补充说明
-- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。 如果也未使用 `DATABASE` 则会提示 `No database selected`；
- `ifExists` 子句用于避免 `Sharding rule not exists` 错误。
### 示例
-- 为指定逻辑库删除多个指定分片规则
+- 删除多个分片表规则
```sql
-DROP SHARDING TABLE RULE t_order, t_order_item FROM sharding_db;
+DROP SHARDING TABLE RULE t_order, t_order_item;
```
-- 为当前逻辑库删除单个指定分片规则
+- 删除单个分片表规则
```sql
DROP SHARDING TABLE RULE t_order;
@@ -57,8 +54,8 @@ DROP SHARDING TABLE RULE IF EXISTS t_order;
### 保留字
-`DROP`、`SHARDING`、`TABLE`、`RULE`、`FROM`
+`DROP`、`SHARDING`、`TABLE`、`RULE`、`IF`、`EXISTS`
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-table-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-table-rule.en.md
index a957167eef4..d030bf31eab 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-table-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/drop-sharding-table-rule.en.md
@@ -5,7 +5,7 @@ weight = 3
## Description
-The `DROP SHARDING TABLE RULE` syntax is used to drop sharding table rule for specified database.
+The `DROP SHARDING TABLE RULE` syntax is used to drop sharding table rules from the current database.
### Syntax
@@ -13,7 +13,7 @@ The `DROP SHARDING TABLE RULE` syntax is used to drop sharding table rule for sp
{{% tab name="Grammar" %}}
```sql
DropShardingTableRule ::=
- 'DROP' 'SHARDING' 'TABLE' 'RULE' ifExists? ruleName (',' ruleName)* ('FROM' databaseName)?
+ 'DROP' 'SHARDING' 'TABLE' 'RULE' ifExists? ruleName (',' ruleName)*
ifExists ::=
'IF' 'EXISTS'
@@ -21,8 +21,6 @@ ifExists ::=
ruleName ::=
identifier
-databaseName ::=
- identifier
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
@@ -32,18 +30,17 @@ databaseName ::=
### Supplement
-- When `databaseName` is not specified, the default is the currently used `DATABASE`. If `DATABASE` is not used, `No database selected` will be prompted;
- `ifExists` clause is used to avoid `Sharding rule not exists` error.
### Example
-- Drop mutiple sharding table rules for specified database
+- Drop multiple sharding table rules
```sql
-DROP SHARDING TABLE RULE t_order, t_order_item FROM sharding_db;
+DROP SHARDING TABLE RULE t_order, t_order_item;
```
-- Drop a sharding table rule for current database
+- Drop a sharding table rule
```sql
DROP SHARDING TABLE RULE t_order;
@@ -57,7 +54,7 @@ DROP SHARDING TABLE RULE IF EXISTS t_order;
### Reserved word
-`DROP`, `SHARDING`, `TABLE`, `RULE`, `FROM`
+`DROP`, `SHARDING`, `TABLE`, `RULE`, `IF`, `EXISTS`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/single-table/unload-single-table.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/single-table/unload-single-table.cn.md
index 5b0639904a3..8fac445ffff 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/single-table/unload-single-table.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/single-table/unload-single-table.cn.md
@@ -14,6 +14,8 @@ weight = 2
```sql
unloadSingleTable ::=
'UNLOAD' 'SINGLE' 'TABLE' tableNames
+ | 'UNLOAD' 'SINGLE' 'TABLE' '*'
+ | 'UNLOAD' 'ALL' 'SINGLE' 'TABLES'
tableNames ::=
tableName (',' tableName)*
@@ -53,4 +55,4 @@ UNLOAD ALL SINGLE TABLES;
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/single-table/unload-single-table.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/single-table/unload-single-table.en.md
index 638349f52a4..a44a586ff8c 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/single-table/unload-single-table.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/single-table/unload-single-table.en.md
@@ -14,6 +14,8 @@ The `UNLOAD SINGLE TABLE` syntax is used to unload single table.
```sql
unloadSingleTable ::=
'UNLOAD' 'SINGLE' 'TABLE' tableNames
+ | 'UNLOAD' 'SINGLE' 'TABLE' '*'
+ | 'UNLOAD' 'ALL' 'SINGLE' 'TABLES'
tableNames ::=
tableName (',' tableName)*
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.cn.md
index e78a30a9533..1d0c61db81f 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.cn.md
@@ -39,10 +39,6 @@ weight = 5
`ENCRYPT`、`COLUMNS`、`CIPHER`、`ENCRYPT_ALGORITHM`
-#### 数据库发现
-
-`DB_DISCOVERY`、`STORAGE_UNITS`、`HEARTBEAT`
-
#### 影子压测
`SHADOW`、`DEFAULT`、`SOURCE`、`SHADOW`
@@ -80,10 +76,6 @@ weight = 5
`ENCRYPT`
-#### 数据库发现
-
-`DB_DISCOVERY`、`TYPES`、`HEARTBEATS`
-
#### 影子压测
`SHADOW`、`ALGORITHMS`
@@ -97,10 +89,10 @@ weight = 5
`ALTER`、`READWRITE_SPLITTING`、`RULE`、`RULES`、`FROM`、`ENABLE`、`DISABLE`、`SHOW`、`COMPUTE`、`NODES`、`NODE`
、`STATUS`、`LABEL`、`RELABEL`、`WITH`、`UNLABEL`、`AUTHORITY`、`TRANSACTION`、`SQL_PARSER`、`SQL_TRANSLATOR`、`DEFAULT`、`TYPE`
、`NAME`、`PROPERTIES`、`USE_ORIGINAL_SQL_WHEN_TRANSLATING_FAILED`、`PARSE_TREE_CACHE`、`INITIAL_CAPACITY`、`MAXIMUM_SIZE`
-、`CONCURRENCY_LEVEL`、`SQL_STATEMENT_CACHE`、`TRAFFIC`、`TRAFFIC_ALGORITHM`、`LOAD_BALANCER`、`CREATE`
+、`CONCURRENCY_LEVEL`、`SQL_STATEMENT_CACHE`、`CREATE`
、`DATABASE_VALUE`、`TABLE_VALUE`、`CLEAR`、`MIGRATION`、`READ`、`WRITE`、`WORKER_THREAD`、`BATCH_SIZE`、`SHARDING_SIZE`
、`STREAM_CHANNEL`、`REGISTER`、`URL`、`UNREGISTER`、`UNITS`、`INTO`、`LIST`、`CHECK`、`BY`、`STOP`、`START`、`ROLLBACK`
-、`COMMIT`、`INFO`、`MODE`、`DIST`、`VARIABLE`、`VARIABLES`、`WHERE`、`DROPSET`、`SET`、`HINT`、`SOURCE`、`ADD`
+、`COMMIT`、`INFO`、`MODE`、`DIST`、`VARIABLE`、`VARIABLES`、`WHERE`、`SET`、`HINT`、`SOURCE`、`ADD`
、`SHARDING`、`STORAGE`、`UNIT`、`USER`、`PASSWORD`、`REFRESH`、`METADATA`、`TABLE`、`DATABASE`、`GOVERNANCE`、`CENTER`
、`EXPORT`、`CONFIGURATION`、`TO`、`FILE`、`IMPORT`、`USED`, `IMPLEMENTATIONS`, `OF`, `KEY`, `GENERATE`, `ALGORITHM`
、`QUERY`、`LOAD`、`BALANCE`, `FEDERATION`, `SQL_FEDERATION_ENABLED`, `ALL_QUERY_USE_SQL_FEDERATION`
@@ -108,7 +100,7 @@ weight = 5
## RUL
-`PARSE`、`FORMAT`、`PREVIEW`
+`PARSE`、`PREVIEW`
## 补充说明
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.en.md
index 3d20784cb6b..c23197621bb 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.en.md
@@ -40,10 +40,6 @@ weight = 5
`ENCRYPT`, `COLUMNS`, `CIPHER`, `ENCRYPT_ALGORITHM`
-#### Database Discovery
-
-`DB_DISCOVERY`, `STORAGE_UNITS`, `HEARTBEAT`
-
#### Shadow
`SHADOW`, `DEFAULT`, `SOURCE`, `SHADOW`
@@ -81,10 +77,6 @@ weight = 5
`ENCRYPT`
-#### Database Discovery
-
-`DB_DISCOVERY`, `TYPES`, `HEARTBEATS`
-
#### Shadow
`SHADOW`, `ALGORITHMS`
@@ -98,10 +90,10 @@ weight = 5
`ALTER`, `READWRITE_SPLITTING`, `RULE`, `RULES`, `FROM`, `ENABLE`, `DISABLE`, `SHOW`, `COMPUTE`, `NODES`, `NODE`
, `STATUS`, `LABEL`, `RELABEL`, `WITH`, `UNLABEL`, `AUTHORITY`, `TRANSACTION`, `SQL_PARSER`, `SQL_TRANSLATOR`, `DEFAULT`, `TYPE`
, `NAME`, `PROPERTIES`, `USE_ORIGINAL_SQL_WHEN_TRANSLATING_FAILED`, `PARSE_TREE_CACHE`, `INITIAL_CAPACITY`, `MAXIMUM_SIZE`
-, `CONCURRENCY_LEVEL`, `SQL_STATEMENT_CACHE`, `TRAFFIC`, `TRAFFIC_ALGORITHM`, `LOAD_BALANCER`, `CREATE`
+, `CONCURRENCY_LEVEL`, `SQL_STATEMENT_CACHE`, `CREATE`
, `DATABASE_VALUE`, `TABLE_VALUE`, `CLEAR`, `MIGRATION`, `READ`, `WRITE`, `WORKER_THREAD`, `BATCH_SIZE`
, `SHARDING_SIZE`, `STREAM_CHANNEL`, `REGISTER`, `URL`, `UNREGISTER`, `UNITS`, `INTO`, `LIST`, `CHECK`, `BY`
-, `STOP`, `START`, `ROLLBACK`, `COMMIT`, `INFO`, `MODE`, `DIST`, `VARIABLE`, `VARIABLES`, `WHERE`, `DROPSET`
+, `STOP`, `START`, `ROLLBACK`, `COMMIT`, `INFO`, `MODE`, `DIST`, `VARIABLE`, `VARIABLES`, `WHERE`
, `SET`, `HINT`, `SOURCE`, `ADD`, `SHARDING`, `STORAGE`, `UNIT`, `USER`, `PASSWORD`, `REFRESH`, `METADATA`, `TABLE`
, `DATABASE`, `GOVERNANCE`, `CENTER`, `EXPORT`, `CONFIGURATION`, `TO`, `FILE`, `IMPORT`, `USED`, `IMPLEMENTATIONS`, `OF`
, `KEY`, `GENERATE`, `ALGORITHM`, `QUERY`, `LOAD`, `BALANCE`, `FEDERATION`, `SQL_FEDERATION_ENABLED`
@@ -109,7 +101,7 @@ weight = 5
## RUL
-`PARSE`, `FORMAT`, `PREVIEW`
+`PARSE`, `PREVIEW`
## Supplement
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/broadcast-table/show-broadcast-table-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/broadcast-table/show-broadcast-table-rule.cn.md
index 79fcef904c0..911bcb4b9a8 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/broadcast-table/show-broadcast-table-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/broadcast-table/show-broadcast-table-rule.cn.md
@@ -1,5 +1,5 @@
+++
-title = "SHOW BROADCAST TABLE RULE"
+title = "SHOW BROADCAST TABLE RULES"
weight = 1
+++
@@ -78,4 +78,4 @@ mysql> SHOW BROADCAST TABLE RULES;
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/broadcast-table/show-broadcast-table-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/broadcast-table/show-broadcast-table-rule.en.md
index 0b3caa54bd3..4dab1355232 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/broadcast-table/show-broadcast-table-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/broadcast-table/show-broadcast-table-rule.en.md
@@ -1,11 +1,11 @@
+++
-title = "SHOW BROADCAST TABLE RULE"
+title = "SHOW BROADCAST TABLE RULES"
weight = 1
+++
## Description
-The `SHOW BROADCAST TABLE RULE` syntax is used to broadcast tables for specified database.
+The `SHOW BROADCAST TABLE RULES` syntax is used to query broadcast table rules for specified database.
### Syntax
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt/show-encrypt-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt/show-encrypt-rule.cn.md
index a16c71bd4fc..a01555aad60 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt/show-encrypt-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt/show-encrypt-rule.cn.md
@@ -13,7 +13,7 @@ weight = 1
{{% tab name="语法" %}}
```sql
ShowEncryptRule::=
- 'SHOW' 'ENCRYPT' ('RULES' | 'TABLE' 'RULE' ruleName) ('FROM' databaseName)?
+ 'SHOW' 'ENCRYPT' ('RULES' | 'TABLE'? 'RULE' ruleName) ('FROM' databaseName)?
ruleName ::=
identifier
@@ -122,4 +122,3 @@ mysql> SHOW ENCRYPT TABLE RULE t_encrypt;
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt/show-encrypt-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt/show-encrypt-rule.en.md
index 121f80fb538..4f3421209f7 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt/show-encrypt-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/encrypt/show-encrypt-rule.en.md
@@ -13,7 +13,7 @@ The `SHOW ENCRYPT RULES` syntax is used to query encryption rules for a specifie
{{% tab name="Grammar" %}}
```sql
ShowEncryptRule::=
- 'SHOW' 'ENCRYPT' ('RULES' | 'TABLE' 'RULE' ruleName) ('FROM' databaseName)?
+ 'SHOW' 'ENCRYPT' ('RULES' | 'TABLE'? 'RULE' ruleName) ('FROM' databaseName)?
ruleName ::=
identifier
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/mask/show-mask-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/mask/show-mask-rule.cn.md
index 5839006b8a1..0f98e5fbbb6 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/mask/show-mask-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/mask/show-mask-rule.cn.md
@@ -13,7 +13,7 @@ weight = 1
{{% tab name="语法" %}}
```sql
ShowMaskRule::=
- 'SHOW' 'MASK' ('RULES' | 'RULE' ruleName) ('FROM' databaseName)?
+ 'SHOW' 'MASK' ('RULES' | 'TABLE'? 'RULE' ruleName) ('FROM' databaseName)?
ruleName ::=
identifier
@@ -88,12 +88,12 @@ SHOW MASK RULE t_mask FROM mask_db;
```sql
mysql> SHOW MASK RULE t_mask FROM mask_db;
-+--------+--------------+------------------+--------------------------------+
-| table | logic_column | mask_algorithm | props |
-+--------+--------------+------------------+--------------------------------+
-| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
-| t_mask | address | MD5 | |
-+--------+--------------+------------------+--------------------------------+
++--------+----------+------------------+--------------------------------+
+| table | column | algorithm_type | algorithm_props |
++--------+----------+------------------+--------------------------------+
+| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
+| t_mask | address | MD5 | |
++--------+----------+------------------+--------------------------------+
2 rows in set (0.00 sec)
```
@@ -105,20 +105,19 @@ SHOW MASK RULE t_mask;
```sql
mysql> SHOW MASK RULE t_mask;
-+--------+--------------+------------------+--------------------------------+
-| table | logic_column | mask_algorithm | props |
-+--------+--------------+------------------+--------------------------------+
-| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
-| t_mask | address | MD5 | |
-+--------+--------------+------------------+--------------------------------+
++--------+----------+------------------+--------------------------------+
+| table | column | algorithm_type | algorithm_props |
++--------+----------+------------------+--------------------------------+
+| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
+| t_mask | address | MD5 | |
++--------+----------+------------------+--------------------------------+
2 rows in set (0.00 sec)
```
### 保留字
-`SHOW`、`MASK`、`RULE`、`RULES`、`FROM`
+`SHOW`、`MASK`、`TABLE`、`RULE`、`RULES`、`FROM`
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/mask/show-mask-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/mask/show-mask-rule.en.md
index 05e4538ab19..15bd1af904c 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/mask/show-mask-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/mask/show-mask-rule.en.md
@@ -13,7 +13,7 @@ The `SHOW MASK RULES` syntax is used to query mask rules for specified database.
{{% tab name="Grammar" %}}
```sql
ShowMaskRule::=
- 'SHOW' 'MASK' ('RULES' | 'RULE' ruleName) ('FROM' databaseName)?
+ 'SHOW' 'MASK' ('RULES' | 'TABLE'? 'RULE' ruleName) ('FROM' databaseName)?
ruleName ::=
identifier
@@ -91,12 +91,12 @@ SHOW MASK RULE t_mask FROM mask_db;
```sql
mysql> SHOW MASK RULE t_mask FROM mask_db;
-+--------+--------------+------------------+--------------------------------+
-| table | logic_column | mask_algorithm | props |
-+--------+--------------+------------------+--------------------------------+
-| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
-| t_mask | address | MD5 | |
-+--------+--------------+------------------+--------------------------------+
++--------+----------+------------------+--------------------------------+
+| table | column | algorithm_type | algorithm_props |
++--------+----------+------------------+--------------------------------+
+| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
+| t_mask | address | MD5 | |
++--------+----------+------------------+--------------------------------+
2 rows in set (0.00 sec)
```
@@ -108,18 +108,18 @@ SHOW MASK RULE t_mask;
```sql
mysql> SHOW MASK RULE t_mask;
-+--------+--------------+------------------+--------------------------------+
-| table | logic_column | mask_algorithm | props |
-+--------+--------------+------------------+--------------------------------+
-| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
-| t_mask | address | MD5 | |
-+--------+--------------+------------------+--------------------------------+
++--------+----------+------------------+--------------------------------+
+| table | column | algorithm_type | algorithm_props |
++--------+----------+------------------+--------------------------------+
+| t_mask | phoneNum | MASK_FROM_X_TO_Y | to-y=2,replace-char=*,from-x=1 |
+| t_mask | address | MD5 | |
++--------+----------+------------------+--------------------------------+
2 rows in set (0.00 sec)
```
### Reserved word
-`SHOW`, `MASK`, `RULE`, `RULES`, `FROM`
+`SHOW`, `MASK`, `TABLE`, `RULE`, `RULES`, `FROM`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-rule.cn.md
index 43821051791..93fd67991db 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-rule.cn.md
@@ -33,12 +33,14 @@ databaseName ::=
### 返回值说明
-| 列 | 说明 |
-|--------------|---------|
-| rule_name | 规则名称 |
-| source_name | 数据源名称 |
-| shadow_name | 影子数据源名称 |
-| shadow_table | 影子表 |
+| 列 | 说明 |
+|-----------------|----------|
+| shadow_table | 影子表 |
+| rule_name | 规则名称 |
+| source_name | 数据源名称 |
+| shadow_name | 影子数据源名称 |
+| algorithm_type | 影子算法类型 |
+| algorithm_props | 影子算法属性 |
### 示例
@@ -50,11 +52,11 @@ SHOW SHADOW RULE shadow_rule FROM shadow_db;
```sql
mysql> SHOW SHADOW RULE shadow_rule FROM shadow_db;
-+-------------+-------------+-------------+----------------------+
-| rule_name | source_name | shadow_name | shadow_table |
-+-------------+-------------+-------------+----------------------+
-| shadow_rule | ds_0 | ds_1 | t_order_item,t_order |
-+-------------+-------------+-------------+----------------------+
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| shadow_table | rule_name | source_name | shadow_name | algorithm_type | algorithm_props |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| t_order | shadow_rule | ds_0 | ds_1 | VALUE_MATCH | column=user_id,operation=insert,value=1 |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
1 row in set (0.00 sec)
```
@@ -66,11 +68,11 @@ SHOW SHADOW RULE shadow_rule;
```sql
mysql> SHOW SHADOW RULE shadow_rule;
-+-------------+-------------+-------------+----------------------+
-| rule_name | source_name | shadow_name | shadow_table |
-+-------------+-------------+-------------+----------------------+
-| shadow_rule | ds_0 | ds_1 | t_order_item,t_order |
-+-------------+-------------+-------------+----------------------+
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| shadow_table | rule_name | source_name | shadow_name | algorithm_type | algorithm_props |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| t_order | shadow_rule | ds_0 | ds_1 | VALUE_MATCH | column=user_id,operation=insert,value=1 |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
1 row in set (0.01 sec)
```
@@ -82,11 +84,11 @@ SHOW SHADOW RULES FROM shadow_db;
```sql
mysql> SHOW SHADOW RULES FROM shadow_db;
-+-------------+-------------+-------------+----------------------+
-| rule_name | source_name | shadow_name | shadow_table |
-+-------------+-------------+-------------+----------------------+
-| shadow_rule | ds_0 | ds_1 | t_order_item,t_order |
-+-------------+-------------+-------------+----------------------+
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| shadow_table | rule_name | source_name | shadow_name | algorithm_type | algorithm_props |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| t_order | shadow_rule | ds_0 | ds_1 | VALUE_MATCH | column=user_id,operation=insert,value=1 |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
1 row in set (0.00 sec)
```
@@ -98,11 +100,11 @@ SHOW SHADOW RULES;
```sql
mysql> SHOW SHADOW RULES;
-+-------------+-------------+-------------+----------------------+
-| rule_name | source_name | shadow_name | shadow_table |
-+-------------+-------------+-------------+----------------------+
-| shadow_rule | ds_0 | ds_1 | t_order_item,t_order |
-+-------------+-------------+-------------+----------------------+
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| shadow_table | rule_name | source_name | shadow_name | algorithm_type | algorithm_props |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| t_order | shadow_rule | ds_0 | ds_1 | VALUE_MATCH | column=user_id,operation=insert,value=1 |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
1 row in set (0.00 sec)
```
@@ -113,4 +115,3 @@ mysql> SHOW SHADOW RULES;
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-rule.en.md
index 6c1429de24f..e21d7a89c67 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-rule.en.md
@@ -33,16 +33,14 @@ databaseName ::=
### Return value description
-| Column | Description |
-|--------------|-------------------------|
-| rule_name | Shadow rule name |
-| source_name | Data source name |
-| shadow_name | Shadow data source name |
-| shadow_table | Shadow table |
-
-
-
-
+| Column | Description |
+|-----------------|-------------------------|
+| shadow_table | Shadow table |
+| rule_name | Shadow rule name |
+| source_name | Data source name |
+| shadow_name | Shadow data source name |
+| algorithm_type | Shadow algorithm type |
+| algorithm_props | Shadow algorithm props |
### Example
- Query specified shadow rule in specified database.
@@ -53,11 +51,11 @@ SHOW SHADOW RULE shadow_rule FROM shadow_db;
```sql
mysql> SHOW SHADOW RULE shadow_rule FROM shadow_db;
-+-------------+-------------+-------------+----------------------+
-| rule_name | source_name | shadow_name | shadow_table |
-+-------------+-------------+-------------+----------------------+
-| shadow_rule | ds_0 | ds_1 | t_order_item,t_order |
-+-------------+-------------+-------------+----------------------+
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| shadow_table | rule_name | source_name | shadow_name | algorithm_type | algorithm_props |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| t_order | shadow_rule | ds_0 | ds_1 | VALUE_MATCH | column=user_id,operation=insert,value=1 |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
1 row in set (0.00 sec)
```
@@ -69,11 +67,11 @@ SHOW SHADOW RULE shadow_rule;
```sql
mysql> SHOW SHADOW RULE shadow_rule;
-+-------------+-------------+-------------+----------------------+
-| rule_name | source_name | shadow_name | shadow_table |
-+-------------+-------------+-------------+----------------------+
-| shadow_rule | ds_0 | ds_1 | t_order_item,t_order |
-+-------------+-------------+-------------+----------------------+
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| shadow_table | rule_name | source_name | shadow_name | algorithm_type | algorithm_props |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| t_order | shadow_rule | ds_0 | ds_1 | VALUE_MATCH | column=user_id,operation=insert,value=1 |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
1 row in set (0.01 sec)
```
@@ -85,11 +83,11 @@ SHOW SHADOW RULES FROM shadow_db;
```sql
mysql> SHOW SHADOW RULES FROM shadow_db;
-+-------------+-------------+-------------+----------------------+
-| rule_name | source_name | shadow_name | shadow_table |
-+-------------+-------------+-------------+----------------------+
-| shadow_rule | ds_0 | ds_1 | t_order_item,t_order |
-+-------------+-------------+-------------+----------------------+
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| shadow_table | rule_name | source_name | shadow_name | algorithm_type | algorithm_props |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| t_order | shadow_rule | ds_0 | ds_1 | VALUE_MATCH | column=user_id,operation=insert,value=1 |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
1 row in set (0.00 sec)
```
@@ -101,11 +99,11 @@ SHOW SHADOW RULES;
```sql
mysql> SHOW SHADOW RULES;
-+-------------+-------------+-------------+----------------------+
-| rule_name | source_name | shadow_name | shadow_table |
-+-------------+-------------+-------------+----------------------+
-| shadow_rule | ds_0 | ds_1 | t_order_item,t_order |
-+-------------+-------------+-------------+----------------------+
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| shadow_table | rule_name | source_name | shadow_name | algorithm_type | algorithm_props |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
+| t_order | shadow_rule | ds_0 | ds_1 | VALUE_MATCH | column=user_id,operation=insert,value=1 |
++--------------+-------------+-------------+-------------+----------------+-------------------------------------------------+
1 row in set (0.00 sec)
```
### Reserved word
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.cn.md
index 1851ae47e47..9103edbb554 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.cn.md
@@ -1,19 +1,22 @@
+++
-title = "SHOW SHADOW TABLE RULES"
+title = "SHOW SHADOW TABLE RULE"
weight = 2
+++
### 描述
-`SHOW SHADOW TABLE RULES` 语法用于查询指定逻辑库中的影子表规则。
+`SHOW SHADOW TABLE RULE` 语法用于查询指定逻辑库中的影子表规则。
### 语法
{{< tabs >}}
{{% tab name="语法" %}}
```sql
-ShowEncryptRule::=
- 'SHOW' 'SHADOW' 'TABLE' 'RULES' ('FROM' databaseName)?
+ShowShadowTableRule::=
+ 'SHOW' 'SHADOW' 'TABLE' ('RULE' tableName | 'RULES') ('FROM' databaseName)?
+
+tableName ::=
+ identifier
databaseName ::=
identifier
@@ -54,6 +57,12 @@ mysql> SHOW SHADOW TABLE RULES FROM shadow_db;
2 rows in set (0.00 sec)
```
+- 查询当前逻辑库中的指定影子表规则
+
+```sql
+SHOW SHADOW TABLE RULE t_order;
+```
+
- 查询当前逻辑库中的影子表规则
```sql
@@ -73,9 +82,8 @@ mysql> SHOW SHADOW TABLE RULES;
### 保留字
-`SHOW`、`SHADOW`、`TABLE`、`RULES`、`FROM`
+`SHOW`、`SHADOW`、`TABLE`、`RULE`、`RULES`、`FROM`
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.en.md
index 1856c5fadc7..ef9d664a76b 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-table-rule.en.md
@@ -1,11 +1,11 @@
+++
-title = "SHOW SHADOW TABLE RULES"
+title = "SHOW SHADOW TABLE RULE"
weight = 2
+++
### Description
-The `SHOW SHADOW TABLE RULES` syntax is used to query shadow table rules for specified database.
+The `SHOW SHADOW TABLE RULE` syntax is used to query shadow table rules for specified database.
### Syntax
@@ -13,7 +13,10 @@ The `SHOW SHADOW TABLE RULES` syntax is used to query shadow table rules for spe
{{% tab name="Grammar" %}}
```sql
ShowShadowTableRule::=
- 'SHOW' 'SHADOW' 'TABLE' 'RULES' ('FROM' databaseName)?
+ 'SHOW' 'SHADOW' 'TABLE' ('RULE' tableName | 'RULES') ('FROM' databaseName)?
+
+tableName ::=
+ identifier
databaseName ::=
identifier
@@ -54,6 +57,12 @@ mysql> SHOW SHADOW TABLE RULES FROM shadow_db;
2 rows in set (0.00 sec)
```
+- Query a shadow table rule for current database.
+
+```sql
+SHOW SHADOW TABLE RULE t_order;
+```
+
- Query shadow table rules for current database.
```sql
@@ -72,7 +81,7 @@ mysql> SHOW SHADOW TABLE RULES;
```
### Reserved word
-`SHOW`, `SHADOW`, `TABLE`, `RULES`, `FROM`
+`SHOW`, `SHADOW`, `TABLE`, `RULE`, `RULES`, `FROM`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding/show-sharding-table-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding/show-sharding-table-rule.cn.md
index 2f7e85cd402..ed4c6b350c3 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding/show-sharding-table-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding/show-sharding-table-rule.cn.md
@@ -49,6 +49,8 @@ databaseName ::=
| key_generate_column | 分布式主键生成列 |
| key_generator_type | 分布式主键生成器类型 |
| key_generator_props | 分布式主键生成器参数 |
+| auditor_types | 分片审计算法类型 |
+| allow_hint_disable | 是否允许通过 Hint 禁用分片审计 |
### 示例
- 查询指定逻辑库的分片规则
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding/show-sharding-table-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding/show-sharding-table-rule.en.md
index e11d46add14..fd397fadd41 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding/show-sharding-table-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding/show-sharding-table-rule.en.md
@@ -49,6 +49,8 @@ databaseName ::=
| key_generate_column | Sharding key generator column |
| key_generator_type | Sharding key generator type |
| key_generator_props | Sharding key generator properties |
+| auditor_types | Sharding auditor types |
+| allow_hint_disable | Whether hint can disable sharding auditors |
### Example
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/count-single-table.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/count-single-table.cn.md
index b79c7f2e473..90cc7f914c7 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/count-single-table.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/count-single-table.cn.md
@@ -1,5 +1,5 @@
+++
-title = "COUNT SINGLE_TABLE RULE"
+title = "COUNT SINGLE TABLE"
weight = 3
+++
@@ -61,4 +61,3 @@ mysql> COUNT SINGLE TABLE;
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/count-single-table.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/count-single-table.en.md
index ce969b29006..d3b14707b0f 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/count-single-table.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/count-single-table.en.md
@@ -1,5 +1,5 @@
+++
-title = "COUNT SINGLE_TABLE RULE"
+title = "COUNT SINGLE TABLE"
weight = 3
+++
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-deafult-single-table-storage-unit.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-default-single-table-storage-unit.cn.md
similarity index 100%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-deafult-single-table-storage-unit.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-default-single-table-storage-unit.cn.md
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-deafult-single-table-storage-unit.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-default-single-table-storage-unit.en.md
similarity index 100%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-deafult-single-table-storage-unit.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-default-single-table-storage-unit.en.md
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-single-table.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-single-table.cn.md
index ba3d416c7b1..c8a99d95eec 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-single-table.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-single-table.cn.md
@@ -1,22 +1,25 @@
+++
-title = "SHOW SINGLE TABLE"
+title = "SHOW SINGLE TABLES"
weight = 1
+++
### 描述
-`SHOW SINGLE TABLE` 语法用于查询指定逻辑库中的单表。
+`SHOW SINGLE TABLES` 语法用于查询指定逻辑库中的单表。
### 语法
{{< tabs >}}
{{% tab name="Grammar" %}}
```sql
-ShowSingleTable::=
- 'SHOW' 'SINGLE' ('TABLES' ('LIKE' likeLiteral)?|'TABLE' tableName) ('FROM' databaseName)?
+ShowSingleTables ::=
+ 'SHOW' 'SINGLE' 'TABLES' ('FROM' databaseName)? showLike?
-tableName ::=
- identifier
+showLike ::=
+ 'LIKE' likePattern
+
+likePattern ::=
+ string
databaseName ::=
identifier
@@ -41,38 +44,6 @@ databaseName ::=
### 示例
-- 查询指定逻辑库中的指定单表
-
-```sql
-SHOW SINGLE TABLE t_user FROM sharding_db;
-```
-
-```sql
-mysql> SHOW SINGLE TABLE t_user FROM sharding_db;
-+------------+---------------+
-| table_name | resource_name |
-+------------+---------------+
-| t_user | ds_0 |
-+------------+---------------+
-1 row in set (0.00 sec)
-```
-
-- 查询当前逻辑库中的指定单表
-
-```sql
-SHOW SINGLE TABLE t_user;
-```
-
-```sql
-mysql> SHOW SINGLE TABLE t_user;
-+------------+-------------------+
-| table_name | storage_unit_name |
-+------------+-------------------+
-| t_user | ds_0 |
-+------------+-------------------+
-1 row in set (0.00 sec)
-```
-
- 查询指定逻辑库中的单表
```sql
@@ -108,11 +79,11 @@ mysql> SHOW SINGLE TABLES;
- 查询指定逻辑库中表名以 `order_5` 结尾的单表
```sql
-SHOW SINGLE TABLES LIKE '%order_5' FROM sharding_db;
+SHOW SINGLE TABLES FROM sharding_db LIKE '%order_5';
```
```sql
-mysql> SHOW SINGLE TABLES LIKE '%order_5' FROM sharding_db;
+mysql> SHOW SINGLE TABLES FROM sharding_db LIKE '%order_5';
+------------+-------------------+
| table_name | storage_unit_name |
+------------+-------------------+
@@ -144,4 +115,3 @@ mysql> SHOW SINGLE TABLES LIKE '%order_5';
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-single-table.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-single-table.en.md
index 454c36de5f2..684bfa8c680 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-single-table.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-single-table.en.md
@@ -1,22 +1,25 @@
+++
-title = "SHOW SINGLE TABLE"
+title = "SHOW SINGLE TABLES"
weight = 1
+++
### Description
-The `SHOW SINGLE TABLE` syntax is used to query single tables for specified database.
+The `SHOW SINGLE TABLES` syntax is used to query single tables for specified database.
### Syntax
{{< tabs >}}
{{% tab name="Grammar" %}}
```sql
-ShowSingleTable::=
- 'SHOW' 'SINGLE' ('TABLES' ('LIKES' likeLiteral)?|'TABLE' tableName) ('FROM' databaseName)?
+ShowSingleTables ::=
+ 'SHOW' 'SINGLE' 'TABLES' ('FROM' databaseName)? showLike?
-tableName ::=
- identifier
+showLike ::=
+ 'LIKE' likePattern
+
+likePattern ::=
+ string
databaseName ::=
identifier
@@ -41,38 +44,6 @@ databaseName ::=
### Example
-- Query specified single table for specified database.
-
-```sql
-SHOW SINGLE TABLE t_user FROM sharding_db;
-```
-
-```sql
-mysql> SHOW SINGLE TABLE t_user FROM sharding_db;
-+------------+-------------------+
-| table_name | storage_unit_name |
-+------------+-------------------+
-| t_user | ds_0 |
-+------------+-------------------+
-1 row in set (0.00 sec)
-```
-
-- Query specified single table for current database.
-
-```sql
-SHOW SINGLE TABLE t_user;
-```
-
-```sql
-mysql> SHOW SINGLE TABLE t_user;
-+------------+-------------------+
-| table_name | storage_unit_name |
-+------------+-------------------+
-| t_user | ds_0 |
-+------------+-------------------+
-1 row in set (0.00 sec)
-```
-
- Query single tables for specified database.
```sql
@@ -108,11 +79,11 @@ mysql> SHOW SINGLE TABLES;
- Query the single tables whose table name end with `order_5` for the specified logic database.
```sql
-SHOW SINGLE TABLES LIKE '%order_5' FROM sharding_db;
+SHOW SINGLE TABLES FROM sharding_db LIKE '%order_5';
```
```sql
-mysql> SHOW SINGLE TABLES LIKE '%order_5' FROM sharding_db;
+mysql> SHOW SINGLE TABLES FROM sharding_db LIKE '%order_5';
+------------+-------------------+
| table_name | storage_unit_name |
+------------+-------------------+
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-unloaded-single-tables.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-unloaded-single-tables.cn.md
index c0c55b55e41..67d37c17a70 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-unloaded-single-tables.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-unloaded-single-tables.cn.md
@@ -13,7 +13,11 @@ weight = 4
{{% tab name="Grammar" %}}
```sql
showUnloadedSingleTables::=
- 'SHOW' 'UNLOADED' 'SINGLE' 'TABLES'
+ 'SHOW' 'UNLOADED' 'SINGLE' 'TABLES' ('FROM' fromClause)?
+
+fromClause ::=
+ databaseName ('STORAGE' 'UNIT' storageUnitName ('SCHEMA' schemaName)?)?
+ | 'STORAGE' 'UNIT' storageUnitName ('SCHEMA' schemaName)?
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
@@ -27,6 +31,7 @@ showUnloadedSingleTables::=
|-------------------|---------------------|
| table_name | 单表名称 |
| storage_unit_name | 单表所在的存储单元名称 |
+| schema_name | Schema 名称，仅在存在 Schema 元数据时返回 |
### 示例
@@ -47,11 +52,16 @@ mysql> SHOW UNLOADED SINGLE TABLES;
1 row in set (0.01 sec)
```
+- 查询指定存储单元中的未加载单表
+
+```sql
+SHOW UNLOADED SINGLE TABLES FROM STORAGE UNIT ds_0;
+```
+
### 保留字
-`SHOW`、`UNLOADED`、`SINGLE`、`TABLES`
+`SHOW`、`UNLOADED`、`SINGLE`、`TABLES`、`FROM`、`STORAGE`、`UNIT`、`SCHEMA`
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-unloaded-single-tables.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-unloaded-single-tables.en.md
index 9dbdd009803..abc68e25bdb 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-unloaded-single-tables.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-unloaded-single-tables.en.md
@@ -13,7 +13,11 @@ The `SHOW UNLOADED SINGLE TABLES` syntax is used to query unloaded single tables
{{% tab name="Grammar" %}}
```sql
showUnloadedSingleTables::=
- 'SHOW' 'UNLOADED' 'SINGLE' 'TABLES'
+ 'SHOW' 'UNLOADED' 'SINGLE' 'TABLES' ('FROM' fromClause)?
+
+fromClause ::=
+ databaseName ('STORAGE' 'UNIT' storageUnitName ('SCHEMA' schemaName)?)?
+ | 'STORAGE' 'UNIT' storageUnitName ('SCHEMA' schemaName)?
```
{{% /tab %}}
{{% tab name="Railroad diagram" %}}
@@ -27,6 +31,7 @@ showUnloadedSingleTables::=
|-------------------|---------------------------------------------------------|
| table_name | Single table name |
| storage_unit_name | The storage unit name where the single table is located |
+| schema_name | Schema name, returned only when schema metadata exists |
### Example
@@ -47,9 +52,15 @@ mysql> SHOW UNLOADED SINGLE TABLES;
1 row in set (0.01 sec)
```
+- Query unloaded single tables from specified storage unit.
+
+```sql
+SHOW UNLOADED SINGLE TABLES FROM STORAGE UNIT ds_0;
+```
+
### Reserved word
-`SHOW`, `UNLOADED`, `SINGLE`, `TABLES`
+`SHOW`, `UNLOADED`, `SINGLE`, `TABLES`, `FROM`, `STORAGE`, `UNIT`, `SCHEMA`
### Related links
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/storage-unit-query/show-logical-tables.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/storage-unit-query/show-logical-tables.cn.md
new file mode 100644
index 00000000000..e4c3473ddb4
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/storage-unit-query/show-logical-tables.cn.md
@@ -0,0 +1,73 @@
++++
+title = "SHOW LOGICAL TABLES"
+weight = 3
++++
+
+### 描述
+
+`SHOW LOGICAL TABLES` 语法用于查询指定逻辑库中的逻辑表。
+
+### 语法
+
+{{< tabs >}}
+{{% tab name="语法" %}}
+```sql
+ShowLogicalTables ::=
+ 'SHOW' 'FULL'? 'LOGICAL' 'TABLES' ('FROM' databaseName)? showLike?
+
+databaseName ::=
+ identifier
+
+showLike ::=
+ 'LIKE' likePattern
+
+likePattern ::=
+ string
+```
+{{% /tab %}}
+{{% tab name="铁路图" %}}
+<iframe frameborder="0" name="diagram" id="diagram" width="100%" height="100%"></iframe>
+{{% /tab %}}
+{{< /tabs >}}
+
+### 补充说明
+
+- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`；如果也未使用 `DATABASE` 则会提示 `No database selected`。
+- `FULL` 会返回逻辑表类型。
+- 当逻辑库存在 Schema 元数据时，返回结果还会包含 `schema_name`。
+
+### 返回值说明
+
+| 列 | 说明 |
+|-------------|----------------------------|
+| table_name | 逻辑表名称 |
+| table_type | 逻辑表类型，仅在指定 `FULL` 时返回 |
+| schema_name | Schema 名称，仅在存在 Schema 元数据时返回 |
+
+### 示例
+
+- 查询当前逻辑库中的逻辑表
+
+```sql
+SHOW LOGICAL TABLES;
+```
+
+- 查询指定逻辑库中的完整逻辑表信息
+
+```sql
+SHOW FULL LOGICAL TABLES FROM sharding_db;
+```
+
+- 使用 `LIKE` 查询逻辑表
+
+```sql
+SHOW LOGICAL TABLES LIKE 't_order%';
+```
+
+### 保留字
+
+`SHOW`、`FULL`、`LOGICAL`、`TABLES`、`FROM`、`LIKE`
+
+### 相关链接
+
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/storage-unit-query/show-logical-tables.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/storage-unit-query/show-logical-tables.en.md
new file mode 100644
index 00000000000..ba18269f02b
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/storage-unit-query/show-logical-tables.en.md
@@ -0,0 +1,73 @@
++++
+title = "SHOW LOGICAL TABLES"
+weight = 3
++++
+
+### Description
+
+The `SHOW LOGICAL TABLES` syntax is used to query logical tables in the specified database.
+
+### Syntax
+
+{{< tabs >}}
+{{% tab name="Grammar" %}}
+```sql
+ShowLogicalTables ::=
+ 'SHOW' 'FULL'? 'LOGICAL' 'TABLES' ('FROM' databaseName)? showLike?
+
+databaseName ::=
+ identifier
+
+showLike ::=
+ 'LIKE' likePattern
+
+likePattern ::=
+ string
+```
+{{% /tab %}}
+{{% tab name="Railroad diagram" %}}
+<iframe frameborder="0" name="diagram" id="diagram" width="100%" height="100%"></iframe>
+{{% /tab %}}
+{{< /tabs >}}
+
+### Supplement
+
+- When `databaseName` is not specified, the default is the currently used `DATABASE`; if `DATABASE` is not used, it will prompt `No database selected`.
+- `FULL` returns the logical table type.
+- When the database contains schema metadata, the result also contains `schema_name`.
+
+### Return Value Description
+
+| Column | Description |
+|-------------|-----------------------------------|
+| table_name | Logical table name |
+| table_type | Logical table type, returned only when `FULL` is specified |
+| schema_name | Schema name, returned only when schema metadata exists |
+
+### Example
+
+- Query logical tables from current database
+
+```sql
+SHOW LOGICAL TABLES;
+```
+
+- Query full logical tables from specified database
+
+```sql
+SHOW FULL LOGICAL TABLES FROM sharding_db;
+```
+
+- Query logical tables with like clause
+
+```sql
+SHOW LOGICAL TABLES LIKE 't_order%';
+```
+
+### Reserved word
+
+`SHOW`, `FULL`, `LOGICAL`, `TABLES`, `FROM`, `LIKE`
+
+### Related links
+
+- [Reserved word](/en/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-rules-used-storage-unit.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/storage-unit-query/show-rules-used-storage-unit.cn.md
similarity index 94%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-rules-used-storage-unit.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/storage-unit-query/show-rules-used-storage-unit.cn.md
index 90927948332..5adb47425c1 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-rules-used-storage-unit.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/storage-unit-query/show-rules-used-storage-unit.cn.md
@@ -1,6 +1,6 @@
+++
title = "SHOW RULES USED STORAGE UNIT"
-weight = 12
+weight = 2
+++
### 描述
@@ -36,7 +36,7 @@ databaseName ::=
### 补充说明
-- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE。` 如果也未使用 `DATABASE` 则会提示 `No database selected`。
+- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。如果也未使用 `DATABASE` 则会提示 `No database selected`。
### 示例
@@ -80,4 +80,4 @@ mysql> SHOW RULES USED STORAGE UNIT ds_1;
### 相关链接
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
+- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-rules-used-storage-unit.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/storage-unit-query/show-rules-used-storage-unit.en.md
similarity index 96%
rename from docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-rules-used-storage-unit.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/storage-unit-query/show-rules-used-storage-unit.en.md
index 5e577881eb2..5c4a730ad4f 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-rules-used-storage-unit.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/storage-unit-query/show-rules-used-storage-unit.en.md
@@ -1,11 +1,11 @@
+++
title = "SHOW RULES USED STORAGE UNIT"
-weight = 12
+weight = 2
+++
### Description
-The `SHOW RULES USED STORAGE UNIT` syntax is used to query the rules for using the specified storage unit in specified database.
+The `SHOW RULES USED STORAGE UNIT` syntax is used to query the rules that use the specified storage unit in the specified database.
### Syntax
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rul/format-sql.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rul/format-sql.cn.md
deleted file mode 100644
index 1c4a941b347..00000000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rul/format-sql.cn.md
+++ /dev/null
@@ -1,55 +0,0 @@
-+++
-title = "FORMAT SQL"
-weight = 2
-+++
-
-### 描述
-
-`FORMAT SQL` 语法用于解析并输出格式化后的 `SQL` 语句。
-
-### 语法
-
-{{< tabs >}}
-{{% tab name="语法" %}}
-```sql
-FormatSql ::=
- 'FORMAT' sqlStatement
-```
-{{% /tab %}}
-{{% tab name="铁路图" %}}
-<iframe frameborder="0" name="diagram" id="diagram" width="100%" height="100%"></iframe>
-{{% /tab %}}
-{{< /tabs >}}
-
-### 返回值说明
-
-| 列 | 说明 |
-|------------------|------------|
-| formatted_result | 格式化后的SQL语句 |
-
-### 示例
-
-- 解析并输出格式化后的 `SQL` 语句
-
-```sql
-FORMAT SELECT * FROM t_order;
-```
-
-```sql
-mysql> FORMAT SELECT * FROM t_order;
-+-------------------------+
-| formatted_result |
-+-------------------------+
-| SELECT *
-FROM t_order; |
-+-------------------------+
-1 row in set (0.00 sec)
-```
-
-### 保留字
-
-`FORMAT`
-
-### 相关链接
-
-- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rul/format-sql.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rul/format-sql.en.md
deleted file mode 100644
index a90a321e2b1..00000000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rul/format-sql.en.md
+++ /dev/null
@@ -1,55 +0,0 @@
-+++
-title = "FORMAT SQL"
-weight = 2
-+++
-
-### Description
-
-The `FORMAT SQL` syntax is used to parse `SQL` and output formatted `SQL` statement.
-
-### Syntax
-
-{{< tabs >}}
-{{% tab name="Grammar" %}}
-```sql
-FormatSql ::=
- 'FORMAT' sqlStatement
-```
-{{% /tab %}}
-{{% tab name="Railroad diagram" %}}
-<iframe frameborder="0" name="diagram" id="diagram" width="100%" height="100%"></iframe>
-{{% /tab %}}
-{{< /tabs >}}
-
-### Return Value Description
-
-| Column | Description |
-|------------------|-------------------------|
-| formatted_result | formatted SQL statement |
-
-### Example
-
-- Parse `SQL` and output formatted `SQL` statement
-
-```sql
-FORMAT SELECT * FROM t_order;
-```
-
-```sql
-mysql> FORMAT SELECT * FROM t_order;
-+-------------------------+
-| formatted_result |
-+-------------------------+
-| SELECT *
-FROM t_order; |
-+-------------------------+
-1 row in set (0.00 sec)
-```
-
-### Reserved word
-
-`FORMAT`
-
-### Related links
-
-- [Reserved word](/en/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/startup/graalvm-native-image.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/startup/graalvm-native-image.cn.md
index 2565ff41a5b..d058d93f151 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/startup/graalvm-native-image.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/startup/graalvm-native-image.cn.md
@@ -232,7 +232,7 @@ cd ./shardingsphere/
```yaml
services:
apache-shardingsphere-proxy-native:
- image: apache/shardingsphere-proxy-native:5.5.3-SNAPSHOT
+ image: apache/shardingsphere-proxy-native:5.5.4-SNAPSHOT
volumes:
- ./custom/conf:/opt/shardingsphere-proxy/conf
ports:
@@ -246,7 +246,7 @@ services:
```shell
git clone git@github.com:apache/shardingsphere.git
cd ./shardingsphere/
-./mvnw -am -pl distribution/proxy-native -T1C "-Pdocker.build.native.linux" "-Dproxy.native.dockerfile=Dockerfile-linux-mostly" "-Dproxy.native.image.tag=5.5.3-SNAPSHOT-mostly" "-DskipTests" clean package
+./mvnw -am -pl distribution/proxy-native -T1C "-Pdocker.build.native.linux" "-Dproxy.native.dockerfile=Dockerfile-linux-mostly" "-Dproxy.native.image.tag=5.5.4-SNAPSHOT-mostly" "-DskipTests" clean package
```
一个可能的 Docker Compose 示例为，
@@ -254,7 +254,7 @@ cd ./shardingsphere/
```yaml
services:
apache-shardingsphere-proxy-native:
- image: apache/shardingsphere-proxy-native:5.5.3-SNAPSHOT-mostly
+ image: apache/shardingsphere-proxy-native:5.5.4-SNAPSHOT-mostly
volumes:
- ./custom/conf:/opt/shardingsphere-proxy/conf
ports:
@@ -268,7 +268,7 @@ services:
```shell
git clone git@github.com:apache/shardingsphere.git
cd ./shardingsphere/
-./mvnw -am -pl distribution/proxy-native -T1C "-Pdocker.build.native.linux" "-Dproxy.native.dockerfile=Dockerfile-linux-static" "-Dproxy.native.image.tag=5.5.3-SNAPSHOT-static" "-DskipTests" clean package
+./mvnw -am -pl distribution/proxy-native -T1C "-Pdocker.build.native.linux" "-Dproxy.native.dockerfile=Dockerfile-linux-static" "-Dproxy.native.image.tag=5.5.4-SNAPSHOT-static" "-DskipTests" clean package
```
一个可能的 Docker Compose 示例为，
@@ -276,7 +276,7 @@ cd ./shardingsphere/
```yaml
services:
apache-shardingsphere-proxy-native:
- image: apache/shardingsphere-proxy-native:5.5.3-SNAPSHOT-static
+ image: apache/shardingsphere-proxy-native:5.5.4-SNAPSHOT-static
volumes:
- ./custom/conf:/opt/shardingsphere-proxy/conf
ports:
@@ -347,7 +347,7 @@ Ubuntu 下假设已存在包含 `global.yaml` 的 `conf` 文件夹为 `/tmp/conf
```bash
cd ./shardingsphere/
-cd ./distribution/proxy-native/target/apache-shardingsphere-5.5.3-SNAPSHOT-shardingsphere-proxy-bin/bin
+cd ./distribution/proxy-native/target/apache-shardingsphere-5.5.4-SNAPSHOT-shardingsphere-proxy-bin/bin
./proxy-native "3307" "/tmp/conf" "0.0.0.0"
```
@@ -355,7 +355,7 @@ Windows 下假设已存在包含 `global.yaml` 的 `conf` 文件夹为 `C:\Users
```bash
cd ./shardingsphere/
-cd ./distribution/proxy-native/target/apache-shardingsphere-5.5.3-SNAPSHOT-shardingsphere-proxy-bin/bin
+cd ./distribution/proxy-native/target/apache-shardingsphere-5.5.4-SNAPSHOT-shardingsphere-proxy-bin/bin
./proxy-native.exe "3307" "C:\Users\shard\Downloads\conf" "0.0.0.0"
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/startup/graalvm-native-image.en.md b/docs/document/content/user-manual/shardingsphere-proxy/startup/graalvm-native-image.en.md
index 0437bbbe868..c924bd79456 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/startup/graalvm-native-image.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/startup/graalvm-native-image.en.md
@@ -235,7 +235,7 @@ A possible Docker Compose example is,
```yaml
services:
apache-shardingsphere-proxy-native:
- image: apache/shardingsphere-proxy-native:5.5.3-SNAPSHOT
+ image: apache/shardingsphere-proxy-native:5.5.4-SNAPSHOT
volumes:
- ./custom/conf:/opt/shardingsphere-proxy/conf
ports:
@@ -249,7 +249,7 @@ You can execute the following command to build.
```shell
git clone git@github.com:apache/shardingsphere.git
cd ./shardingsphere/
-./mvnw -am -pl distribution/proxy-native -T1C "-Pdocker.build.native.linux" "-Dproxy.native.dockerfile=Dockerfile-linux-mostly" "-Dproxy.native.image.tag=5.5.3-SNAPSHOT-mostly" "-DskipTests" clean package
+./mvnw -am -pl distribution/proxy-native -T1C "-Pdocker.build.native.linux" "-Dproxy.native.dockerfile=Dockerfile-linux-mostly" "-Dproxy.native.image.tag=5.5.4-SNAPSHOT-mostly" "-DskipTests" clean package
```
A possible Docker Compose example is,
@@ -257,7 +257,7 @@ A possible Docker Compose example is,
```yaml
services:
apache-shardingsphere-proxy-native:
- image: apache/shardingsphere-proxy-native:5.5.3-SNAPSHOT-mostly
+ image: apache/shardingsphere-proxy-native:5.5.4-SNAPSHOT-mostly
volumes:
- ./custom/conf:/opt/shardingsphere-proxy/conf
ports:
@@ -271,7 +271,7 @@ You can execute the following command to build.
```shell
git clone git@github.com:apache/shardingsphere.git
cd ./shardingsphere/
-./mvnw -am -pl distribution/proxy-native -T1C "-Pdocker.build.native.linux" "-Dproxy.native.dockerfile=Dockerfile-linux-static" "-Dproxy.native.image.tag=5.5.3-SNAPSHOT-static" "-DskipTests" clean package
+./mvnw -am -pl distribution/proxy-native -T1C "-Pdocker.build.native.linux" "-Dproxy.native.dockerfile=Dockerfile-linux-static" "-Dproxy.native.image.tag=5.5.4-SNAPSHOT-static" "-DskipTests" clean package
```
A possible Docker Compose example is,
@@ -279,7 +279,7 @@ A possible Docker Compose example is,
```yaml
services:
apache-shardingsphere-proxy-native:
- image: apache/shardingsphere-proxy-native:5.5.3-SNAPSHOT-static
+ image: apache/shardingsphere-proxy-native:5.5.4-SNAPSHOT-static
volumes:
- ./custom/conf:/opt/shardingsphere-proxy/conf
ports:
@@ -350,7 +350,7 @@ On Ubuntu, assuming that the `conf` folder containing `global.yaml` is `/tmp/con
```bash
cd ./shardingsphere/
-cd ./distribution/proxy-native/target/apache-shardingsphere-5.5.3-SNAPSHOT-shardingsphere-proxy-bin/bin
+cd ./distribution/proxy-native/target/apache-shardingsphere-5.5.4-SNAPSHOT-shardingsphere-proxy-bin/bin
./proxy-native "3307" "/tmp/conf" "0.0.0.0"
```
@@ -358,7 +358,7 @@ On Windows, assuming that a `conf` folder containing `global.yaml` already exist
```bash
cd ./shardingsphere/
-cd ./distribution/proxy-native/target/apache-shardingsphere-5.5.3-SNAPSHOT-shardingsphere-proxy-bin/bin
+cd ./distribution/proxy-native/target/apache-shardingsphere-5.5.4-SNAPSHOT-shardingsphere-proxy-bin/bin
./proxy-native.exe "3307" "C:\Users\shard\Downloads\conf" "0.0.0.0"
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md
index 25f300cc9ae..c907925acb2 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md
@@ -19,7 +19,7 @@ Apache ShardingSphere 提供了丰富的系统配置属性，用户可通过 `gl
| max-union-size-per-datasource (?) | int | 每个数据源允许合并的最大 UNION ALL 数量。当路由到同一数据源的路由单元数量超过此值时，将分批合并以恢复并行执行能力。 | Integer.MAX_VALUE | 是 |
| check-table-metadata-enabled (?) | boolean | 应用启动或元数据更新时，是否校验表元数据一致性。 | false | 是 |
| load-table-metadata-batch-size (?) | int | 应用启动或刷新表元数据时，单个批次加载表元数据的数量。 | 1000 | 是 |
-| proxy-frontend-database-protocol-type (?) | String | ShardingSphere-Proxy 前端数据库协议类型。支持 `MySQL`、`PostgreSQL`、`openGauss` 和 `Firebird`。 | "" | 是 |
+| proxy-frontend-database-protocol-type (?) | String | ShardingSphere-Proxy 前端数据库协议类型。支持 `MySQL`、`PostgreSQL`、`openGauss` 和 `Firebird`。 | null | 是 |
| proxy-frontend-flush-threshold (?) | int | ShardingSphere-Proxy 前端传输记录的 I/O 刷新阈值。 | 128 | 是 |
| proxy-backend-query-fetch-size (?) | int | Proxy 后端与数据库使用游标交互时每次获取的数据行数。数值增大可能会增加 ShardingSphere-Proxy 的内存使用。`-1` 表示使用不同 JDBC 驱动的最小值。 | -1 | 是 |
| proxy-frontend-executor-size (?) | int | ShardingSphere-Proxy 前端 Netty 线程池线程数量。`0` 表示使用 Netty 默认值。 | 0 | 否 |
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md
index ca0d0661081..ddfcbd11f11 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md
@@ -19,7 +19,7 @@ Apache ShardingSphere provides a wealth of system configuration properties, whic
| max-union-size-per-datasource (?) | int | Maximum UNION ALL size per data source for aggregate rewrite. When route units for one data source exceed this value, they are split into batches to restore parallel execution capability. | Integer.MAX_VALUE | True |
| check-table-metadata-enabled (?) | boolean | Whether to validate table metadata consistency when the application starts or metadata is updated. | false | True |
| load-table-metadata-batch-size (?) | int | Number of table metadata entries loaded per batch when the application starts or refreshes table metadata. | 1000 | True |
-| proxy-frontend-database-protocol-type (?) | String | Frontend database protocol type for ShardingSphere-Proxy. Supported values are `MySQL`, `PostgreSQL`, `openGauss`, and `Firebird`. | "" | True |
+| proxy-frontend-database-protocol-type (?) | String | Frontend database protocol type for ShardingSphere-Proxy. Supported values are `MySQL`, `PostgreSQL`, `openGauss`, and `Firebird`. | null | True |
| proxy-frontend-flush-threshold (?) | int | I/O flush threshold for records transmitted by the ShardingSphere-Proxy frontend. | 128 | True |
| proxy-backend-query-fetch-size (?) | int | Number of rows fetched when the Proxy backend interacts with databases by cursor. A larger value may increase ShardingSphere-Proxy memory usage. `-1` means using the minimum value for each JDBC driver. | -1 | True |
| proxy-frontend-executor-size (?) | int | Number of threads in the ShardingSphere-Proxy frontend Netty thread pool. `0` means using Netty's default value. | 0 | False |