You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by su...@apache.org on 2023/05/29 07:01:50 UTC
[shardingsphere] branch master updated: For #25871, update RQL documents. (#25930)
This is an automated email from the ASF dual-hosted git repository.
sunnianjun 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 044d08f3475 For #25871, update RQL documents. (#25930)
044d08f3475 is described below
commit 044d08f3475fc56f1b103ec81fdc17b6a2c8abbe
Author: Raigor <ra...@gmail.com>
AuthorDate: Mon May 29 15:01:42 2023 +0800
For #25871, update RQL documents. (#25930)
---
.../show-readwrite-splitting-rule.cn.md | 58 +++++++++++-----------
.../show-readwrite-splitting-rule.en.md | 57 +++++++++++----------
.../rule-query/shadow/show-shadow-algorithm.cn.md | 4 +-
.../rule-query/shadow/show-shadow-algorithm.en.md | 4 +-
.../rule-query/shadow/show-shadow-table-rule.cn.md | 4 +-
.../rule-query/shadow/show-shadow-table-rule.en.md | 4 +-
6 files changed, 64 insertions(+), 67 deletions(-)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.cn.md
index bc6e5f7f7c6..3b5bed4eb36 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.cn.md
@@ -33,15 +33,14 @@ databaseName ::=
### 返回值说明
-| 列 | 说明 |
-|-----------------------------|-------------------------|
-| name | 读写分离规则名称 |
-| auto_aware_data_source_name | 自动发现数据源名称(配置动态读写分离规则显示) |
-| write_data_source_name | 写数据源名称 |
-| read_data_source_names | 读数据源名称列表 |
-| load_balancer_type | 负载均衡算法类型 |
-| load_balancer_props | 负载均衡算法参数 |
-
+| 列 | 说明 |
+|---------------------------------- |------------------- |
+| name | 读写分离规则名称 |
+| write_data_source_name | 写数据源名称 |
+| read_data_source_names | 读数据源名称列表 |
+| transactional_read_query_strategy | 事务内读请求路由策略 |
+| load_balancer_type | 负载均衡算法类型 |
+| load_balancer_props | 负载均衡算法参数 |
### 示例
@@ -53,11 +52,11 @@ SHOW READWRITE_SPLITTING RULES FROM readwrite_splitting_db;
```sql
mysql> SHOW READWRITE_SPLITTING RULES FROM readwrite_splitting_db;
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| name | auto_aware_data_source_name | write_data_source_name | read_data_source_names | load_balancer_type | load_balancer_props |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| ms_group_0 | | resource_1 | ds_0,ds_1 | random | |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| name | write_storage_unit_name | read_storage_unit_names | transactional_read_query_strategy | load_balancer_type | load_balancer_props |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| ms_group_0 | write_ds | read_ds_0,read_ds_1 | DYNAMIC | random | |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
1 row in set (0.01 sec)
```
@@ -69,11 +68,11 @@ SHOW READWRITE_SPLITTING RULES;
```sql
mysql> SHOW READWRITE_SPLITTING RULES;
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| name | auto_aware_data_source_name | write_data_source_name | read_data_source_names | load_balancer_type | load_balancer_props |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| ms_group_0 | | resource_1 | ds_0,ds_1 | random | |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| name | write_storage_unit_name | read_storage_unit_names | transactional_read_query_strategy | load_balancer_type | load_balancer_props |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| ms_group_0 | write_ds | read_ds_0,read_ds_1 | DYNAMIC | random | |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
1 row in set (0.01 sec)
```
@@ -85,11 +84,11 @@ SHOW READWRITE_SPLITTING RULE ms_group_0 FROM readwrite_splitting_db;
```sql
mysql> SHOW READWRITE_SPLITTING RULE ms_group_0 FROM readwrite_splitting_db;
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| name | auto_aware_data_source_name | write_data_source_name | read_data_source_names | load_balancer_type | load_balancer_props |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| ms_group_0 | | resource_1 | ds_0,ds_1 | random | |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| name | write_storage_unit_name | read_storage_unit_names | transactional_read_query_strategy | load_balancer_type | load_balancer_props |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| ms_group_0 | write_ds | read_ds_0,read_ds_1 | DYNAMIC | random | |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
1 row in set (0.01 sec)
```
@@ -101,11 +100,11 @@ SHOW READWRITE_SPLITTING RULE ms_group_0;
```sql
mysql> SHOW READWRITE_SPLITTING RULE ms_group_0;
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| name | auto_aware_data_source_name | write_data_source_name | read_data_source_names | load_balancer_type | load_balancer_props |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| ms_group_0 | | resource_1 | ds_0,ds_1 | random | |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| name | write_storage_unit_name | read_storage_unit_names | transactional_read_query_strategy | load_balancer_type | load_balancer_props |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| ms_group_0 | write_ds | read_ds_0,read_ds_1 | DYNAMIC | random | |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
1 row in set (0.01 sec)
```
@@ -116,4 +115,3 @@ mysql> SHOW READWRITE_SPLITTING RULE ms_group_0;
### 相关链接
- [保留字](/cn/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word/)
-
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.en.md
index 26c21933fb5..a1bcd6d0e75 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.en.md
@@ -33,15 +33,14 @@ databaseName ::=
### Return value description
-| Column | Description |
-|-----------------------------|-------------------------------------------------------------------------------------------------|
-| name | Readwrite-splitting rule name |
-| auto_aware_data_source_name | Auto-Aware discovery data source name (Display configuration dynamic readwrite-splitting rules) |
-| write_data_source_name | Write data source name |
-| read_data_source_names | Read data source name list |
-| load_balancer_type | Load balance algorithm type |
-| load_balancer_props | Load balance algorithm parameter |
-
+| Column | Description |
+|-----------------------------------|------------------------------------------------------|
+| name | Readwrite-splitting rule name |
+| write_data_source_name | Write data source name |
+| read_data_source_names | Read data source name list |
+| transactional_read_query_strategy | Routing strategy for read query within a transaction |
+| load_balancer_type | Load balance algorithm type |
+| load_balancer_props | Load balance algorithm parameter |
### Example
@@ -53,11 +52,11 @@ SHOW READWRITE_SPLITTING RULES FROM readwrite_splitting_db;
```sql
mysql> SHOW READWRITE_SPLITTING RULES FROM readwrite_splitting_db;
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| name | auto_aware_data_source_name | write_data_source_name | read_data_source_names | load_balancer_type | load_balancer_props |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| ms_group_0 | | resource_1 | ds_0,ds_1 | random | |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| name | write_storage_unit_name | read_storage_unit_names | transactional_read_query_strategy | load_balancer_type | load_balancer_props |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| ms_group_0 | write_ds | read_ds_0,read_ds_1 | DYNAMIC | random | |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
1 row in set (0.01 sec)
```
@@ -69,11 +68,11 @@ SHOW READWRITE_SPLITTING RULES;
```sql
mysql> SHOW READWRITE_SPLITTING RULES;
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| name | auto_aware_data_source_name | write_data_source_name | read_data_source_names | load_balancer_type | load_balancer_props |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| ms_group_0 | | resource_1 | ds_0,ds_1 | random | |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| name | write_storage_unit_name | read_storage_unit_names | transactional_read_query_strategy | load_balancer_type | load_balancer_props |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| ms_group_0 | write_ds | read_ds_0,read_ds_1 | DYNAMIC | random | |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
1 row in set (0.01 sec)
```
@@ -85,11 +84,11 @@ SHOW READWRITE_SPLITTING RULE ms_group_0 FROM readwrite_splitting_db;
```sql
mysql> SHOW READWRITE_SPLITTING RULE ms_group_0 FROM readwrite_splitting_db;
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| name | auto_aware_data_source_name | write_data_source_name | read_data_source_names | load_balancer_type | load_balancer_props |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| ms_group_0 | | resource_1 | ds_0,ds_1 | random | |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| name | write_storage_unit_name | read_storage_unit_names | transactional_read_query_strategy | load_balancer_type | load_balancer_props |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| ms_group_0 | write_ds | read_ds_0,read_ds_1 | DYNAMIC | random | |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
1 row in set (0.01 sec)
```
@@ -101,11 +100,11 @@ SHOW READWRITE_SPLITTING RULE ms_group_0;
```sql
mysql> SHOW READWRITE_SPLITTING RULE ms_group_0;
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| name | auto_aware_data_source_name | write_data_source_name | read_data_source_names | load_balancer_type | load_balancer_props |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
-| ms_group_0 | | resource_1 | ds_0,ds_1 | random | |
-+------------+-----------------------------+------------------------+------------------------+--------------------+---------------------+
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| name | write_storage_unit_name | read_storage_unit_names | transactional_read_query_strategy | load_balancer_type | load_balancer_props |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
+| ms_group_0 | write_ds | read_ds_0,read_ds_1 | DYNAMIC | random | |
++------------+-------------------------+-------------------------+-----------------------------------+--------------------+---------------------+
1 row in set (0.01 sec)
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-algorithm.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-algorithm.cn.md
index 8aeeb717887..1f9bd8b9f67 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-algorithm.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-algorithm.cn.md
@@ -1,11 +1,11 @@
+++
-title = "SHOW SHADOW ALGORITHM"
+title = "SHOW SHADOW ALGORITHMS"
weight = 3
+++
### 描述
-`SHOW SHADOW ALGORITHM` 语法用于查询指定逻辑库中的影子算法。
+`SHOW SHADOW ALGORITHMS` 语法用于查询指定逻辑库中的影子算法。
### 语法
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-algorithm.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-algorithm.en.md
index 27a7d31767e..cfd5c215c24 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-algorithm.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/shadow/show-shadow-algorithm.en.md
@@ -1,11 +1,11 @@
+++
-title = "SHOW SHADOW ALGORITHM"
+title = "SHOW SHADOW ALGORITHMS"
weight = 3
+++
### Description
-The `SHOW SHADOW ALGORITHM` syntax is used to query shadow algorithms for specified database.
+The `SHOW SHADOW ALGORITHMS` syntax is used to query shadow algorithms for specified database.
### Syntax
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 acfb70f9766..1851ae47e47 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,11 +1,11 @@
+++
-title = "SHOW SHADOW TABLE RULE"
+title = "SHOW SHADOW TABLE RULES"
weight = 2
+++
### 描述
-`SHOW SHADOW TABLE RULE` 语法用于查询指定逻辑库中的影子表规则。
+`SHOW SHADOW TABLE RULES` 语法用于查询指定逻辑库中的影子表规则。
### 语法
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 3502e5fefb0..959e32cad54 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 RULE"
+title = "SHOW SHADOW TABLE RULES"
weight = 2
+++
### Description
-The `SHOW SHADOW TABLE RULE` syntax is used to query shadow table rules for specified database.
+The `SHOW SHADOW TABLE RULES` syntax is used to query shadow table rules for specified database.
### Syntax