You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by ch...@apache.org on 2025/09/05 07:22:53 UTC

(shardingsphere) branch master updated: Update transactionalReadQueryStrategy default type and modify doc (#36477)

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

chengzhang 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 1f3d88aab93 Update transactionalReadQueryStrategy default type and modify doc (#36477)
1f3d88aab93 is described below

commit 1f3d88aab93dee4c80c5e68d0818f20b78aabc14
Author: Zhengqiang Duan <du...@apache.org>
AuthorDate: Fri Sep 5 15:22:48 2025 +0800

    Update transactionalReadQueryStrategy default type and modify doc (#36477)
    
    * Update transactionalReadQueryStrategy default type and modify doc
    
    * fix unit test
---
 RELEASE-NOTES.md                                           |  1 +
 .../java-api/rules/readwrite-splitting.cn.md               | 14 +++++++-------
 .../java-api/rules/readwrite-splitting.en.md               | 14 +++++++-------
 ...ReadwriteSplittingDataSourceGroupRuleConfiguration.java |  2 +-
 .../ReadwriteSplittingDataSourceChangedProcessor.java      |  4 ++--
 .../YamlReadwriteSplittingRuleConfigurationSwapper.java    |  2 +-
 ...teSplittingRuleConfigurationToDistSQLConverterTest.java |  4 ++--
 .../test/resources/cases/show-readwrite-splitting-rule.xml |  2 +-
 .../core/src/test/resources/expected/convert-mix.yaml      |  4 ++--
 9 files changed, 24 insertions(+), 23 deletions(-)

diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
index d567ba3b458..173e658c5e0 100644
--- a/RELEASE-NOTES.md
+++ b/RELEASE-NOTES.md
@@ -140,6 +140,7 @@
 1. Encrypt: Use EncryptDerivedColumnSuffix to enhance encrypt table subquery rewrite logic - [#34829](https://github.com/apache/shardingsphere/pull/34829)
 1. Encrypt: Add quotes to encrypt rewrite derived columns - [#34950](https://github.com/apache/shardingsphere/pull/34950)
 1. Encrypt: Add support for NOT LIKE operator in encryption - [#35984](https://github.com/apache/shardingsphere/pull/35984)
+1. Readwrite-splitting: Update transactionalReadQueryStrategy default type and modify doc - [#36477](https://github.com/apache/shardingsphere/pull/36477)
 
 ### Bug Fixes
 
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 583eb63a8e0..f86a61f54bb 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                         | 读写分离数据源名称                                                                   | -        |
-| writeDataSourceName                | String                         | 写库数据源名称                                                                     | -        |
-| readDataSourceNames                | List\<String\>                 | 读库数据源名称                                                                     | -        |
-| transactionalReadQueryStrategy (?) | TransactionalReadQueryStrategy | 事务内读请求的路由策略,可选值:PRIMARY(路由至主库)、FIXED(同一事务内路由至固定数据源)、DYNAMIC(同一事务内路由至非固定数据源) | DYNAMIC  |
-| loadBalancerName (?)               | String                         | 读库负载均衡算法名称                                                                  | 轮询负载均衡算法 |
+| *名称*                               | *数据类型*                         | *说明*                                                                                                                                       | *默认值*    |
+|------------------------------------|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|----------|
+| name                               | String                         | 读写分离数据源名称                                                                                                                                  | -        |
+| writeDataSourceName                | String                         | 写库数据源名称                                                                                                                                    | -        |
+| readDataSourceNames                | List\<String\>                 | 读库数据源名称                                                                                                                                    | -        |
+| transactionalReadQueryStrategy (?) | TransactionalReadQueryStrategy | 事务内读请求的路由策略,可选值:PRIMARY(路由至主库)、FIXED(同一事务内路由至固定数据源)、DYNAMIC(同一事务内路由至非固定数据源)。 **注意:`FIXED` 和 `DYNAMIC` 需要数据库支持主从强一致同步能力才能使用,例如:openGauss。** | PRIMARY  |
+| loadBalancerName (?)               | String                         | 读库负载均衡算法名称                                                                                                                                 | 轮询负载均衡算法 |
 
 算法类型的详情,请参见[内置负载均衡算法列表](/cn/user-manual/common-config/builtin-algorithm/load-balance)。
 
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 4eb8c186fbc..9b7e6d64849 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.config.rule.ReadwriteSp
 
 Configurable Properties:
 
-| *Name*                             | *DataType*                     | *Description*                                                                                                                                          | *Default Value*                    |
-|------------------------------------|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
-| name                               | String                         | Readwrite-splitting data source name                                                                                                                   | -                                  |
-| writeDataSourceName                | String                         | Write data source name                                                                                                                                 | -                                  |
-| readDataSourceNames                | List\<String\>                 | Read data sources list                                                                                                                                 | -                                  |
-| 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 |
+| *Name*                             | *DataType*                     | *Description*                                                                                                                                                                                                                                                                       | *Default Value*                    |
+|------------------------------------|--------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
+| name                               | String                         | Readwrite-splitting data source name                                                                                                                                                                                                                                                | -                                  |
+| writeDataSourceName                | String                         | Write data source name                                                                                                                                                                                                                                                              | -                                  |
+| readDataSourceNames                | List\<String\>                 | Read data sources list                                                                                                                                                                                                                                                              | -                                  |
+| 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). **Note: `FIXED` and `DYNAMIC` require a database that supports strong primary-replica synchronization, such as openGauss.** | PRIMARY                            |
+| loadBalancerName (?)               | String                         | Load balance algorithm name of replica sources                                                                                                                                                                                                                                      | Round robin load balance algorithm |
 
 Please refer to [Built-in Load Balance Algorithm List](/en/user-manual/common-config/builtin-algorithm/load-balance) for details on algorithm types.
 
diff --git a/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/config/rule/ReadwriteSplittingDataSourceGroupRuleConfiguration.java b/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/config/rule/ReadwriteSplittingDataSourceGroupRuleConfiguration.java
index 929fbe6c1d3..cc7684128d4 100644
--- a/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/config/rule/ReadwriteSplittingDataSourceGroupRuleConfiguration.java
+++ b/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/config/rule/ReadwriteSplittingDataSourceGroupRuleConfiguration.java
@@ -41,6 +41,6 @@ public final class ReadwriteSplittingDataSourceGroupRuleConfiguration {
     private final String loadBalancerName;
     
     public ReadwriteSplittingDataSourceGroupRuleConfiguration(final String name, final String writeDataSourceName, final List<String> readDataSourceNames, final String loadBalancerName) {
-        this(name, writeDataSourceName, readDataSourceNames, TransactionalReadQueryStrategy.DYNAMIC, loadBalancerName);
+        this(name, writeDataSourceName, readDataSourceNames, TransactionalReadQueryStrategy.PRIMARY, loadBalancerName);
     }
 }
diff --git a/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/rule/changed/ReadwriteSplittingDataSourceChangedProcessor.java b/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/rule/changed/ReadwriteSplittingDataSourceChangedProcessor.java
index 0fc4f8810a5..636dfbe3db6 100644
--- a/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/rule/changed/ReadwriteSplittingDataSourceChangedProcessor.java
+++ b/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/rule/changed/ReadwriteSplittingDataSourceChangedProcessor.java
@@ -20,8 +20,8 @@ package org.apache.shardingsphere.readwritesplitting.rule.changed;
 import com.google.common.base.Strings;
 import org.apache.shardingsphere.infra.metadata.database.ShardingSphereDatabase;
 import org.apache.shardingsphere.infra.util.yaml.YamlEngine;
-import org.apache.shardingsphere.mode.spi.rule.RuleItemConfigurationChangedProcessor;
 import org.apache.shardingsphere.mode.spi.rule.RuleChangedItemType;
+import org.apache.shardingsphere.mode.spi.rule.RuleItemConfigurationChangedProcessor;
 import org.apache.shardingsphere.readwritesplitting.config.ReadwriteSplittingRuleConfiguration;
 import org.apache.shardingsphere.readwritesplitting.config.rule.ReadwriteSplittingDataSourceGroupRuleConfiguration;
 import org.apache.shardingsphere.readwritesplitting.rule.ReadwriteSplittingRule;
@@ -47,7 +47,7 @@ public final class ReadwriteSplittingDataSourceChangedProcessor
     
     private TransactionalReadQueryStrategy getTransactionalReadQueryStrategy(final YamlReadwriteSplittingDataSourceGroupRuleConfiguration yamlDataSourceGroupRuleConfig) {
         return Strings.isNullOrEmpty(yamlDataSourceGroupRuleConfig.getTransactionalReadQueryStrategy())
-                ? TransactionalReadQueryStrategy.DYNAMIC
+                ? TransactionalReadQueryStrategy.PRIMARY
                 : TransactionalReadQueryStrategy.valueOf(yamlDataSourceGroupRuleConfig.getTransactionalReadQueryStrategy());
     }
     
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 e3e3f721cce..9a23d64b346 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
@@ -81,7 +81,7 @@ public final class YamlReadwriteSplittingRuleConfigurationSwapper implements Yam
     
     private TransactionalReadQueryStrategy getTransactionalReadQueryStrategy(final YamlReadwriteSplittingDataSourceGroupRuleConfiguration yamlDataSourceGroupRuleConfig) {
         return Strings.isNullOrEmpty(yamlDataSourceGroupRuleConfig.getTransactionalReadQueryStrategy())
-                ? TransactionalReadQueryStrategy.DYNAMIC
+                ? TransactionalReadQueryStrategy.PRIMARY
                 : TransactionalReadQueryStrategy.valueOf(yamlDataSourceGroupRuleConfig.getTransactionalReadQueryStrategy());
     }
     
diff --git a/features/readwrite-splitting/distsql/handler/src/test/java/org/apache/shardingsphere/readwritesplitting/distsql/handler/converter/ReadwriteSplittingRuleConfigurationToDistSQLConverterTest.java b/features/readwrite-splitting/distsql/handler/src/test/java/org/apache/shardingsphere/readwritesplitting/distsql/handler/converter/ReadwriteSplittingRuleConfigurationToDistSQLConverterTest.java
index 3d4c5bae0ce..12f88c167ff 100644
--- a/features/readwrite-splitting/distsql/handler/src/test/java/org/apache/shardingsphere/readwritesplitting/distsql/handler/converter/ReadwriteSplittingRuleConfigurationToDistSQLConverterTest.java
+++ b/features/readwrite-splitting/distsql/handler/src/test/java/org/apache/shardingsphere/readwritesplitting/distsql/handler/converter/ReadwriteSplittingRuleConfigurationToDistSQLConverterTest.java
@@ -54,7 +54,7 @@ class ReadwriteSplittingRuleConfigurationToDistSQLConverterTest {
                         + System.lineSeparator()
                         + "READ_STORAGE_UNITS(ds_slave_0,ds_slave_1),"
                         + System.lineSeparator()
-                        + "TRANSACTIONAL_READ_QUERY_STRATEGY='DYNAMIC',"
+                        + "TRANSACTIONAL_READ_QUERY_STRATEGY='PRIMARY',"
                         + System.lineSeparator()
                         + "TYPE(NAME='random', PROPERTIES('read_weight'='2:1'))"
                         + System.lineSeparator()
@@ -64,7 +64,7 @@ class ReadwriteSplittingRuleConfigurationToDistSQLConverterTest {
                         + System.lineSeparator()
                         + "READ_STORAGE_UNITS(ds_slave_0,ds_slave_1),"
                         + System.lineSeparator()
-                        + "TRANSACTIONAL_READ_QUERY_STRATEGY='DYNAMIC'"
+                        + "TRANSACTIONAL_READ_QUERY_STRATEGY='PRIMARY'"
                         + System.lineSeparator()
                         + ");"));
     }
diff --git a/features/readwrite-splitting/distsql/handler/src/test/resources/cases/show-readwrite-splitting-rule.xml b/features/readwrite-splitting/distsql/handler/src/test/resources/cases/show-readwrite-splitting-rule.xml
index 256e7b716fd..a263e5c657b 100644
--- a/features/readwrite-splitting/distsql/handler/src/test/resources/cases/show-readwrite-splitting-rule.xml
+++ b/features/readwrite-splitting/distsql/handler/src/test/resources/cases/show-readwrite-splitting-rule.xml
@@ -20,7 +20,7 @@
     <test-case dist-sql="SHOW READWRITE_SPLITTING RULES" current-rule-config-yaml-file="cases/show-readwrite-splitting-rule-current-config.yaml">
         <expected-query-result-rows>
             <expected-query-result-row>
-                readwrite_ds|write_ds|read_ds_0,read_ds_1|DYNAMIC||
+                readwrite_ds|write_ds|read_ds_0,read_ds_1|PRIMARY||
             </expected-query-result-row>
         </expected-query-result-rows>
     </test-case>
diff --git a/proxy/backend/core/src/test/resources/expected/convert-mix.yaml b/proxy/backend/core/src/test/resources/expected/convert-mix.yaml
index 948e1d1f609..428105ebc6d 100644
--- a/proxy/backend/core/src/test/resources/expected/convert-mix.yaml
+++ b/proxy/backend/core/src/test/resources/expected/convert-mix.yaml
@@ -52,12 +52,12 @@ PROPERTIES('minPoolSize'='1','connectionTimeoutMilliseconds'='30000','maxLifetim
 CREATE READWRITE_SPLITTING RULE readwrite_ds_0 (
 WRITE_STORAGE_UNIT=ds_0,
 READ_STORAGE_UNITS(ds_1,ds_2),
-TRANSACTIONAL_READ_QUERY_STRATEGY='DYNAMIC',
+TRANSACTIONAL_READ_QUERY_STRATEGY='PRIMARY',
 TYPE(NAME='random')
 ), readwrite_ds_1 (
 WRITE_STORAGE_UNIT=ds_3,
 READ_STORAGE_UNITS(ds_4,ds_5),
-TRANSACTIONAL_READ_QUERY_STRATEGY='DYNAMIC',
+TRANSACTIONAL_READ_QUERY_STRATEGY='PRIMARY',
 TYPE(NAME='random')
 );