You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by wu...@apache.org on 2021/06/16 03:29:08 UTC
[shardingsphere] branch master updated: Add example for RQL (#10829)
This is an automated email from the ASF dual-hosted git repository.
wuweijie 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 031f2ad Add example for RQL (#10829)
031f2ad is described below
commit 031f2ad5263aad7d5047162c566662bea20bb03b
Author: Haoran Meng <me...@gmail.com>
AuthorDate: Wed Jun 16 11:28:19 2021 +0800
Add example for RQL (#10829)
---
.../features/dist-sql/syntax/rql/_index.cn.md | 2 +-
.../syntax/rql/rql-db-discovery-rule.cn.md | 12 +++++
.../dist-sql/syntax/rql/rql-encrypt-rule.cn.md | 37 +++++++++++++++
.../syntax/rql/rql-readwrite-splitting-rule.cn.md | 35 ++++++++++++++
.../dist-sql/syntax/rql/rql-resource.cn.md | 13 ++++++
.../dist-sql/syntax/rql/rql-sharding-rule.cn.md | 54 ++++++++++++++++++++++
6 files changed, 152 insertions(+), 1 deletion(-)
diff --git a/docs/document/content/features/dist-sql/syntax/rql/_index.cn.md b/docs/document/content/features/dist-sql/syntax/rql/_index.cn.md
index d893416..8cc647b 100644
--- a/docs/document/content/features/dist-sql/syntax/rql/_index.cn.md
+++ b/docs/document/content/features/dist-sql/syntax/rql/_index.cn.md
@@ -5,4 +5,4 @@ weight = 2
chapter = true
+++
-本章节将对 RQL 的语法进行详细说明，并列举所有查询列的含义。
+本章节将对 RQL 的语法进行详细说明，列举所有查询列的含义，并通过示例展示所有的查询信息。
diff --git a/docs/document/content/features/dist-sql/syntax/rql/rql-db-discovery-rule.cn.md b/docs/document/content/features/dist-sql/syntax/rql/rql-db-discovery-rule.cn.md
index 897ec3c..982f0b9 100644
--- a/docs/document/content/features/dist-sql/syntax/rql/rql-db-discovery-rule.cn.md
+++ b/docs/document/content/features/dist-sql/syntax/rql/rql-db-discovery-rule.cn.md
@@ -17,3 +17,15 @@ SHOW DB_DISCOVERY RULES [FROM schemaName]
| dataSourceNames | 数据源名称列表 |
| discoverType | 数据库发现服务类型 |
| discoverProps | 数据库发现服务参数 |
+
+## 示例
+
+```sql
+mysql> show db_discovery rules from database_discovery_db;
++-------+--------------------+--------------+-------------------------------------------------------------------------------------------------------------+
+| name | dataSourceNames | discoverType | discoverProps |
++-------+--------------------+--------------+-------------------------------------------------------------------------------------------------------------+
+| pr_ds | ds_0, ds_1, ds_2 | MGR | keepAliveCron=0/5 * * * * ?, zkServerLists=localhost:2181, groupName=92504d5b-6dec-11e8-91ea-246e9612aaf1 |
++-------+--------------------+--------------+-------------------------------------------------------------------------------------------------------------+
+1 row in set (0.00 sec)
+```
diff --git a/docs/document/content/features/dist-sql/syntax/rql/rql-encrypt-rule.cn.md b/docs/document/content/features/dist-sql/syntax/rql/rql-encrypt-rule.cn.md
index d6ae218..fb0dcf7 100644
--- a/docs/document/content/features/dist-sql/syntax/rql/rql-encrypt-rule.cn.md
+++ b/docs/document/content/features/dist-sql/syntax/rql/rql-encrypt-rule.cn.md
@@ -22,3 +22,40 @@ SHOW ENCRYPT TABLE RULE tableName [from schemaName]
| plainColumn | 明文列名 |
| encryptorType | 加密算法类型 |
| encryptorProps | 加密算法参数 |
+
+## 示例
+
+*SHOW ENCRYPT RULES*
+```sql
+mysql> show encrypt rules from encrypt_db;
++-----------+-------------+--------------+-------------+---------------+-------------------------+
+| table | logicColumn | cipherColumn | plainColumn | encryptorType | encryptorProps |
++-----------+-------------+--------------+-------------+---------------+-------------------------+
+| t_encrypt | order_id | order_cipher | NULL | MD5 | |
+| t_encrypt | user_id | user_cipher | user_plain | AES | aes-key-value=123456abc |
+| t_order | item_id | order_cipher | NULL | MD5 | |
+| t_order | order_id | user_cipher | user_plain | AES | aes-key-value=123456abc |
++-----------+-------------+--------------+-------------+---------------+-------------------------+
+4 rows in set (0.01 sec)
+```
+
+*SHOW ENCRYPT TABLE RULE tableName*
+```sql
+mysql> show encrypt table rule t_encrypt;
++-----------+-------------+--------------+-------------+---------------+-------------------------+
+| table | logicColumn | cipherColumn | plainColumn | encryptorType | encryptorProps |
++-----------+-------------+--------------+-------------+---------------+-------------------------+
+| t_encrypt | order_id | order_cipher | NULL | MD5 | |
+| t_encrypt | user_id | user_cipher | user_plain | AES | aes-key-value=123456abc |
++-----------+-------------+--------------+-------------+---------------+-------------------------+
+2 rows in set (0.00 sec)
+
+mysql> show encrypt table rule t_encrypt from encrypt_db;
++-----------+-------------+--------------+-------------+---------------+-------------------------+
+| table | logicColumn | cipherColumn | plainColumn | encryptorType | encryptorProps |
++-----------+-------------+--------------+-------------+---------------+-------------------------+
+| t_encrypt | order_id | order_cipher | NULL | MD5 | |
+| t_encrypt | user_id | user_cipher | user_plain | AES | aes-key-value=123456abc |
++-----------+-------------+--------------+-------------+---------------+-------------------------+
+2 rows in set (0.00 sec)
+```
diff --git a/docs/document/content/features/dist-sql/syntax/rql/rql-readwrite-splitting-rule.cn.md b/docs/document/content/features/dist-sql/syntax/rql/rql-readwrite-splitting-rule.cn.md
index 0e1ccdf..4367eff 100644
--- a/docs/document/content/features/dist-sql/syntax/rql/rql-readwrite-splitting-rule.cn.md
+++ b/docs/document/content/features/dist-sql/syntax/rql/rql-readwrite-splitting-rule.cn.md
@@ -19,3 +19,38 @@ SHOW READWRITE_SPLITTING RULES [FROM schemaName]
| readDataSourceNames | 读数据源名称列表 |
| loadBalancerType | 负载均衡算法类型 |
| loadBalancerProps | 负载均衡算法参数 |
+
+## 示例
+
+*静态读写分离规则*
+```sql
+mysql> show readwrite_splitting rules;
++------------+-------------------------+---------------------+--------------------------+------------------+------------------------+
+| name | autoAwareDataSourceName | writeDataSourceName | readDataSourceNames | loadBalancerType | loadBalancerProps |
++------------+-------------------------+---------------------+--------------------------+------------------+------------------------+
+| ms_group_0 | NULL | ds_primary | ds_slave_0, ds_slave_1 | random | |
++------------+-------------------------+---------------------+--------------------------+------------------+------------------------+
+1 row in set (0.00 sec)
+```
+
+*动态读写分离规则*
+```sql
+mysql> show readwrite_splitting rules from readwrite_splitting_db;
++-------+-------------------------+---------------------+---------------------+------------------+------------------------+
+| name | autoAwareDataSourceName | writeDataSourceName | readDataSourceNames | loadBalancerType | loadBalancerProps |
++-------+-------------------------+---------------------+---------------------+------------------+------------------------+
+| pr_ds | ms_group_0 | NULL | | random | read_weight=2:1} |
++-------+-------------------------+---------------------+---------------------+------------------+------------------------+
+1 row in set (0.01 sec)
+```
+
+*静态读写分离规则和动态读写分离规则*
+```sql
+mysql> show readwrite_splitting rules from readwrite_splitting_db;
++-------+-------------------------+---------------------+------------------------+------------------+------------------------+
+| name | autoAwareDataSourceName | writeDataSourceName | readDataSourceNames | loadBalancerType | loadBalancerProps |
++-------+-------------------------+---------------------+------------------------+------------------+------------------------+
+| pr_ds | ms_group_0 | write_ds | read_ds_0, read_ds_1 | random | read_weight=2:1 |
++-------+-------------------------+---------------------+------------------------+------------------+------------------------+
+1 row in set (0.00 sec)
+```
diff --git a/docs/document/content/features/dist-sql/syntax/rql/rql-resource.cn.md b/docs/document/content/features/dist-sql/syntax/rql/rql-resource.cn.md
index 31c5b43..ef37a04 100644
--- a/docs/document/content/features/dist-sql/syntax/rql/rql-resource.cn.md
+++ b/docs/document/content/features/dist-sql/syntax/rql/rql-resource.cn.md
@@ -19,3 +19,16 @@ SHOW RESOURCES [FROM schemaName]
| port | 数据源端口 |
| db | 数据库名称 |
| attribute | 数据源参数 |
+
+## 示例
+
+```sql
+mysql> show resources;
++------+-------+-----------+------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| name | type | host | port | db | attribute |
++------+-------+-----------+------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ds_0 | MySQL | 127.0.0.1 | 3306 | ds_0 | {"minPoolSize":1,"connectionTimeoutMilliseconds":30000,"maxLifetimeMilliseconds":1800000,"readOnly":false,"idleTimeoutMilliseconds":60000,"maxPoolSize":50,"maintenanceIntervalMilliseconds":30000} |
+| ds_1 | MySQL | 127.0.0.1 | 3306 | ds_1 | {"minPoolSize":1,"connectionTimeoutMilliseconds":30000,"maxLifetimeMilliseconds":1800000,"readOnly":false,"idleTimeoutMilliseconds":60000,"maxPoolSize":50,"maintenanceIntervalMilliseconds":30000} |
++------+-------+-----------+------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+2 rows in set (0.84 sec)
+```
diff --git a/docs/document/content/features/dist-sql/syntax/rql/rql-sharding-rule.cn.md b/docs/document/content/features/dist-sql/syntax/rql/rql-sharding-rule.cn.md
index 99fcb0e..aea29ad 100644
--- a/docs/document/content/features/dist-sql/syntax/rql/rql-sharding-rule.cn.md
+++ b/docs/document/content/features/dist-sql/syntax/rql/rql-sharding-rule.cn.md
@@ -59,3 +59,57 @@ SHOW SHARDING BROADCAST TABLE RULES [FROM schemaName]
| 列 | 说明 |
| ----------------------- | -------- |
| shardingBroadcastTables | 广播表名称 |
+
+## 示例
+
+### Sharding Table Rule
+
+*SHOW SHARDING TABLE RULES*
+```sql
+mysql> show sharding table rules;
++--------------+---------------------------------+-------------------+----------------------+------------------------+-------------------------------+----------------------------------------+-------------------+---------------------+----------------------------+---------------------------------------------------+-------------------+------------------+-------------------+
+| table | actualDataNodes | actualDataSources | databaseStrategyType | databaseShardingColumn | databaseShardingAlgorithmType | databaseShardingAlgorithmProps | tableStrategyType | tableShardingColumn | tableShardingAlgorithmType | tableShardingAlgorithmProps | keyGenerateColumn | keyGeneratorType | keyGeneratorProps |
++--------------+---------------------------------+-------------------+----------------------+------------------------+-------------------------------+----------------------------------------+-------------------+---------------------+----------------------------+---------------------------------------------------+-------------------+------------------+-------------------+
+| t_order | ds_${0..1}.t_order_${0..1} | | INLINE | user_id | INLINE | algorithm-expression:ds_${user_id % 2} | INLINE | order_id | INLINE | algorithm-expression:t_order_${order_id % 2} | order_id | SNOWFLAKE | worker-id:123 |
+| t_order_item | ds_${0..1}.t_order_item_${0..1} | | INLINE | user_id | INLINE | algorithm-expression:ds_${user_id % 2} | INLINE | order_id | INLINE | algorithm-expression:t_order_item_${order_id % 2} | order_item_id | SNOWFLAKE | worker-id:123 |
+| t2 | | ds_0,ds_1 | | | | | mod | id | mod | sharding-count:10 | | | |
++--------------+---------------------------------+-------------------+----------------------+------------------------+-------------------------------+----------------------------------------+-------------------+---------------------+----------------------------+---------------------------------------------------+-------------------+------------------+-------------------+
+3 rows in set (0.02 sec)
+```
+
+*SHOW SHARDING TABLE RULE tableName*
+```sql
+mysql> show sharding table rule t_order;
++---------+----------------------------+-------------------+----------------------+------------------------+-------------------------------+----------------------------------------+-------------------+---------------------+----------------------------+----------------------------------------------+-------------------+------------------+-------------------+
+| table | actualDataNodes | actualDataSources | databaseStrategyType | databaseShardingColumn | databaseShardingAlgorithmType | databaseShardingAlgorithmProps | tableStrategyType | tableShardingColumn | tableShardingAlgorithmType | tableShardingAlgorithmProps | keyGenerateColumn | keyGeneratorType | keyGeneratorProps |
++---------+----------------------------+-------------------+----------------------+------------------------+-------------------------------+----------------------------------------+-------------------+---------------------+----------------------------+----------------------------------------------+-------------------+------------------+-------------------+
+| t_order | ds_${0..1}.t_order_${0..1} | | INLINE | user_id | INLINE | algorithm-expression:ds_${user_id % 2} | INLINE | order_id | INLINE | algorithm-expression:t_order_${order_id % 2} | order_id | SNOWFLAKE | worker-id:123 |
++---------+----------------------------+-------------------+----------------------+------------------------+-------------------------------+----------------------------------------+-------------------+---------------------+----------------------------+----------------------------------------------+-------------------+------------------+-------------------+
+1 row in set (0.01 sec)
+```
+
+### Sharding Binding Table Rule
+
+```sql
+mysql> show sharding binding table rules from sharding_db;
++----------------------+
+| shardingBindingTables |
++----------------------+
+| t_order,t_order_item |
+| t1,t2 |
++----------------------+
+2 rows in set (0.00 sec)
+```
+
+### Sharding Broadcast Table Rule
+
+```sql
+mysql> show sharding broadcast table rules;
++------------------------+
+| shardingBroadcastTables |
++------------------------+
+| t_1 |
+| t_2 |
++------------------------+
+2 rows in set (0.00 sec)
+```