You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by du...@apache.org on 2023/02/07 13:09:31 UTC
[shardingsphere] branch master updated: Rename transaction-read-query-strategy properties name(#23974) (#24048)
This is an automated email from the ASF dual-hosted git repository.
duanzhengqiang 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 a34b86aa0eb Rename transaction-read-query-strategy properties name(#23974) (#24048)
a34b86aa0eb is described below
commit a34b86aa0eb55161ad6608e354bada81115dda85
Author: ZhangCheng <fl...@outlook.com>
AuthorDate: Tue Feb 7 21:09:19 2023 +0800
Rename transaction-read-query-strategy properties name(#23974) (#24048)
---
.../common-config/builtin-algorithm/load-balance.cn.md | 14 +++++++-------
.../common-config/builtin-algorithm/load-balance.en.md | 14 +++++++-------
.../api/transaction/TransactionReadQueryStrategyAware.java | 2 +-
.../transaction/TransactionReadQueryStrategyUtil.java | 4 ++--
4 files changed, 17 insertions(+), 17 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 bf4e1cfa478..aec31e47582 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
@@ -13,38 +13,38 @@ ShardingSphere 内置提供了多种负载均衡算法，具体包括了轮询
类型：ROUND_ROBIN
-说明：事务内，读请求根据 `transactionReadQueryStrategy` 属性的配置进行路由。事务外，采用轮询策略路由到 replica。
+说明：事务内，读请求根据 `transaction-read-query-strategy` 属性的配置进行路由。事务外，采用轮询策略路由到 replica。
可配置属性：
| *属性名称* | *数据类型* | *说明* |
| -------------- |--------|-------------------------------------------------------------------------------------------------------------------------------------------|
-| transactionReadQueryStrategy | String | 事务内读请求路由策略，可选值：FIXED_PRIMARY(路由到 primary)、FIXED_REPLICA(根据轮询策略选择一个固定的 replica)、DYNAMIC_REPLICA(根据轮询策略路由到不同的 replica)，默认值：FIXED_PRIMARY。 |
+| transaction-read-query-strategy | String | 事务内读请求路由策略，可选值：FIXED_PRIMARY(路由到 primary)、FIXED_REPLICA(根据轮询策略选择一个固定的 replica)、DYNAMIC_REPLICA(根据轮询策略路由到不同的 replica)，默认值：FIXED_PRIMARY。 |
### 随机负载均衡算法
类型：RANDOM
-说明：事务内，读请求根据 `transactionReadQueryStrategy` 属性的配置进行路由。事务外，采用随机策略路由到 replica。
+说明：事务内，读请求根据 `transaction-read-query-strategy` 属性的配置进行路由。事务外，采用随机策略路由到 replica。
可配置属性：
| *属性名称* | *数据类型* | *说明* |
| -------------- |--------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| transactionReadQueryStrategy | String | 事务内读请求路由策略，可选值：FIXED_PRIMARY(路由到 primary)、FIXED_REPLICA(根据随机策略选择一个固定的 replica)、DYNAMIC_REPLICA(根据随机策略路由到不同的 replica)，默认值：FIXED_PRIMARY。 |
+| transaction-read-query-strategy | String | 事务内读请求路由策略，可选值：FIXED_PRIMARY(路由到 primary)、FIXED_REPLICA(根据随机策略选择一个固定的 replica)、DYNAMIC_REPLICA(根据随机策略路由到不同的 replica)，默认值：FIXED_PRIMARY。 |
### 权重负载均衡算法
类型：WEIGHT
-说明：事务内，读请求根据 `transactionReadQueryStrategy` 属性的配置进行路由。事务外，采用权重策略路由到 replica。
+说明：事务内，读请求根据 `transaction-read-query-strategy` 属性的配置进行路由。事务外，采用权重策略路由到 replica。
可配置属性：
| *属性名称* | *数据类型* | *说明* |
| -------------- |--------|-----------------------------------------------------------------------------------------------------------------------------------------|
| ${replica-name} | double | 属性名使用读库名称，参数填写读库对应的权重值。权重参数范围最小值 > 0，合计 <= Double.MAX_VALUE。 |
-| transactionReadQueryStrategy | String | 事务内读请求路由策略，可选值：FIXED_PRIMARY(路由到 primary)、FIXED_REPLICA(根据权重策略选择一个固定的 replica)、DYNAMIC_REPLICA(根据权重策略路由到不同的 replica)，默认值：FIXED_PRIMARY。 |
+| transaction-read-query-strategy | String | 事务内读请求路由策略，可选值：FIXED_PRIMARY(路由到 primary)、FIXED_REPLICA(根据权重策略选择一个固定的 replica)、DYNAMIC_REPLICA(根据权重策略路由到不同的 replica)，默认值：FIXED_PRIMARY。 |
## 操作步骤
@@ -67,7 +67,7 @@ rules:
random:
type: RANDOM
props:
- transactionReadQueryStrategy: FIXED_PRIMARY
+ transaction-read-query-strategy: FIXED_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 62e2e40bf0a..f381a992ade 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
@@ -15,38 +15,38 @@ Moreover, considering the complexity of the business scenario, the built-in algo
Type: ROUND_ROBIN
-Description: Within the transaction, read query are routed according to the configuration of the `transactionReadQueryStrategy` property, and outside the transaction, the round-robin strategy is used to route to the replica.
+Description: Within the transaction, read query are routed according to the configuration of the `transaction-read-query-strategy` property, and outside the transaction, the round-robin strategy is used to route to the replica.
Attributes:
| *Name* | *DataType* | *Description* |
| -------------- |------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| transactionReadQueryStrategy | String | Routing strategy for read query within a transaction, optional values: FIXED_PRIMARY (route to primary), FIXED_REPLICA (select a fixed replica according to the round-robin strategy), DYNAMIC_REPLICA (route to different replicas according to the round-robin strategy), default value: FIXED_PRIMARY. |
+| transaction-read-query-strategy | String | Routing strategy for read query within a transaction, optional values: FIXED_PRIMARY (route to primary), FIXED_REPLICA (select a fixed replica according to the round-robin strategy), DYNAMIC_REPLICA (route to different replicas according to the round-robin strategy), default value: FIXED_PRIMARY. |
### Random Load Balance Algorithm
Type: RANDOM
-Description: Within the transaction, read query are routed according to the configuration of the `transactionReadQueryStrategy` property, and outside the transaction, the random strategy is used to route to the replica.
+Description: Within the transaction, read query are routed according to the configuration of the `transaction-read-query-strategy` property, and outside the transaction, the random strategy is used to route to the replica.
Attributes:
| *Name* | *DataType* | *Description* |
| -------------- |------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| transactionReadQueryStrategy | String | Routing strategy for read query within a transaction, optional values: FIXED_PRIMARY (route to primary), FIXED_REPLICA (select a fixed replica according to the random strategy), DYNAMIC_REPLICA (route to different replicas according to the random strategy), default value: FIXED_PRIMARY. |
+| transaction-read-query-strategy | String | Routing strategy for read query within a transaction, optional values: FIXED_PRIMARY (route to primary), FIXED_REPLICA (select a fixed replica according to the random strategy), DYNAMIC_REPLICA (route to different replicas according to the random strategy), default value: FIXED_PRIMARY. |
### Weight Load Balance Algorithm
Type: WEIGHT
-Description: Within the transaction, read query are routed according to the configuration of the `transactionReadQueryStrategy` property, and outside the transaction, the weight strategy is used to route to the replica.
+Description: Within the transaction, read query are routed according to the configuration of the `transaction-read-query-strategy` property, and outside the transaction, the weight strategy is used to route to the replica.
Attributes:
| *Name* | *DataType* | *Description* |
| -------------- |------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ${replica-name} | double | Attribute name uses the name of the replica, and the parameter fills in the weight value corresponding to the replica. Weight parameter range min > 0, total <= Double.MAX_VALUE. |
-| transactionReadQueryStrategy | String | Routing strategy for read query within a transaction, optional values: FIXED_PRIMARY (route to primary), FIXED_REPLICA (select a fixed replica according to the weight strategy), DYNAMIC_REPLICA (route to different replicas according to the weight strategy), default value: FIXED_PRIMARY. |
+| transaction-read-query-strategy | String | Routing strategy for read query within a transaction, optional values: FIXED_PRIMARY (route to primary), FIXED_REPLICA (select a fixed replica according to the weight strategy), DYNAMIC_REPLICA (route to different replicas according to the weight strategy), default value: FIXED_PRIMARY. |
## Procedure
@@ -69,7 +69,7 @@ rules:
random:
type: RANDOM
props:
- transactionReadQueryStrategy: FIXED_PRIMARY
+ transaction-read-query-strategy: FIXED_PRIMARY
```
## Related References
diff --git a/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/api/transaction/TransactionReadQueryStrategyAware.java b/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/api/transaction/TransactionReadQueryStrategyAware.java
index d0e7cbfd1e2..e0358eb052b 100644
--- a/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/api/transaction/TransactionReadQueryStrategyAware.java
+++ b/features/readwrite-splitting/api/src/main/java/org/apache/shardingsphere/readwritesplitting/api/transaction/TransactionReadQueryStrategyAware.java
@@ -24,7 +24,7 @@ import java.util.List;
*/
public interface TransactionReadQueryStrategyAware {
- String TRANSACTION_READ_QUERY_STRATEGY = "transactionReadQueryStrategy";
+ String TRANSACTION_READ_QUERY_STRATEGY = "transaction-read-query-strategy";
/**
* Get data source name.
diff --git a/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/transaction/TransactionReadQueryStrategyUtil.java b/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/transaction/TransactionReadQueryStrategyUtil.java
index ccf7642fbea..61857fefbd4 100644
--- a/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/transaction/TransactionReadQueryStrategyUtil.java
+++ b/features/readwrite-splitting/core/src/main/java/org/apache/shardingsphere/readwritesplitting/transaction/TransactionReadQueryStrategyUtil.java
@@ -34,9 +34,9 @@ public class TransactionReadQueryStrategyUtil {
* @param name read query logic data source name
* @param writeDataSourceName name of write data source
* @param readDataSourceNames names of read data sources
- * @param context context
+ * @param context transaction context
* @param readQueryStrategy read query strategy in transaction
- * @param readQueryStrategyAware Transaction read query strategy aware
+ * @param readQueryStrategyAware transaction read query strategy aware
* @return name of selected data source
*/
public static String routeInTransaction(final String name, final String writeDataSourceName, final List<String> readDataSourceNames, final TransactionConnectionContext context,