You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2023/03/24 10:48:51 UTC

[shardingsphere] branch master updated: Rename TransactionalReadQueryStrategy's enum name (#24809)

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

zhonghongsheng 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 a20caa6fe3a Rename TransactionalReadQueryStrategy's enum name (#24809)
a20caa6fe3a is described below

commit a20caa6fe3a80f00b3a7b030b03497d57a8e108e
Author: Liang Zhang <zh...@apache.org>
AuthorDate: Fri Mar 24 18:48:43 2023 +0800

    Rename TransactionalReadQueryStrategy's enum name (#24809)
---
 .../common-config/builtin-algorithm/load-balance.cn.md     |  2 +-
 .../common-config/builtin-algorithm/load-balance.en.md     |  2 +-
 .../java-api/rules/readwrite-splitting.cn.md               | 14 +++++++-------
 .../java-api/rules/readwrite-splitting.en.md               | 14 +++++++-------
 .../shardingsphere-jdbc/yaml-config/rules/ha.cn.md         |  2 +-
 .../yaml-config/rules/readwrite-splitting.cn.md            |  6 +++---
 .../yaml-config/rules/readwrite-splitting.en.md            |  6 +++---
 .../ReadwriteSplittingDataSourceRuleConfiguration.java     |  2 +-
 .../api/transaction/TransactionalReadQueryStrategy.java    |  2 +-
 .../route/impl/ReadwriteSplittingDataSourceRouter.java     |  6 +++---
 .../YamlReadwriteSplittingRuleConfigurationSwapper.java    |  2 +-
 .../rule/ReadwriteSplittingDataSourceRuleTest.java         |  2 +-
 12 files changed, 30 insertions(+), 30 deletions(-)

diff --git a/docs/document/content/user-manual/common-config/builtin-algorithm/load-balance.cn.md b/docs/document/content/user-manual/common-config/builtin-algorithm/load-balance.cn.md
index b539eeaad3b..a54c1cb118a 100644
--- a/docs/document/content/user-manual/common-config/builtin-algorithm/load-balance.cn.md
+++ b/docs/document/content/user-manual/common-config/builtin-algorithm/load-balance.cn.md
@@ -48,7 +48,7 @@ rules:
     random:
       type: RANDOM
       props:
-        transaction-read-query-strategy: FIXED_PRIMARY
+        transaction-read-query-strategy: PRIMARY
 ```
 
 ## 相关参考
diff --git a/docs/document/content/user-manual/common-config/builtin-algorithm/load-balance.en.md b/docs/document/content/user-manual/common-config/builtin-algorithm/load-balance.en.md
index 4a18fbdd4e4..b2e2ee211c2 100644
--- a/docs/document/content/user-manual/common-config/builtin-algorithm/load-balance.en.md
+++ b/docs/document/content/user-manual/common-config/builtin-algorithm/load-balance.en.md
@@ -50,7 +50,7 @@ rules:
     random:
       type: RANDOM
       props:
-        transaction-read-query-strategy: FIXED_PRIMARY
+        transaction-read-query-strategy: PRIMARY
 ```
 
 ## Related References
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.cn.md
index 42be85b99e9..4285a2391cf 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.cn.md
@@ -26,13 +26,13 @@ Java API 形式配置的读写分离可以方便的适用于各种场景,不
 
 可配置属性:
 
