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 411a406 [Doc] Adjust the `Sharding Table Rule` document (#14231)
411a406 is described below
commit 411a4062f429b74c7c47115e70a0ce56c65de537
Author: lanchengx <[email protected]>
AuthorDate: Thu Dec 23 14:07:13 2021 +0800
[Doc] Adjust the `Sharding Table Rule` document (#14231)
* Adjust the `Sharding Table Rule` document
* Modify uuid to snowflake.
* Add `sharding table nodes` & `sharding tables` document.
* Add `sharding table nodes` & `sharding tables` document.
---
.../syntax/rdl/rule-definition/sharding.cn.md | 40 +++++++++++-----------
.../syntax/rdl/rule-definition/sharding.en.md | 40 +++++++++++-----------
.../distsql/syntax/rql/rule-query/sharding.cn.md | 21 ++++++++++++
.../distsql/syntax/rql/rule-query/sharding.en.md | 21 ++++++++++++
.../syntax/rql/rule-query/single-table.cn.md | 30 ++++++++++++++--
.../syntax/rql/rule-query/single-table.en.md | 34 +++++++++++++++---
6 files changed, 138 insertions(+), 48 deletions(-)
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.cn.md
index 5979157..ca6ecd2 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.cn.md
@@ -142,6 +142,12 @@ DROP SHARDING ALGORITHM t_order_hash_mod;
*Table*
```sql
+CREATE SHARDING ALGORITHM database_inline (
+TYPE(NAME=inline,PROPERTIES("algorithm-expression"="resource_${user_id % 2}"))
+),table_inline (
+TYPE(NAME=inline,PROPERTIES("algorithm-expression"="t_order_item_${order_id %
2}"))
+);
+
CREATE SHARDING TABLE RULE t_order_item (
DATANODES("resource_${0..1}.t_order_item_${0..1}"),
DATABASE_STRATEGY(TYPE=standard,SHARDING_COLUMN=user_id,SHARDING_ALGORITHM=database_inline),
@@ -149,46 +155,40 @@
TABLE_STRATEGY(TYPE=standard,SHARDING_COLUMN=order_id,SHARDING_ALGORITHM=table_i
GENERATED_KEY(COLUMN=another_id,TYPE(NAME=snowflake,PROPERTIES("worker-id"=123)))
);
+ALTER SHARDING ALGORITHM database_inline (
+TYPE(NAME=inline,PROPERTIES("algorithm-expression"="resource_${user_id % 4}"))
+),table_inline (
+TYPE(NAME=inline,PROPERTIES("algorithm-expression"="t_order_item_${order_id %
4}"))
+);
+
ALTER SHARDING TABLE RULE t_order_item (
DATANODES("resource_${0..3}.t_order_item${0..3}"),
DATABASE_STRATEGY(TYPE=standard,SHARDING_COLUMN=user_id,SHARDING_ALGORITHM=database_inline),
TABLE_STRATEGY(TYPE=standard,SHARDING_COLUMN=order_id,SHARDING_ALGORITHM=table_inline),
-GENERATED_KEY(COLUMN=another_id,TYPE(NAME=uuid,PROPERTIES("worker-id"=123)))
+GENERATED_KEY(COLUMN=another_id,TYPE(NAME=snowflake,PROPERTIES("worker-id"=123)))
);
DROP SHARDING TABLE RULE t_order_item;
+DROP SHARDING ALGORITHM database_inline;
+
CREATE DEFAULT SHARDING DATABASE STRATEGY (
TYPE = standard,SHARDING_COLUMN=order_id,SHARDING_ALGORITHM=algorithmsName
);
-
-CREATE SHARDING ALGORITHM database_inline (
-TYPE(NAME=inline,PROPERTIES("algorithm-expression"="resource_${user_id % 2}"))
-),table_inline (
-TYPE(NAME=inline,PROPERTIES("algorithm-expression"="t_order_item_${order_id %
2}"))
-);
-
-ALTER SHARDING ALGORITHM database_inline (
-TYPE(NAME=inline,PROPERTIES("algorithm-expression"="resource_${user_id % 4}"))
-),table_inline (
-TYPE(NAME=inline,PROPERTIES("algorithm-expression"="t_order_item_${order_id %
4}"))
-);
-
-DROP SHARDING ALGORITHM database_inline;
```
*Key Generator*
```sql
-CREATE SHARDING KEY GENERATOR uuid_key_generator (
-TYPE(NAME=uuid, PROPERTIES("worker-id"=123))
+CREATE SHARDING KEY GENERATOR snowflake_key_generator (
+TYPE(NAME=SNOWFLAKE, PROPERTIES("worker-id"=123))
);
-ALTER SHARDING KEY GENERATOR uuid_key_generator (
-TYPE(NAME=uuid, PROPERTIES("worker-id"=123))
+ALTER SHARDING KEY GENERATOR snowflake_key_generator (
+TYPE(NAME=SNOWFLAKE, PROPERTIES("worker-id"=456))
);
-DROP SHARDING KEY GENERATOR uuid_key_generator;
+DROP SHARDING KEY GENERATOR snowflake_key_generator;
```
### Sharding Binding Table Rule
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.en.md
index c198426..733de6d 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.en.md
@@ -142,6 +142,12 @@ DROP SHARDING ALGORITHM t_order_hash_mod;
*Table*
```sql
+CREATE SHARDING ALGORITHM database_inline (
+TYPE(NAME=inline,PROPERTIES("algorithm-expression"="resource_${user_id % 2}"))
+),table_inline (
+TYPE(NAME=inline,PROPERTIES("algorithm-expression"="t_order_item_${order_id %
2}"))
+);
+
CREATE SHARDING TABLE RULE t_order_item (
DATANODES("resource_${0..1}.t_order_item_${0..1}"),
DATABASE_STRATEGY(TYPE=standard,SHARDING_COLUMN=user_id,SHARDING_ALGORITHM=database_inline),
@@ -149,46 +155,40 @@
TABLE_STRATEGY(TYPE=standard,SHARDING_COLUMN=order_id,SHARDING_ALGORITHM=table_i
GENERATED_KEY(COLUMN=another_id,TYPE(NAME=snowflake,PROPERTIES("worker-id"=123)))
);
+ALTER SHARDING ALGORITHM database_inline (
+TYPE(NAME=inline,PROPERTIES("algorithm-expression"="resource_${user_id % 4}"))
+),table_inline (
+TYPE(NAME=inline,PROPERTIES("algorithm-expression"="t_order_item_${order_id %
4}"))
+);
+
ALTER SHARDING TABLE RULE t_order_item (
DATANODES("resource_${0..3}.t_order_item${0..3}"),
DATABASE_STRATEGY(TYPE=standard,SHARDING_COLUMN=user_id,SHARDING_ALGORITHM=database_inline),
TABLE_STRATEGY(TYPE=standard,SHARDING_COLUMN=order_id,SHARDING_ALGORITHM=table_inline),
-GENERATED_KEY(COLUMN=another_id,TYPE(NAME=uuid,PROPERTIES("worker-id"=123)))
+GENERATED_KEY(COLUMN=another_id,TYPE(NAME=snowflake,PROPERTIES("worker-id"=123)))
);
DROP SHARDING TABLE RULE t_order_item;
+DROP SHARDING ALGORITHM database_inline;
+
CREATE DEFAULT SHARDING DATABASE STRATEGY (
TYPE = standard,SHARDING_COLUMN=order_id,SHARDING_ALGORITHM=algorithmsName
);
-
-CREATE SHARDING ALGORITHM database_inline (
-TYPE(NAME=inline,PROPERTIES("algorithm-expression"="resource_${user_id % 2}"))
-),table_inline (
-TYPE(NAME=inline,PROPERTIES("algorithm-expression"="t_order_item_${order_id %
2}"))
-);
-
-ALTER SHARDING ALGORITHM database_inline (
-TYPE(NAME=inline,PROPERTIES("algorithm-expression"="resource_${user_id % 4}"))
-),table_inline (
-TYPE(NAME=inline,PROPERTIES("algorithm-expression"="t_order_item_${order_id %
4}"))
-);
-
-DROP SHARDING ALGORITHM database_inline;
```
*Key Generator*
```sql
-CREATE SHARDING KEY GENERATOR uuid_key_generator (
-TYPE(NAME=uuid, PROPERTIES("worker-id"=123))
+CREATE SHARDING KEY GENERATOR snowflake_key_generator (
+TYPE(NAME=SNOWFLAKE, PROPERTIES("worker-id"=123))
);
-ALTER SHARDING KEY GENERATOR uuid_key_generator (
-TYPE(NAME=uuid, PROPERTIES("worker-id"=123))
+ALTER SHARDING KEY GENERATOR snowflake_key_generator (
+TYPE(NAME=SNOWFLAKE, PROPERTIES("worker-id"=456))
);
-DROP SHARDING KEY GENERATOR uuid_key_generator;
+DROP SHARDING KEY GENERATOR snowflake_key_generator;
```
### Sharding Binding Table Rule
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.cn.md
index 2f9db44..c673cab 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.cn.md
@@ -12,6 +12,8 @@ SHOW SHARDING TABLE tableRule | RULES [FROM schemaName]
SHOW SHARDING ALGORITHMS [FROM schemaName]
+SHOW SHARDING TABLE NODES;
+
tableRule:
RULE tableName
```
@@ -59,6 +61,13 @@ SHOW SHARDING BROADCAST TABLE RULES [FROM schemaName]
| type | 分片算法类型 |
| props | 分片算法参数 |
+### Sharding Table Nodes
+
+| 列 | 说明 |
+| ------| --------------|
+| name | 分片规则名称 |
+| nodes | 分片节点 |
+
### Sharding Binding Table Rule
| 列 | 说明 |
@@ -111,6 +120,18 @@ mysql> show sharding algorithms;
2 row in set (0.01 sec)
```
+*SHOW SHARDING TABLE NODES*
+
+```sql
+mysql> show sharding table nodes;
++---------+----------------------------------------------------------------+
+| name | nodes |
++---------+----------------------------------------------------------------+
+| t_order | ds_0.t_order_0, ds_1.t_order_1, ds_0.t_order_2, ds_1.t_order_3 |
++---------+----------------------------------------------------------------+
+1 row in set (0.02 sec)
+```
+
### Sharding Binding Table Rule
```sql
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.en.md
index 4c869a3..1c14333 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/sharding.en.md
@@ -12,6 +12,8 @@ SHOW SHARDING TABLE tableRule | RULES [FROM schemaName]
SHOW SHARDING ALGORITHMS [FROM schemaName]
+SHOW SHARDING TABLE NODES;
+
tableRule:
RULE tableName
```
@@ -59,6 +61,13 @@ SHOW SHARDING BROADCAST TABLE RULES [FROM schemaName]
| type | Sharding algorithm type |
| props | Sharding algorithm parameters |
+### Sharding Table Nodes
+
+| Column | Description |
+| -------| ---------------------|
+| name | Sharding rule name |
+| nodes | Sharding nodes |
+
### Sharding Binding Table Rule
| Column | Description |
@@ -111,6 +120,18 @@ mysql> show sharding algorithms;
2 row in set (0.01 sec)
```
+*SHOW SHARDING TABLE NODES*
+
+```sql
+mysql> show sharding table nodes;
++---------+----------------------------------------------------------------+
+| name | nodes |
++---------+----------------------------------------------------------------+
+| t_order | ds_0.t_order_0, ds_1.t_order_1, ds_0.t_order_2, ds_1.t_order_3 |
++---------+----------------------------------------------------------------+
+1 row in set (0.02 sec)
+```
+
### Sharding Binding Table Rule
```sql
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.cn.md
index ece0f7c..4a7e426 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.cn.md
@@ -8,21 +8,45 @@ weight = 2
```sql
SHOW SINGLE TABLE (tableRule | RULES) [FROM schemaName]
+SHOW SINGLE TABLES
+
tableRule:
RULE tableName
```
## 返回值说明
+### Single Table Rule
+
| 列 | 说明 |
| ------------- | ------------ |
-| table_name | 单表名称 |
+| name | 规则名称 |
| resource_name | 数据源名称 |
+### Single Table
+
+| 列 | 说明 |
+| ------------- | -------------------- |
+| table_name | 单表名称 |
+| resource_name | 单表所在的数据源名称 |
+
## 示例
+*single table rules*
+
```sql
-mysql> show single table rules;
+sql> show single table rules;
++---------+---------------+
+| name | resource_name |
++---------+---------------+
+| default | ds_1 |
++---------+---------------+
+1 row in set (0.01 sec)
+```
+
+*single tables*
+```sql
+mysql> show single tables;
+--------------+---------------+
| table_name | resource_name |
+--------------+---------------+
@@ -30,4 +54,4 @@ mysql> show single table rules;
| t_single_1 | ds_1 |
+--------------+---------------+
2 rows in set (0.02 sec)
-```
+```
\ No newline at end of file
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.en.md
index 729c8d7..088ad59 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table.en.md
@@ -8,21 +8,45 @@ weight = 2
```sql
SHOW SINGLE TABLE (tableRule | RULES) [FROM schemaName]
+SHOW SINGLE TABLES
+
tableRule:
RULE tableName
```
## Return Value Description
-| Column | Description |
-| ------------- | -------------------|
-| table_name | Single table name |
-| resource_name | Data source name |
+### Single Table Rule
+
+| Column | Description |
+| ------------- | ---------------- |
+| name | Rule name |
+| resource_name | Data source name |
+
+### Single Table
+
+| Column | Description |
+| ------------- | ------------------------------------------------------|
+| table_name | Single table name |
+| resource_name | The resource name where the single table is located |
## Example
+*single table rules*
+
+```sql
+sql> show single table rules;
++---------+---------------+
+| name | resource_name |
++---------+---------------+
+| default | ds_1 |
++---------+---------------+
+1 row in set (0.01 sec)
+```
+
+*single tables*
```sql
-mysql> show single table rules;
+mysql> show single tables;
+--------------+---------------+
| table_name | resource_name |
+--------------+---------------+
