You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by ji...@apache.org on 2022/10/21 04:19:03 UTC
[shardingsphere] branch master updated: Update DistSQL documents (#21667)
This is an automated email from the ASF dual-hosted git repository.
jianglongtao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new ae3e304ba9c Update DistSQL documents (#21667)
ae3e304ba9c is described below
commit ae3e304ba9cd62186ccffafca13938874503683d
Author: Zichao <57...@users.noreply.github.com>
AuthorDate: Fri Oct 21 17:18:52 2022 +1300
Update DistSQL documents (#21667)
---
.../create-readwrite-splitting-rule.cn.md | 2 +-
.../rql/rule-query/db-discovery/_index.cn.md | 7 ++
.../rql/rule-query/db-discovery/_index.en.md | 7 ++
.../db-discovery/show-db-discovery-rule.cn.md | 76 +++++++++++++++++++++
.../db-discovery/show-db-discovery-rule.en.md | 77 +++++++++++++++++++++
.../rule-query/readwrite-splitting/_index.cn.md | 7 ++
.../rule-query/readwrite-splitting/_index.en.md | 7 ++
.../show-readwrite-splitting-rule.cn.md | 78 ++++++++++++++++++++++
.../show-readwrite-splitting-rule.en.md | 77 +++++++++++++++++++++
9 files changed, 337 insertions(+), 1 deletion(-)
diff --git a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/readwrite-splitting/create-readwrite-splitting-rule.cn.md b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/readwrite-splitting/create-readwrite-splitting-rule.cn.md
index 08c7f9233c9..593973e2591 100644
--- a/docs/document/content/reference/distsql/syntax/rdl/rule-definition/readwrite-splitting/create-readwrite-splitting-rule.cn.md
+++ b/docs/document/content/reference/distsql/syntax/rdl/rule-definition/readwrite-splitting/create-readwrite-splitting-rule.cn.md
@@ -5,7 +5,7 @@ weight = 2
## 描述
-`CREATE DEFAULT SINGLE TABLE RULE` 语法用于创建读写分离规则
+`CREATE READWRITE_SPLITTING RULE` 语法用于创建读写分离规则
### 语法定义
diff --git a/docs/document/content/reference/distsql/syntax/rql/rule-query/db-discovery/_index.cn.md b/docs/document/content/reference/distsql/syntax/rql/rule-query/db-discovery/_index.cn.md
new file mode 100644
index 00000000000..6d204151d95
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/rql/rule-query/db-discovery/_index.cn.md
@@ -0,0 +1,7 @@
++++
+title = "数据库发现"
+weight = 1
+chapter = true
++++
+
+本章节将对数据库发现特性的语法进行详细说明。
diff --git a/docs/document/content/reference/distsql/syntax/rql/rule-query/db-discovery/_index.en.md b/docs/document/content/reference/distsql/syntax/rql/rule-query/db-discovery/_index.en.md
new file mode 100644
index 00000000000..67eaac4be90
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/rql/rule-query/db-discovery/_index.en.md
@@ -0,0 +1,7 @@
++++
+title = "Database Discovery"
+weight = 1
+chapter = true
++++
+
+This chapter describes the syntax of database discovery.
diff --git a/docs/document/content/reference/distsql/syntax/rql/rule-query/db-discovery/show-db-discovery-rule.cn.md b/docs/document/content/reference/distsql/syntax/rql/rule-query/db-discovery/show-db-discovery-rule.cn.md
new file mode 100644
index 00000000000..adae8fb9ecf
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/rql/rule-query/db-discovery/show-db-discovery-rule.cn.md
@@ -0,0 +1,76 @@
++++
+title = "SHOW DB_DISCOVERY RULES"
+weight = 2
++++
+
+### 描述
+
+`SHOW DB_DISCOVERY RULES` 语法用于查询指定逻辑库中的数据库发现规则。
+
+### 语法
+
+```
+ShowDatabaseDiscoveryRule::=
+ 'SHOW' 'DB_DISCOVERY' 'RULES' ('FROM' databaseName)?
+
+databaseName ::=
+ identifier
+```
+
+### 补充说明
+
+- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。 如果也未使用 `DATABASE` 则会提示 `No database selected`。
+
+### 返回值说明
+
+| 列 | 说明 |
+| ------------------------ | -------------- |
+| group_name | 数据库发现规则名称|
+| data_source_names | 数据源名称列表 |
+| primary_data_source_name | 主数据源名称 |
+| discovery_type | 数据库发现服务类型 |
+| discovery_heartbeat | 数据库发现服务心跳 |
+
+
+### 示例
+
+- 查询指定逻辑库中的数据库发现规则
+
+```sql
+SHOW DB_DISCOVERY RULES FROM test1;
+```
+
+```sql
+mysql> SHOW DB_DISCOVERY RULES FROM test1;
++------------+-------------------+--------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
+| group_name | data_source_names | primary_data_source_name | discovery_type | discovery_heartbeat |
++------------+-------------------+--------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
+| group_0 | ds_0,ds_1,ds_2 | ds_0 | {name=group_0_MySQL.MGR, type=MySQL.MGR, props={group-name=558edd3c-02ec-11ea-9bb3-080027e39bd2}} | {name=group_0_heartbeat, props={keep-alive-cron=0/5 * * * * ?}} |
++------------+-------------------+--------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
+1 row in set (0.01 sec)
+```
+
+- 查询当前逻辑库中的数据库发现规则
+
+```sql
+SHOW DB_DISCOVERY RULES;
+```
+
+```sql
+mysql> SHOW DB_DISCOVERY RULES;
++------------+-------------------+--------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
+| group_name | data_source_names | primary_data_source_name | discovery_type | discovery_heartbeat |
++------------+-------------------+--------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
+| group_0 | ds_0,ds_1,ds_2 | ds_0 | {name=group_0_MySQL.MGR, type=MySQL.MGR, props={group-name=558edd3c-02ec-11ea-9bb3-080027e39bd2}} | {name=group_0_heartbeat, props={keep-alive-cron=0/5 * * * * ?}} |
++------------+-------------------+--------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
+1 row in set (0.03 sec)
+```
+
+### 保留字
+
+`SHOW`、`DB_DISCOVERY`、`RULES`、`FROM`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
+
diff --git a/docs/document/content/reference/distsql/syntax/rql/rule-query/db-discovery/show-db-discovery-rule.en.md b/docs/document/content/reference/distsql/syntax/rql/rule-query/db-discovery/show-db-discovery-rule.en.md
new file mode 100644
index 00000000000..694e581f52e
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/rql/rule-query/db-discovery/show-db-discovery-rule.en.md
@@ -0,0 +1,77 @@
++++
+title = "SHOW DB_DISCOVERY RULES"
+weight = 2
++++
+
+### Description
+
+The `SHOW DB_DISCOVERY RULES` syntax is used to query database discovery rules for specified database.
+
+### Syntax
+
+```
+ShowDatabaseDiscoveryRule::=
+ 'SHOW' 'DB_DISCOVERY' 'RULES' ('FROM' databaseName)?
+
+databaseName ::=
+ identifier
+```
+
+### Supplement
+
+- When `databaseName` is not specified, the default is the currently used `DATABASE`. If `DATABASE` is not used, `No database selected` will be prompted.
+
+### Return value description
+
+| Column | Description |
+| ------------------------ | -------------------------------------- |
+| group_name | Database discovery Rule name |
+| data_source_names | Data source name list |
+| primary_data_source_name | Primary data source name |
+| discovery_type | Database discovery service type |
+| discovery_heartbeat | Database discovery service heartbeat |
+
+
+
+### Example
+
+- Query database discovery rules for specified database.
+
+```sql
+SHOW DB_DISCOVERY RULES FROM test1;
+```
+
+```sql
+mysql> SHOW DB_DISCOVERY RULES FROM test1;
++------------+-------------------+--------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
+| group_name | data_source_names | primary_data_source_name | discovery_type | discovery_heartbeat |
++------------+-------------------+--------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
+| group_0 | ds_0,ds_1,ds_2 | ds_0 | {name=group_0_MySQL.MGR, type=MySQL.MGR, props={group-name=558edd3c-02ec-11ea-9bb3-080027e39bd2}} | {name=group_0_heartbeat, props={keep-alive-cron=0/5 * * * * ?}} |
++------------+-------------------+--------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
+1 row in set (0.01 sec)
+
+```
+
+- Query database discovery rules for current database.
+
+```sql
+SHOW DB_DISCOVERY RULES;
+```
+
+```sql
+mysql> SHOW DB_DISCOVERY RULES;
++------------+-------------------+--------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
+| group_name | data_source_names | primary_data_source_name | discovery_type | discovery_heartbeat |
++------------+-------------------+--------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
+| group_0 | ds_0,ds_1,ds_2 | ds_0 | {name=group_0_MySQL.MGR, type=MySQL.MGR, props={group-name=558edd3c-02ec-11ea-9bb3-080027e39bd2}} | {name=group_0_heartbeat, props={keep-alive-cron=0/5 * * * * ?}} |
++------------+-------------------+--------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+
+1 row in set (0.03 sec)
+```
+
+### Reserved word
+
+`SHOW`、`DB_DISCOVERY`、`RULES`、`FROM`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/rql/rule-query/readwrite-splitting/_index.cn.md b/docs/document/content/reference/distsql/syntax/rql/rule-query/readwrite-splitting/_index.cn.md
new file mode 100644
index 00000000000..8cc7952ea84
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/rql/rule-query/readwrite-splitting/_index.cn.md
@@ -0,0 +1,7 @@
++++
+title = "读写分离"
+weight = 1
+chapter = true
++++
+
+本章节将对读写分离特性的语法进行详细说明。
diff --git a/docs/document/content/reference/distsql/syntax/rql/rule-query/readwrite-splitting/_index.en.md b/docs/document/content/reference/distsql/syntax/rql/rule-query/readwrite-splitting/_index.en.md
new file mode 100644
index 00000000000..687895005d3
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/rql/rule-query/readwrite-splitting/_index.en.md
@@ -0,0 +1,7 @@
++++
+title = "Readwrite-Splitting"
+weight = 1
+chapter = true
++++
+
+This chapter describes the syntax of readwrite splitting.
diff --git a/docs/document/content/reference/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.cn.md b/docs/document/content/reference/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.cn.md
new file mode 100644
index 00000000000..1f6d1ccecc3
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.cn.md
@@ -0,0 +1,78 @@
++++
+title = "SHOW READWRITE_SPLITTING RULES"
+weight = 2
++++
+
+### 描述
+
+`SHOW READWRITE_SPLITTING RULES` 语法用于查询指定逻辑库中的读写分离规则。
+
+### 语法
+
+```
+ShowReadWriteSplittingRule::=
+ 'SHOW' 'READWRITE_SPLITTING' 'RULES' ('FROM' databaseName)?
+
+databaseName ::=
+ identifier
+```
+
+### 补充说明
+
+- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。 如果也未使用 `DATABASE` 则会提示 `No database selected`。
+
+### 返回值说明
+
+| 列 | 说明 |
+| ------------------------------- | --------------------------------------- |
+| name | 读写分离规则名称 |
+| auto_aware_data_source_name | 自动发现数据源名称（配置动态读写分离规则显示）|
+| write_data_source_query_enabled | 读库全部下线，主库是否承担读流量 |
+| write_data_source_name | 写数据源名称 |
+| read_data_source_names | 读数据源名称列表 |
+| load_balancer_type | 负载均衡算法类型 |
+| load_balancer_props | 负载均衡算法参数 |
+
+
+### 示例
+
+- 查询指定逻辑库中的读写分离规则
+
+```sql
+SHOW READWRITE_SPLITTING RULES FROM sharding_db;
+```
+
+```sql
+mysql> SHOW READWRITE_SPLITTING RULES FROM sharding_db;
++------------+-----------------------------+---------------------------------+------------------------+------------------------+--------------------+---------------------+
+| name | auto_aware_data_source_name | write_data_source_query_enabled | write_data_source_name | read_data_source_names | load_balancer_type | load_balancer_props |
++------------+-----------------------------+---------------------------------+------------------------+------------------------+--------------------+---------------------+
+| ms_group_0 | | | resource_1 | ds_0,ds_1 | random | |
++------------+-----------------------------+---------------------------------+------------------------+------------------------+--------------------+---------------------+
+1 row in set (0.01 sec)
+```
+
+- 查询当前逻辑库中的读写分离规则
+
+```sql
+SHOW READWRITE_SPLITTING RULES;
+```
+
+```sql
+mysql> SHOW READWRITE_SPLITTING RULES;
++------------+-----------------------------+---------------------------------+------------------------+------------------------+--------------------+---------------------+
+| name | auto_aware_data_source_name | write_data_source_query_enabled | write_data_source_name | read_data_source_names | load_balancer_type | load_balancer_props |
++------------+-----------------------------+---------------------------------+------------------------+------------------------+--------------------+---------------------+
+| ms_group_0 | | | resource_1 | ds_0,ds_1 | random | |
++------------+-----------------------------+---------------------------------+------------------------+------------------------+--------------------+---------------------+
+1 row in set (0.01 sec)
+```
+
+### 保留字
+
+`SHOW`、`READWRITE_SPLITTING`、`RULES`、`FROM`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
+
diff --git a/docs/document/content/reference/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.en.md b/docs/document/content/reference/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.en.md
new file mode 100644
index 00000000000..d2c539c5586
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/rql/rule-query/readwrite-splitting/show-readwrite-splitting-rule.en.md
@@ -0,0 +1,77 @@
++++
+title = "SHOW READWRITE_SPLITTING RULES"
+weight = 2
++++
+
+### Description
+
+The `SHOW READWRITE_SPLITTING RULES` syntax is used to query readwrite splitting rules for specified database.
+
+### Syntax
+
+```
+ShowReadWriteSplittingRule::=
+ 'SHOW' 'READWRITE_SPLITTING' 'RULES' ('FROM' databaseName)?
+
+databaseName ::=
+ identifier
+```
+
+### Supplement
+
+- When `databaseName` is not specified, the default is the currently used `DATABASE`. If `DATABASE` is not used, `No database selected` will be prompted.
+
+### Return value description
+
+| 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_query_enabled | All read data source are offline, write data source whether the data source is responsible for read traffic|
+| 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 |
+
+
+### Example
+
+- Query readwrite splitting rules for specified database.
+
+```sql
+SHOW READWRITE_SPLITTING RULES FROM sharding_db;
+```
+
+```sql
+mysql> SHOW READWRITE_SPLITTING RULES FROM sharding_db;
++------------+-----------------------------+---------------------------------+------------------------+------------------------+--------------------+---------------------+
+| name | auto_aware_data_source_name | write_data_source_query_enabled | write_data_source_name | read_data_source_names | load_balancer_type | load_balancer_props |
++------------+-----------------------------+---------------------------------+------------------------+------------------------+--------------------+---------------------+
+| ms_group_0 | | | resource_1 | ds_0,ds_1 | random | |
++------------+-----------------------------+---------------------------------+------------------------+------------------------+--------------------+---------------------+
+1 row in set (0.01 sec)
+```
+
+- Query readwrite splitting rules for current database.
+
+```sql
+SHOW READWRITE_SPLITTING RULES;
+```
+
+```sql
+mysql> SHOW READWRITE_SPLITTING RULES;
++------------+-----------------------------+---------------------------------+------------------------+------------------------+--------------------+---------------------+
+| name | auto_aware_data_source_name | write_data_source_query_enabled | write_data_source_name | read_data_source_names | load_balancer_type | load_balancer_props |
++------------+-----------------------------+---------------------------------+------------------------+------------------------+--------------------+---------------------+
+| ms_group_0 | | | resource_1 | ds_0,ds_1 | random | |
++------------+-----------------------------+---------------------------------+------------------------+------------------------+--------------------+---------------------+
+1 row in set (0.01 sec)
+```
+
+### Reserved word
+
+`SHOW`、`READWRITE_SPLITTING`、`RULES`、`FROM`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)