-| *名称*                               | *数据类型*                                         | *说明*                                                                                                                   | *默认值*    |
-|------------------------------------|------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|----------|
-| name                               | String                                         | 读写分离数据源名称                                                                                                              | -        |
-| staticStrategy                     | StaticReadwriteSplittingStrategyConfiguration  | 静态读写分离配置                                                                                                               | -        |
-| dynamicStrategy                    | DynamicReadwriteSplittingStrategyConfiguration | 动态读写分离配置                                                                                                               | -        |
-| transactionalReadQueryStrategy (?) | TransactionalReadQueryStrategy                 | 事务内读请求的路由策略,可选值:FIXED_PRIMARY(路由至主库)、FIXED_REPLICA(同一事务内路由至固定数据源)、DYNAMIC_REPLICA(同一事务内路由至非固定数据源)。默认值:DYNAMIC_REPLICA。 |
-| loadBalancerName (?)               | String                                         | 读库负载均衡算法名称                                                                                                             | 轮询负载均衡算法 |
+| *名称*                               | *数据类型*                                         | *说明*                                                                        | *默认值*    |
+|------------------------------------|------------------------------------------------|-----------------------------------------------------------------------------|----------|
+| name                               | String                                         | 读写分离数据源名称                                                                   | -        |
+| staticStrategy                     | StaticReadwriteSplittingStrategyConfiguration  | 静态读写分离配置                                                                    | -        |
+| dynamicStrategy                    | DynamicReadwriteSplittingStrategyConfiguration | 动态读写分离配置                                                                    | -        |
+| transactionalReadQueryStrategy (?) | TransactionalReadQueryStrategy                 | 事务内读请求的路由策略,可选值:PRIMARY(路由至主库)、FIXED(同一事务内路由至固定数据源)、DYNAMIC(同一事务内路由至非固定数据源) | DYNAMIC  |
+| loadBalancerName (?)               | String                                         | 读库负载均衡算法名称                                                                  | 轮询负载均衡算法 |
 
 类名称:org.apache.shardingsphere.readwritesplitting.api.strategy.StaticReadwriteSplittingStrategyConfiguration
 
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.en.md
index d5f49721108..22d21966cea 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/readwrite-splitting.en.md
@@ -26,13 +26,13 @@ Class name: org.apache.shardingsphere.readwritesplitting.api.rule.ReadwriteSplit
 
 Configurable Properties:
 
-| *Name*                             | *DataType*                     | *Description*                                                                                                                                                                                                 | *Default Value*                    |
-|------------------------------------|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
-| name                               | String                         | Readwrite-splitting data source name                                                                                                                                                                          | -                                  |
-| staticStrategy                     | String                         | Static Readwrite-splitting configuration                                                                                                                                                                      | -                                  |
-| dynamicStrategy                    | Properties                     | Dynamic Readwrite-splitting configuration                                                                                                                                                                     | -                                  |
-| transactionalReadQueryStrategy (?) | TransactionalReadQueryStrategy | Routing strategy for read query within a transaction, values include: FIXED_PRIMARY (to primary), FIXED_REPLICA (to fixed data source), DYNAMIC_REPLICA (to any data source), default value: DYNAMIC_REPLICA. |
-| loadBalancerName (?)               | String                         | Load balance algorithm name of replica sources                                                                                                                                                                | Round robin load balance algorithm |
+| *Name*                             | *DataType*                     | *Description*                                                                                                                                          | *Default Value*                    |
+|------------------------------------|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
+| name                               | String                         | Readwrite-splitting data source name                                                                                                                   | -                                  |
+| staticStrategy                     | String                         | Static Readwrite-splitting configuration                                                                                                               | -                                  |
+| dynamicStrategy                    | Properties                     | Dynamic Readwrite-splitting configuration                                                                                                              | -                                  |
+| transactionalReadQueryStrategy (?) | TransactionalReadQueryStrategy | Routing strategy for read query within a transaction, values include: PRIMARY (to primary), FIXED (to fixed data source), DYNAMIC (to any data source) | DYNAMIC                            |
+| loadBalancerName (?)               | String                         | Load balance algorithm name of replica sources                                                                                                         | Round robin load balance algorithm |
 
 Class name:org.apache.shardingsphere.readwritesplitting.api.strategy.StaticReadwriteSplittingStrategyConfiguration
 
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/ha.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/ha.cn.md
index d2f44ad1b99..ce7ced3b40c 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/ha.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/ha.cn.md
@@ -14,7 +14,7 @@ rules:
 - !READWRITE_SPLITTING
   dataSources:
     replica_ds:
-      dynamicStrategy: Dynamic # 动态读写分离
+      dynamicStrategy: # 动态读写分离
         autoAwareDataSourceName: # 高可用规则逻辑数据源名称
 
 - !DB_DISCOVERY
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 5aeaff11dd7..4c96f3ccf9b 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
@@ -19,7 +19,7 @@ rules:
        static_strategy: # 读写分离类型
          write_data_source_name: # 写库数据源名称
          read_data_source_names: # 读库数据源名称,多个从数据源用逗号分隔
-       transactionalReadQueryStrategy (?): # 事务内读请求的路由策略,可选值:FIXED_PRIMARY(路由至主库)、FIXED_REPLICA(同一事务内路由至固定数据源)、DYNAMIC_REPLICA(同一事务内路由至非固定数据源)。默认值:DYNAMIC_REPLICA
+       transactionalReadQueryStrategy (?): # 事务内读请求的路由策略,可选值:PRIMARY(路由至主库)、FIXED(同一事务内路由至固定数据源)、DYNAMIC(同一事务内路由至非固定数据源)。默认值:DYNAMIC
        loadBalancerName: # 负载均衡算法名称
   
   # 负载均衡算法配置
