[shardingsphere] branch master updated: Adjust readwrite-splitting document about spring boot starter and yaml. (#14896)

[me...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

menghaoran 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 5830256  Adjust readwrite-splitting document about spring boot starter and yaml. (#14896)
5830256 is described below

commit 58302561b17eceb55b49e4436b4ff0c707b385e8
Author: zhaojinchao <33...@users.noreply.github.com>
AuthorDate: Wed Jan 19 16:15:19 2022 +0800

    Adjust readwrite-splitting document about spring boot starter and yaml. (#14896)
    
    * Adjust readwrite-splitting document about spring boot starter and yaml.
    
    * update
---
 .../shardingsphere-jdbc/spring-boot-starter/rules/mix.cn.md  | 12 +++++++-----
 .../shardingsphere-jdbc/spring-boot-starter/rules/mix.en.md  | 10 ++++++----
 .../spring-boot-starter/rules/readwrite-splitting.cn.md      |  7 ++++---
 .../spring-boot-starter/rules/readwrite-splitting.en.md      |  7 ++++---
 .../shardingsphere-jdbc/yaml-config/rules/mix.cn.md          |  8 ++++----
 .../shardingsphere-jdbc/yaml-config/rules/mix.en.md          |  8 ++++----
 .../yaml-config/rules/readwrite-splitting.cn.md              |  9 +++++----
 .../yaml-config/rules/readwrite-splitting.en.md              |  9 +++++----
 8 files changed, 39 insertions(+), 31 deletions(-)

diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/mix.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/mix.cn.md
index 5e83bfc..44e11a8 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/mix.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/mix.cn.md
@@ -82,12 +82,14 @@ spring.shardingsphere.rules.sharding.sharding-algorithms.user-detail-table-strat
 spring.shardingsphere.rules.sharding.key-generators.snowflake.type=SNOWFLAKE
 
 # 读写分离策略配置
-# ds_0,ds_1为读写分离配置的逻辑数据源名称
-spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.write-data-source-name=write-ds0
-spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.read-data-source-names=write-ds0-read0
+# ds_0,ds_1 为读写分离配置的逻辑数据源名称
+spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.type=Static
+spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.props.write-data-source-name=write-ds0
+spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.props.read-data-source-names=write-ds0-read0
 spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.load-balancer-name=read-random
-spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.write-data-source-name=write-ds1
-spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.read-data-source-names=write-ds1-read0
+spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.type=Static
+spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.props.write-data-source-name=write-ds1
+spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.props.read-data-source-names=write-ds1-read0
 spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.load-balancer-name=read-random
 
 # 负载均衡算法配置
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/mix.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/mix.en.md
index c49d924..a323139 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/mix.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/mix.en.md
@@ -70,11 +70,13 @@ spring.shardingsphere.rules.sharding.key-generators.snowflake.type=SNOWFLAKE
 
 # read query configuration
 # ds_0,ds_1 is the logical data source name of the readwrite-splitting
-spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.write-data-source-name=write-ds0
-spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.read-data-source-names=write-ds0-read0
+spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.type=Static
+spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.props.write-data-source-name=write-ds0
+spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.props.read-data-source-names=write-ds0-read0
 spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_0.load-balancer-name=read-random
-spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.write-data-source-name=write-ds1
-spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.read-data-source-names=write-ds1-read0
+spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.type=Static
+spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.props.write-data-source-name=write-ds1
+spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.props.read-data-source-names=write-ds1-read0
 spring.shardingsphere.rules.readwrite-splitting.data-sources.ds_1.load-balancer-name=read-random
 
 # Load balance algorithm configuration
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/readwrite-splitting.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/readwrite-splitting.cn.md
index 484af8d..17bdee5 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/readwrite-splitting.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/readwrite-splitting.cn.md
@@ -8,9 +8,10 @@ weight = 2
 ```properties
 spring.shardingsphere.datasource.names= # 省略数据源配置，请参考使用手册
 
-spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.auto-aware-data-source-name= # 自动发现数据源名称(与数据库发现配合使用)
-spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.write-data-source-name= # 写数据源名称
-spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.read-data-source-names= # 读数据源名称，多个从数据源用逗号分隔
+spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.type= # 读写分离类型，如: Static，Dynamic
+spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.props.auto-aware-data-source-name= # 自动发现数据源名称(与数据库发现配合使用)
+spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.props.write-data-source-name= # 写数据源名称
+spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.props.read-data-source-names= # 读数据源名称，多个从数据源用逗号分隔
 spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.load-balancer-name= # 负载均衡算法名称
 
 # 负载均衡算法配置
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/readwrite-splitting.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/readwrite-splitting.en.md
index 25fa88c..5e1e52f 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/readwrite-splitting.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/rules/readwrite-splitting.en.md
@@ -8,9 +8,10 @@ weight = 2
 ```properties
 spring.shardingsphere.datasource.names= # Omit the data source configuration, please refer to the usage
 
-spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.auto-aware-data-source-name= # Auto aware data source name(Use with database discovery)
-spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.write-data-source-name= # Write data source name
-spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.read-data-source-names= # Read data source names, multiple data source names separated with comma
+spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.type= # Readwrite-splitting type, such as: Static, Dynamic
+spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.props.auto-aware-data-source-name= # Auto aware data source name(Use with database discovery)
+spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.props.write-data-source-name= # Write data source name
+spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.props.read-data-source-names= # Read data source names, multiple data source names separated with comma
 spring.shardingsphere.rules.readwrite-splitting.data-sources.<readwrite-splitting-data-source-name>.load-balancer-name= # Load balance algorithm name
 
 # Load balance algorithm configuration
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 1e48d68..3c7861f 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
@@ -51,10 +51,10 @@ rules:
   - !READWRITE_SPLITTING # 配置读写分离规则
     dataSources:
       ds: # 读写分离的逻辑数据源名称 `ds` 用于在数据分片中使用
-        writeDataSourceName: write_ds # 使用真实存在的数据源名称 `write_ds`
-        readDataSourceNames:
-          - read_ds_0 # 使用真实存在的数据源名称 `read_ds_0`
-          - read_ds_1 # 使用真实存在的数据源名称 `read_ds_1`
+        type: Static
+        props:
+          write-data-source-name: write_ds  # 使用真实存在的数据源名称 `write_ds`
+          read-data-source-names: read_ds_0, read_ds_1 # 使用真实存在的数据源名称 `read_ds_0` `read_ds_1`
         loadBalancerName: roundRobin
     loadBalancers:
       roundRobin:
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 4d3333f..85f86a0 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
@@ -52,10 +52,10 @@ rules:
   - !READWRITE_SPLITTING # Configure readwrite-splitting rules.
     dataSources:
       ds: # The logical data source name 'ds' for readwrite-splitting is used in data sharding.
-        writeDataSourceName: write_ds # Use the real data source name 'write_ds'.
-        readDataSourceNames:
-          - read_ds_0 # Use the real data source name 'read_ds_0'.
-          - read_ds_1 # Use the real data source name 'read_ds_1'.
+        type: Static
+        props:
+          write-data-source-name: write_ds # Use the real data source name 'write_ds'.
+          read-data-source-names: read_ds_0, read_ds_1 # Use the real data source name 'read_ds_0', 'read_ds_1'.
         loadBalancerName: roundRobin
     loadBalancers:
       roundRobin:
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 5bb1080..d08c3c5 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
@@ -10,10 +10,11 @@ rules:
 - !READWRITE_SPLITTING
   dataSources:
     <data-source-name> (+): # 读写分离逻辑数据源名称
-      autoAwareDataSourceName: # 自动发现数据源名称(与数据库发现配合使用)
-      writeDataSourceName: # 写库数据源名称
-      readDataSourceNames: 
-        - <read-data_source-name> (+) # 读库数据源名称
+        type: # 读写分离类型，比如：Static，Dynamic
+        props:
+          auto-aware-data-source-name: # 自动发现数据源名称(与数据库发现配合使用)
+          write-data-source-name: # 写库数据源名称
+          read-data-source-names: # 读库数据源名称，多个从数据源用逗号分隔
       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 ca5fc44..836cc3c 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
@@ -10,10 +10,11 @@ rules:
 - !READWRITE_SPLITTING
   dataSources:
     <data-source-name> (+): # Logic data source name of readwrite-splitting
-      autoAwareDataSourceName: # Auto aware data source name(Use with database discovery)
-      writeDataSourceName: # Write data source name
-      readDataSourceNames: 
-        - <read-data-source-name> (+) # Read data source name
+      type: # Readwrite-splitting type, such as: Static, Dynamic
+      props:
+        auto-aware-data-source-name: # Auto aware data source name(Use with database discovery)
+        write-data-source-name: # Write data source name
+        read-data-source-names: # Read data source names, multiple data source names separated with comma
       loadBalancerName: # Load balance algorithm name
   
   # Load balance algorithm configuration