@@ -39,7 +39,7 @@ rules:
     <data_source_name> (+): # 读写分离逻辑数据源名称
        dynamic_strategy: # 读写分离类型
          auto_aware_data_source_name: # 数据库发现逻辑数据源名称
-       transactionalReadQueryStrategy (?): # 事务内读请求的路由策略,可选值:FIXED_PRIMARY(路由至主库)、FIXED_REPLICA(同一事务内路由至固定数据源)、DYNAMIC_REPLICA(同一事务内路由至非固定数据源)。默认值:DYNAMIC_REPLICA
+       transactionalReadQueryStrategy (?): # 事务内读请求的路由策略,可选值:PRIMARY(路由至主库)、FIXED(同一事务内路由至固定数据源)、DYNAMIC(同一事务内路由至非固定数据源)。默认值:DYNAMIC
        loadBalancerName: # 负载均衡算法名称
   
   # 负载均衡算法配置
@@ -68,7 +68,7 @@ rules:
         readDataSourceNames:
           - read_ds_0
           - read_ds_1
-      transactionalReadQueryStrategy: FIXED_PRIMARY
+      transactionalReadQueryStrategy: PRIMARY
       loadBalancerName: random
   loadBalancers:
     random:
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 25b2882c029..c560fdf1b92 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
@@ -18,7 +18,7 @@ rules:
       static_strategy: # Readwrite-splitting type
         write_data_source_name: # Write data source name
         read_data_source_names: # Read data source names, multiple data source names separated with comma
-      transactionalReadQueryStrategy (?): # Routing strategy for read query within a transaction, values include: FIXED_PRIMARY (to primary), FIXED_REPLICA (to fixed data source), DYNAMIC_REPLICA (to any data source), default value: DYNAMIC_REPLICA
+      transactionalReadQueryStrategy (?): # Routing strategy for read query within a transaction, values include: PRIMARY (to primary), FIXED (to fixed data source), DYNAMIC (to any data source), default value: DYNAMIC
       loadBalancerName: # Load balance algorithm name
   
   # Load balance algorithm configuration
@@ -38,7 +38,7 @@ rules:
     <data_source_name> (+): # Logic data source name of readwrite-splitting
       dynamic_strategy: # Readwrite-splitting type
         auto_aware_data_source_name: # Database discovery logic data source name
-      transactionalReadQueryStrategy (?): # Routing strategy for read query within a transaction, values include: FIXED_PRIMARY (to primary), FIXED_REPLICA (to fixed data source), DYNAMIC_REPLICA (to any data source), default value: DYNAMIC_REPLICA
+      transactionalReadQueryStrategy (?): # Routing strategy for read query within a transaction, values include: PRIMARY (to primary), FIXED (to fixed data source), DYNAMIC (to any data source), default value: DYNAMIC
       loadBalancerName: # Load balance algorithm name
   
   # Load balance algorithm configuration
@@ -68,7 +68,7 @@ rules:
         readDataSourceNames:
           - read_ds_0
           - read_ds_1
-      transactionalReadQueryStrategy: FIXED_PRIMARY
+      transactionalReadQueryStrategy: PRIMARY
       loadBalancerName: random
   loadBalancers:
     random:
diff --git a/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/api/rule/ReadwriteSplittingDataSourceRuleConfiguration.java b/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/api/rule/ReadwriteSplittingDataSourceRuleConfiguration.java
index 802b42839fd..d5472ff2038 100644
--- a/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/api/rule/ReadwriteSplittingDataSourceRuleConfiguration.java
+++ b/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/api/rule/ReadwriteSplittingDataSourceRuleConfiguration.java
@@ -42,6 +42,6 @@ public final class ReadwriteSplittingDataSourceRuleConfiguration {
     
     public ReadwriteSplittingDataSourceRuleConfiguration(final String name, final StaticReadwriteSplittingStrategyConfiguration staticStrategy,
                                                          final DynamicReadwriteSplittingStrategyConfiguration dynamicStrategy, final String loadBalancerName) {
-        this(name, staticStrategy, dynamicStrategy, TransactionalReadQueryStrategy.DYNAMIC_REPLICA, loadBalancerName);
+        this(name, staticStrategy, dynamicStrategy, TransactionalReadQueryStrategy.DYNAMIC, loadBalancerName);
     }
 }
diff --git a/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/api/transaction/TransactionalReadQueryStrategy.java b/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/api/transaction/TransactionalReadQueryStrategy.java
index 9c8f8a22af9..0baa371c030 100644
--- a/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/api/transaction/TransactionalReadQueryStrategy.java
+++ b/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/api/transaction/TransactionalReadQueryStrategy.java
@@ -22,5 +22,5 @@ package org.apache.shardingsphere.readwritesplitting.api.transaction;
  */
 public enum TransactionalReadQueryStrategy {
     
-    FIXED_PRIMARY, FIXED_REPLICA, DYNAMIC_REPLICA
+    PRIMARY, FIXED, DYNAMIC
 }
diff --git a/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/route/impl/ReadwriteSplittingDataSourceRouter.java b/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/route/impl/ReadwriteSplittingDataSourceRouter.java
index 0ae1bf1d843..9da8d7086f1 100644
--- a/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/route/impl/ReadwriteSplittingDataSourceRouter.java
+++ b/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/route/impl/ReadwriteSplittingDataSourceRouter.java
@@ -77,14 +77,14 @@ public final class ReadwriteSplittingDataSourceRouter {
     
     private String routeInTransaction() {
         switch (rule.getTransactionalReadQueryStrategy()) {
-            case FIXED_REPLICA:
+            case FIXED:
                 if (null == connectionContext.getTransactionContext().getReadWriteSplitReplicaRoute()) {
                     connectionContext.getTransactionContext().setReadWriteSplitReplicaRoute(routeWithLoadBalancer());
                 }
                 return connectionContext.getTransactionContext().getReadWriteSplitReplicaRoute();
-            case DYNAMIC_REPLICA:
+            case DYNAMIC:
                 return routeWithLoadBalancer();
-            case FIXED_PRIMARY:
+            case PRIMARY:
             default:
                 return rule.getWriteDataSource();
         }
diff --git a/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/yaml/swapper/YamlReadwriteSplittingRuleConfigurationSwapper.java b/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/yaml/swapper/YamlReadwriteSplittingRuleConfigurationSwapper.java
index dae41ef07d2..fb9b350db99 100644
--- a/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/yaml/swapper/YamlReadwriteSplittingRuleConfigurationSwapper.java
+++ b/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/yaml/swapper/YamlReadwriteSplittingRuleConfigurationSwapper.java
@@ -95,7 +95,7 @@ public final class YamlReadwriteSplittingRuleConfigurationSwapper
     
     private TransactionalReadQueryStrategy getTransactionalReadQueryStrategy(final YamlReadwriteSplittingDataSourceRuleConfiguration yamlDataSourceRuleConfig) {
         return Strings.isNullOrEmpty(yamlDataSourceRuleConfig.getTransactionalReadQueryStrategy())
-                ? TransactionalReadQueryStrategy.DYNAMIC_REPLICA
+                ? TransactionalReadQueryStrategy.DYNAMIC
                 : TransactionalReadQueryStrategy.valueOf(yamlDataSourceRuleConfig.getTransactionalReadQueryStrategy());
     }
     
diff --git a/features/readwrite-splitting/core/src/test/java/org/apache/shardingsphere/readwritesplitting/rule/ReadwriteSplittingDataSourceRuleTest.java b/features/readwrite-splitting/core/src/test/java/org/apache/shardingsphere/readwritesplitting/rule/ReadwriteSplittingDataSourceRuleTest.java
index e571d945340..da8a8902d5a 100644
--- a/features/readwrite-splitting/core/src/test/java/org/apache/shardingsphere/readwritesplitting/rule/ReadwriteSplittingDataSourceRuleTest.java
+++ b/features/readwrite-splitting/core/src/test/java/org/apache/shardingsphere/readwritesplitting/rule/ReadwriteSplittingDataSourceRuleTest.java
@@ -39,7 +39,7 @@ public final class ReadwriteSplittingDataSourceRuleTest {
         readwriteSplittingDataSourceRule = new ReadwriteSplittingDataSourceRule(
                 new ReadwriteSplittingDataSourceRuleConfiguration("test_pr",
                         new StaticReadwriteSplittingStrategyConfiguration("write_ds", Arrays.asList("read_ds_0", "read_ds_1")), null, null),
-                TransactionalReadQueryStrategy.DYNAMIC_REPLICA, new RandomReadQueryLoadBalanceAlgorithm(), Collections.emptyList());
+                TransactionalReadQueryStrategy.DYNAMIC, new RandomReadQueryLoadBalanceAlgorithm(), Collections.emptyList());
     }
     
     @Test