| commit 0c0dd874d97bd81b2819f9d6a7449c0303890054 |
| Author: Mike0601 <40025573+Mike0601@users.noreply.github.com> |
| Date: Fri Aug 12 19:50:18 2022 +0800 |
| |
| add the configuration of algorithm (#20113) |
| |
| * add the configuration of algorithm |
| |
| * restructure user manual |
| |
| * add application scenario and appendix for feature transaction |
| |
| * fix a bug |
| |
| diff --git a/docs/document/content/features/transaction/_index.cn.md b/docs/document/content/features/transaction/_index.cn.md |
| index 1f90e025add..a9b9356e65b 100644 |
| --- a/docs/document/content/features/transaction/_index.cn.md |
| +++ b/docs/document/content/features/transaction/_index.cn.md |
| @@ -82,6 +82,24 @@ Apache ShardingSphere 集成了 SEATA 作为柔性事务的使用方案。 |
| | 并发性能 | 无影响 | 严重衰退 | 略微衰退 | |
| | 适合场景 | 业务方处理不一致 | 短事务 & 低并发 | 长事务 & 高并发 | |
| |
| +## 应用场景 |
| + |
| +在单机应用场景中，依赖数据库提供的事务即可满足业务上对事务 ACID 的需求。但是在分布式场景下，传统数据库解决方案缺乏对全局事务的管控能力，用户在使用过程中可能遇到多个数据库节点上出现数据不一致的问题。 |
| + |
| +ShardingSphere 分布式事务，为用户屏蔽了分布式事务处理的复杂性，提供了灵活多样的分布式事务解决方案，用户可以根据自己的业务场景在 LOCAL，XA，BASE 三种模式中，选择适合自己的分布式事务解决方案。 |
| + |
| +### ShardingSphere XA 事务使用场景 |
| + |
| +对于 XA 事务，提供了分布式环境下，对数据强一致性的保证。但是由于存在同步阻塞问题，对性能会有一定影响。适用于对数据一致性要求非常高且对并发性能要求不是很高的业务场景。 |
| + |
| +### ShardingSphere BASE 事务使用场景 |
| + |
| +对于 BASE 事务，提供了分布式环境下，对数据最终一致性的保证。由于在整个事务过程中，不会像 XA 事务那样全程锁定资源，所以性能较好。适用于对并发性能要求很高并且允许出现短暂数据不一致的业务场景。 |
| + |
| +### ShardingSphere LOCAL事务使用场景 |
| + |
| +对于 LOCAL 事务，在分布式环境下，不保证各个数据库节点之间数据的一致性和隔离性，需要业务方自行处理可能出现的不一致问题。适用于用户希望自行处理分布式环境下数据一致性问题的业务场景。 |
| + |
| ## 相关参考 |
| |
| - [分布式事务的 YAML 配置](/cn/user-manual/shardingsphere-jdbc/yaml-config/rules/transaction/) |
| diff --git a/docs/document/content/features/transaction/_index.en.md b/docs/document/content/features/transaction/_index.en.md |
| index 7eeb2be5e8d..9394a11df1c 100644 |
| --- a/docs/document/content/features/transaction/_index.en.md |
| +++ b/docs/document/content/features/transaction/_index.en.md |
| @@ -81,5 +81,23 @@ The following table can be used for comparison to help developers choose the sui |
| | Concurrent performance | no loss | severe loss | slight loss | |
| | Applied scenarios | Inconsistent processing by the business side | short transaction & low-level concurrency | long transaction & high concurrency | |
| |
| +## Application Scenarios |
| + |
| +The database's transactions can meet ACID business requirements in a standalone application scenario. However, in distributed scenarios, traditional database solutions cannot manage and control global transactions, and users may find data inconsistency on multiple database nodes. |
| + |
| +ShardingSphere distributed transaction makes it easier to process distributed transactions and provides flexible and diverse solutions. Users can select the distributed transaction solutions that best fit their business scenarios among LOCAL, XA, and BASE modes. |
| + |
| +### Application Scenarios for ShardingSphere XA Transactions |
| + |
| +Strong data consistency is guaranteed in a distributed environment in terms of XA transactions. However, its performance may be degraded due to the synchronous blocking problem. It applies to business scenarios that require strong data consistency and low concurrency performance. |
| + |
| +### Application Scenarios for ShardingSphere BASE Transaction |
| + |
| +In terms of BASE transactions, final data consistency is guaranteed in a distributed environment. Unlike XA transactions, resources are not locked during the whole transaction process, so its performance is relatively higher. |
| + |
| +### Application Scenarios for ShardingSphere LOCAL Transaction |
| + |
| +In terms of LOCAL transactions, the data consistency and isolation among database nodes are not guaranteed in a distributed environment. Therefore, the business sides need to handle the inconsistencies by themselves. This applies to business scenarios where users would like to handle data inconsistency in a distributed environment by themselves. |
| + |
| ## Related references |
| - [YAML distributed transaction configuration](/en/user-manual/shardingsphere-jdbc/yaml-config/rules/transaction/) |
| diff --git a/docs/document/content/features/transaction/appendix.cn.md b/docs/document/content/features/transaction/appendix.cn.md |
| new file mode 100644 |
| index 00000000000..1dd277950b3 |
| --- /dev/null |
| +++ b/docs/document/content/features/transaction/appendix.cn.md |
| @@ -0,0 +1,9 @@ |
| ++++ |
| +title = "附录" |
| +weight = 3 |
| ++++ |
| + |
| +不支持的 SQL： |
| + |
| +- 事务中使用 DistSQL 里的 RAL、RDL 操作； |
| +- XA 事务中使用 DDL 语句。 |
| diff --git a/docs/document/content/features/transaction/appendix.en.md b/docs/document/content/features/transaction/appendix.en.md |
| new file mode 100644 |
| index 00000000000..679e51432ed |
| --- /dev/null |
| +++ b/docs/document/content/features/transaction/appendix.en.md |
| @@ -0,0 +1,9 @@ |
| ++++ |
| +title = "Appendix with SQL operator" |
| +weight = 3 |
| ++++ |
| + |
| +Unsupported SQL： |
| + |
| +- RAL and RDL operations of DistSQL are used in transactions. |
| +- DDL statements are used in XA transactions. |
| diff --git a/docs/document/content/overview/_index.cn.md b/docs/document/content/overview/_index.cn.md |
| index c5c6209a116..91d8942514f 100644 |
| --- a/docs/document/content/overview/_index.cn.md |
| +++ b/docs/document/content/overview/_index.cn.md |
| @@ -5,6 +5,6 @@ weight = 1 |
| chapter = true |
| +++ |
| |
| -本章介绍了什么是 Apache ShardingSphere，其及设计哲学和部署形态。 |
| +本章介绍了什么是 Apache ShardingSphere，及其设计哲学和部署形态。 |
| |
| 更多常见问题，请参考 [FAQ](https://github.com/apache/shardingsphere/wiki/FAQ)。 |
| diff --git a/docs/document/content/user-manual/common-config/_index.cn.md b/docs/document/content/user-manual/common-config/_index.cn.md |
| new file mode 100644 |
| index 00000000000..a6ead7dfff8 |
| --- /dev/null |
| +++ b/docs/document/content/user-manual/common-config/_index.cn.md |
| @@ -0,0 +1,8 @@ |
| ++++ |
| +pre = "<b>4.3. </b>" |
| +title = "通用配置" |
| +weight = 3 |
| +chapter = true |
| ++++ |
| + |
| +本章主要介绍通用配置，包括属性配置和内置算法配置。 |
| diff --git a/docs/document/content/user-manual/common-config/_index.en.md b/docs/document/content/user-manual/common-config/_index.en.md |
| new file mode 100644 |
| index 00000000000..e7cc46ccc1c |
| --- /dev/null |
| +++ b/docs/document/content/user-manual/common-config/_index.en.md |
| @@ -0,0 +1,8 @@ |
| ++++ |
| +pre = "<b>4.3. </b>" |
| +title = "Common Configuration" |
| +weight = 3 |
| +chapter = true |
| ++++ |
| + |
| +This chapter mainly introduces general configuration, including property configuration and built-in algorithm configuration. |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/_index.cn.md b/docs/document/content/user-manual/common-config/builtin-algorithm/_index.cn.md |
| similarity index 98% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/_index.cn.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/_index.cn.md |
| index f4c3b240c6f..a30a5d07125 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/_index.cn.md |
| +++ b/docs/document/content/user-manual/common-config/builtin-algorithm/_index.cn.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "内置算法" |
| -weight = 7 |
| +weight = 2 |
| chapter = true |
| +++ |
| |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/_index.en.md b/docs/document/content/user-manual/common-config/builtin-algorithm/_index.en.md |
| similarity index 98% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/_index.en.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/_index.en.md |
| index 4d0707eb606..b78f4c31dbe 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/_index.en.md |
| +++ b/docs/document/content/user-manual/common-config/builtin-algorithm/_index.en.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "Builtin Algorithm" |
| -weight = 7 |
| +weight = 2 |
| chapter = true |
| +++ |
| |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/encrypt.cn.md b/docs/document/content/user-manual/common-config/builtin-algorithm/encrypt.cn.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/encrypt.cn.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/encrypt.cn.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/encrypt.en.md b/docs/document/content/user-manual/common-config/builtin-algorithm/encrypt.en.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/encrypt.en.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/encrypt.en.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/keygen.cn.md b/docs/document/content/user-manual/common-config/builtin-algorithm/keygen.cn.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/keygen.cn.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/keygen.cn.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/keygen.en.md b/docs/document/content/user-manual/common-config/builtin-algorithm/keygen.en.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/keygen.en.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/keygen.en.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/load-balance.cn.md b/docs/document/content/user-manual/common-config/builtin-algorithm/load-balance.cn.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/load-balance.cn.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/load-balance.cn.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/load-balance.en.md b/docs/document/content/user-manual/common-config/builtin-algorithm/load-balance.en.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/load-balance.en.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/load-balance.en.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/metadata-repository.cn.md b/docs/document/content/user-manual/common-config/builtin-algorithm/metadata-repository.cn.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/metadata-repository.cn.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/metadata-repository.cn.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/metadata-repository.en.md b/docs/document/content/user-manual/common-config/builtin-algorithm/metadata-repository.en.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/metadata-repository.en.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/metadata-repository.en.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/shadow.cn.md b/docs/document/content/user-manual/common-config/builtin-algorithm/shadow.cn.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/shadow.cn.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/shadow.cn.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/shadow.en.md b/docs/document/content/user-manual/common-config/builtin-algorithm/shadow.en.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/shadow.en.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/shadow.en.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.cn.md b/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.cn.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.cn.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/sharding.cn.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.en.md b/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.en.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.en.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/sharding.en.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sql-translator.cn.md b/docs/document/content/user-manual/common-config/builtin-algorithm/sql-translator.cn.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sql-translator.cn.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/sql-translator.cn.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sql-translator.en.md b/docs/document/content/user-manual/common-config/builtin-algorithm/sql-translator.en.md |
| similarity index 100% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sql-translator.en.md |
| rename to docs/document/content/user-manual/common-config/builtin-algorithm/sql-translator.en.md |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/props.cn.md b/docs/document/content/user-manual/common-config/props.cn.md |
| similarity index 99% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/props.cn.md |
| rename to docs/document/content/user-manual/common-config/props.cn.md |
| index 7fcebb696a5..e426a21b8a0 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/props.cn.md |
| +++ b/docs/document/content/user-manual/common-config/props.cn.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "属性配置" |
| -weight = 6 |
| +weight = 1 |
| chapter = true |
| +++ |
| |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/props.en.md b/docs/document/content/user-manual/common-config/props.en.md |
| similarity index 99% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/props.en.md |
| rename to docs/document/content/user-manual/common-config/props.en.md |
| index 950970c46a4..fe9bb7d906a 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/props.en.md |
| +++ b/docs/document/content/user-manual/common-config/props.en.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "Properties Configuration" |
| -weight = 6 |
| +weight = 1 |
| chapter = true |
| +++ |
| |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/_index.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/_index.cn.md |
| index d953714dfc2..dd1721392e4 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/_index.cn.md |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/_index.cn.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "Java API" |
| -weight = 1 |
| +weight = 2 |
| chapter = true |
| +++ |
| |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/_index.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/_index.en.md |
| index 417838e5bef..699a9ce3531 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/_index.en.md |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/_index.en.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "Java API" |
| -weight = 1 |
| +weight = 2 |
| chapter = true |
| +++ |
| |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/algorithm.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/algorithm.cn.md |
| new file mode 100644 |
| index 00000000000..1a9efd8aecc |
| --- /dev/null |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/algorithm.cn.md |
| @@ -0,0 +1,49 @@ |
| ++++ |
| +title = "算法配置" |
| +weight = 4 |
| +chapter = true |
| ++++ |
| + |
| +## 分片算法 |
| + |
| +```java |
| +ShardingRuleConfiguration ruleConfiguration = new ShardingRuleConfiguration(); |
| +// algorithmName 由用户指定，需要和分片策略中的分片算法一致 |
| +// type 和 props，请参考分片内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding/ |
| +ruleConfiguration.getShardingAlgorithms().put("algorithmName", new AlgorithmConfiguration("xxx", new Properties())); |
| +``` |
| + |
| +## 加密算法 |
| + |
| +```java |
| +// encryptorName 由用户指定，需要和加密规则中的 encryptorName 属性一致 |
| +// type 和 props，请参考加密内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/encrypt/ |
| +Map<String, AlgorithmConfiguration> algorithmConfigs = new LinkedHashMap<>(1, 1); |
| +algorithmConfigs.put("encryptorName", new AlgorithmConfiguration("xxx", new Properties())); |
| +``` |
| + |
| +## 读写分离负载均衡算法 |
| + |
| +```java |
| +// loadBalancerName 由用户指定，需要和读写分离规则中的 loadBalancerName 属性一致 |
| +// type 和 props，请参考读写分离负载均衡内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/load-balance/ |
| +Map<String, AlgorithmConfiguration> algorithmConfigs = new HashMap<>(1, 1); |
| +algorithmConfigs.put("loadBalancerName", new AlgorithmConfiguration("xxx", new Properties())); |
| +``` |
| + |
| +## 影子算法 |
| + |
| +```java |
| +// shadowAlgorithmName 由用户指定，需要和影子库规则中的 shadowAlgorithmNames 属性一致 |
| +// type 和 props，请参考影子库内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/shadow/ |
| +Map<String, AlgorithmConfiguration> algorithmConfigs = new HashMap<>(1, 1); |
| +algorithmConfigs.put("shadowAlgorithmName", new AlgorithmConfiguration("xxx", new Properties())); |
| +``` |
| + |
| +## 高可用 |
| + |
| +```java |
| +// discoveryTypeName 由用户指定，需要和数据库发现规则中的 discoveryTypeName 属性一致 |
| +Map<String, AlgorithmConfiguration> algorithmConfigs = new HashMap<>(1, 1); |
| +algorithmConfigs.put("discoveryTypeName", new AlgorithmConfiguration("xxx", new Properties())); |
| +``` |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/algorithm.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/algorithm.en.md |
| new file mode 100644 |
| index 00000000000..aafa25546da |
| --- /dev/null |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/algorithm.en.md |
| @@ -0,0 +1,49 @@ |
| ++++ |
| +title = "Algorithm" |
| +weight = 4 |
| +chapter = true |
| ++++ |
| + |
| +## Sharding |
| + |
| +```java |
| +ShardingRuleConfiguration ruleConfiguration = new ShardingRuleConfiguration(); |
| +// algorithmName is specified by users and should be consistent with the sharding algorithm in the sharding strategy. |
| +// type and props, please refer to the built-in sharding algorithm: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding/ |
| +ruleConfiguration.getShardingAlgorithms().put("algorithmName", new AlgorithmConfiguration("xxx", new Properties())); |
| +``` |
| + |
| +## Encryption |
| + |
| +```java |
| +// encryptorName is specified by users, and its property should be consistent with that of encryptorName in encryption rules. |
| +// type and props, please refer to the built-in encryption algorithm: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/encrypt/ |
| +Map<String, AlgorithmConfiguration> algorithmConfigs = new LinkedHashMap<>(1, 1); |
| +algorithmConfigs.put("encryptorName", new AlgorithmConfiguration("xxx", new Properties())); |
| +``` |
| + |
| +## Read/Write Splitting Load Balancer |
| + |
| +```java |
| +// loadBalancerName is specified by users, and its property has to be consistent with that of loadBalancerName in read/write splitting rules. |
| +// type and props, please refer to the built-in read/write splitting algorithm load balancer: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/load-balance/ |
| +Map<String, AlgorithmConfiguration> algorithmConfigs = new HashMap<>(1, 1); |
| +algorithmConfigs.put("loadBalancerName", new AlgorithmConfiguration("xxx", new Properties())); |
| +``` |
| + |
| +## Shadow DB |
| + |
| +```java |
| +// shadowAlgorithmName is specified by users, and its property has to be consistent with that of shadowAlgorithmNames in shadow DB rules. |
| +// type and props, please refer to the built-in shadow DB algorithm: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/shadow/ |
| +Map<String, AlgorithmConfiguration> algorithmConfigs = new HashMap<>(1, 1); |
| +algorithmConfigs.put("shadowAlgorithmName", new AlgorithmConfiguration("xxx", new Properties())); |
| +``` |
| + |
| +## High Availability |
| + |
| +``` |
| +// discoveryTypeName is specified by users, and its property has to be consistent with that of discoveryTypeName in database discovery rules. |
| +Map<String, AlgorithmConfiguration> algorithmConfigs = new HashMap<>(1, 1); |
| +algorithmConfigs.put("discoveryTypeName", new AlgorithmConfiguration("xxx", new Properties())); |
| +``` |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/_index.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/_index.cn.md |
| index 663bb96808f..e70af415aee 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/_index.cn.md |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/_index.cn.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "特殊 API" |
| -weight = 8 |
| +weight = 5 |
| chapter = true |
| +++ |
| |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/_index.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/_index.en.md |
| index 95457705673..bb72e0e5010 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/_index.en.md |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/_index.en.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "Special API" |
| -weight = 8 |
| +weight = 5 |
| chapter = true |
| +++ |
| |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/algorithm.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/algorithm.cn.md |
| new file mode 100644 |
| index 00000000000..28cd9c0f803 |
| --- /dev/null |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/algorithm.cn.md |
| @@ -0,0 +1,48 @@ |
| ++++ |
| +title = "算法配置" |
| +weight = 4 |
| ++++ |
| + |
| +## 分片算法 |
| + |
| +```properties |
| +# sharding-algorithm-name 由用户指定，需要和分片策略中的 sharding-algorithm-name 属性一致 |
| +# type 和 props，请参考分片内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding/ |
| +spring.shardingsphere.rules.sharding.sharding-algorithms.<sharding-algorithm-name>.type=xxx |
| +spring.shardingsphere.rules.sharding.sharding-algorithms.<sharding-algorithm-name>.props.xxx=xxx |
| +``` |
| + |
| +## 加密算法 |
| + |
| +```properties |
| +# encrypt-algorithm-name 由用户指定，需要和加密规则中的 encryptor-name 属性一致 |
| +# type 和 props，请参考加密内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/encrypt/ |
| +spring.shardingsphere.rules.encrypt.encryptors.<encrypt-algorithm-name>.type=xxx |
| +spring.shardingsphere.rules.encrypt.encryptors.<encrypt-algorithm-name>.props.xxx=xxx |
| +``` |
| + |
| +## 读写分离负载均衡算法 |
| + |
| +```properties |
| +# load-balance-algorithm-name 由用户指定，需要和读写分离规则中的 load-balancer-name 属性一致 |
| +# type 和 props，请参考读写分离负载均衡内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/load-balance/ |
| +spring.shardingsphere.rules.readwrite-splitting.load-balancers.<load-balance-algorithm-name>.type=xxx |
| +spring.shardingsphere.rules.readwrite-splitting.load-balancers.<load-balance-algorithm-name>.props.xxx=xxx |
| +``` |
| + |
| +## 影子算法 |
| + |
| +```properties |
| +# shadow-algorithm-name 由用户指定，需要和影子库规则中的 shadow-algorithm-names 属性一致 |
| +# type 和 props，请参考影子库内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/shadow/ |
| +spring.shardingsphere.rules.shadow.shadow-algorithms.<shadow-algorithm-name>.type=xxx |
| +spring.shardingsphere.rules.shadow.shadow-algorithms.<shadow-algorithm-name>.props.xxx=xxx |
| +``` |
| + |
| +## 高可用 |
| + |
| +```properties |
| +# discovery-type-name 由用户指定，需要和数据库发现规则中的 discovery-type-name 属性一致 |
| +spring.shardingsphere.rules.database-discovery.discovery-types.<discovery-type-name>.type=xxx |
| +spring.shardingsphere.rules.database-discovery.discovery-types.<discovery-type-name>.props.xxx=xxx |
| +``` |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/algorithm.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/algorithm.en.md |
| new file mode 100644 |
| index 00000000000..a293f408432 |
| --- /dev/null |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/algorithm.en.md |
| @@ -0,0 +1,48 @@ |
| ++++ |
| +title = "Algorithm" |
| +weight = 4 |
| ++++ |
| + |
| +## Sharding |
| + |
| +```properties |
| +# sharding-algorithm-name is specified by users and its property should be consistent with that of sharding-algorithm-name in the sharding strategy. |
| +# type and props, please refer to the built-in sharding algorithm: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding/ |
| +spring.shardingsphere.rules.sharding.sharding-algorithms.<sharding-algorithm-name>.type=xxx |
| +spring.shardingsphere.rules.sharding.sharding-algorithms.<sharding-algorithm-name>.props.xxx=xxx |
| +``` |
| + |
| +## Encryption |
| + |
| +```properties |
| +# encrypt-algorithm-name is specified by users, and its property should be consistent with that of encryptor-name in encryption rules. |
| +# type and props, please refer to the built-in encryption algorithm: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/encrypt/ |
| +spring.shardingsphere.rules.encrypt.encryptors.<encrypt-algorithm-name>.type=xxx |
| +spring.shardingsphere.rules.encrypt.encryptors.<encrypt-algorithm-name>.props.xxx=xxx |
| +``` |
| + |
| +## Read/Write Splitting Load Balancer |
| + |
| +```properties |
| +# load-balance-algorithm-name is specified by users, and its property has to be consistent with that of load-balancer-name in read/write splitting rules. |
| +# type and props, please refer to the built-in read/write splitting algorithm load balancer: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/load-balance/ |
| +spring.shardingsphere.rules.readwrite-splitting.load-balancers.<load-balance-algorithm-name>.type=xxx |
| +spring.shardingsphere.rules.readwrite-splitting.load-balancers.<load-balance-algorithm-name>.props.xxx=xxx |
| +``` |
| + |
| +## Shadow DB |
| + |
| +```properties |
| +# shadow-algorithm-name is specified by users, and its property has to be consistent with that of shadow-algorithm-names in shadow DB rules. |
| +# type and props, please refer to the built-in shadow DB algorithm: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/shadow/ |
| +spring.shardingsphere.rules.shadow.shadow-algorithms.<shadow-algorithm-name>.type=xxx |
| +spring.shardingsphere.rules.shadow.shadow-algorithms.<shadow-algorithm-name>.props.xxx=xxx |
| +``` |
| + |
| +## High Availability |
| + |
| +```properties |
| +# discovery-type-name is specified by users, and its property has to be consistent with that of discovery-type-name in database discovery rules. |
| +spring.shardingsphere.rules.database-discovery.discovery-types.<discovery-type-name>.type=xxx |
| +spring.shardingsphere.rules.database-discovery.discovery-types.<discovery-type-name>.props.xxx=xxx |
| +``` |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/mode.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/mode.cn.md |
| index d00e1abe633..3ef84d70233 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/mode.cn.md |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/spring-boot-starter/mode.cn.md |
| @@ -3,41 +3,42 @@ title = "模式配置" |
| weight = 1 |
| +++ |
| |
| -## Parameters |
| +## 参数解释 |
| |
| ```properties |
| -spring.shardingsphere.mode.type= # Type of mode configuration. Value could be: Standalone or Cluster |
| -spring.shardingsphere.mode.repository= # Persist repository configuration |
| -spring.shardingsphere.mode.overwrite= # Whether overwrite persistent configuration with local configuration |
| +spring.shardingsphere.mode.type= # 运行模式类型。可选配置：Standalone、Cluster |
| +spring.shardingsphere.mode.repository= # 持久化仓库配置。Memory 类型无需持久化 |
| +spring.shardingsphere.mode.overwrite= # 是否使用本地配置覆盖持久化配置 |
| ``` |
| |
| -### Standalone Mode |
| +### 单机模式 |
| |
| ```properties |
| spring.shardingsphere.mode.type=Standalone |
| -spring.shardingsphere.mode.repository.type= # Type of persist repository |
| -spring.shardingsphere.mode.repository.props.<key>= # Properties of persist repository |
| -spring.shardingsphere.mode.overwrite= # Whether overwrite persistent configuration with local configuration |
| +spring.shardingsphere.mode.repository.type= # 持久化仓库类型 |
| +spring.shardingsphere.mode.repository.props.<key>= # 持久化仓库所需属性 |
| +spring.shardingsphere.mode.overwrite= # 是否使用本地配置覆盖持久化配置 |
| ``` |
| |
| -### Cluster Mode (Recommended) |
| +### 集群模式 (推荐) |
| |
| ```properties |
| spring.shardingsphere.mode.type=Cluster |
| -spring.shardingsphere.mode.repository.type= # Type of persist repository |
| -spring.shardingsphere.mode.repository.props.namespace= # Namespace of registry center |
| -spring.shardingsphere.mode.repository.props.server-lists= # Server lists of registry center |
| -spring.shardingsphere.mode.repository.props.<key>= # Properties of persist repository |
| -spring.shardingsphere.mode.overwrite= # Whether overwrite persistent configuration with local configuration |
| +spring.shardingsphere.mode.repository.type= # 持久化仓库类型 |
| +spring.shardingsphere.mode.repository.props.namespace= # 注册中心命名空间 |
| +spring.shardingsphere.mode.repository.props.server-lists= # 注册中心连接地址 |
| +spring.shardingsphere.mode.repository.props.<key>= # 持久化仓库所需属性 |
| +spring.shardingsphere.mode.overwrite= # 是否使用本地配置覆盖持久化配置 |
| ``` |
| |
| -## Notes |
| +## 注意事项 |
| |
| -1. Cluster mode deployment is recommended for production environments. |
| -1. The 'ZooKeeper' registry center is recommended for cluster mode deployment. |
| +1. 生产环境建议使用集群模式部署。 |
| +1. 集群模式部署推荐使用 `ZooKeeper` 注册中心。 |
| |
| -## Procedure |
| -1. Import MAVEN dependency. |
| +## 操作步骤 |
| + |
| +1. 引入 MAVEN 依赖 |
| |
| ```xml |
| <dependency> |
| @@ -47,11 +48,11 @@ spring.shardingsphere.mode.overwrite= # Whether overwrite persistent configurati |
| </dependency> |
| ``` |
| |
| -> Note: please change `${latest.release.version}' to the actual version number. |
| -> |
| -## Sample |
| +注意：请将 `${latest.release.version}` 更改为实际的版本号。 |
| + |
| +## 配置示例 |
| |
| -### Standalone Mode |
| +### 单机模式 |
| |
| ```properties |
| spring.shardingsphere.mode.type=Standalone |
| @@ -60,7 +61,7 @@ spring.shardingsphere.mode.repository.props.path=.shardingsphere |
| spring.shardingsphere.mode.overwrite=false |
| ``` |
| |
| -### Cluster Mode (Recommended) |
| +### 集群模式 (推荐) |
| |
| ```properties |
| spring.shardingsphere.mode.type=Cluster |
| @@ -72,7 +73,7 @@ spring.shardingsphere.mode.repository.props.timeToLiveSeconds=60 |
| spring.shardingsphere.mode.overwrite=false |
| ``` |
| |
| -## Related References |
| +## 相关参考 |
| |
| -- [Installation and Usage of ZooKeeper Registry Center](https://zookeeper.apache.org/doc/r3.7.1/zookeeperStarted.html) |
| -- Please refer to [Builtin Persist Repository List](/en/user-manual/shardingsphere-jdbc/builtin-algorithm/metadata-repository/) for more details about type of repository. |
| +- [ZooKeeper 注册中心安装与使用](https://zookeeper.apache.org/doc/r3.7.1/zookeeperStarted.html) |
| +- - 持久化仓库类型的详情，请参见[内置持久化仓库类型列表](/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/metadata-repository/)。 |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/spring-namespace/algorithm.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/spring-namespace/algorithm.cn.md |
| new file mode 100644 |
| index 00000000000..107c37029bb |
| --- /dev/null |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/spring-namespace/algorithm.cn.md |
| @@ -0,0 +1,63 @@ |
| ++++ |
| +title = "算法配置" |
| +weight = 4 |
| ++++ |
| + |
| +## 分片算法 |
| + |
| +```xml |
| +<!-- algorithmName 由用户指定，需要和分片策略中的 algorithm-ref 属性一致 --> |
| +<!-- type 和 props，请参考分片内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding/ --> |
| +<sharding:sharding-algorithm id="algorithmName" type="xxx"> |
| + <props> |
| + <prop key="xxx">xxx</prop> |
| + </props> |
| +</sharding:sharding-algorithm> |
| +``` |
| + |
| +## 加密算法 |
| + |
| +```xml |
| +<!-- encryptorName 由用户指定，需要和加密规则中的 encrypt-algorithm-ref 属性一致 --> |
| +<!-- type 和 props，请参考加密内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/encrypt/ --> |
| +<encrypt:encrypt-algorithm id="encryptorName" type="xxx"> |
| + <props> |
| + <prop key="xxx">xxx</prop> |
| + </props> |
| +</encrypt:encrypt-algorithm> |
| +``` |
| + |
| +## 读写分离负载均衡算法 |
| + |
| +```xml |
| +<!-- loadBalancerName 由用户指定，需要和读写分离规则中的 load-balance-algorithm-ref 属性一致 --> |
| +<!-- type 和 props，请参考读写分离负载均衡内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/load-balance/ --> |
| +<readwrite-splitting:load-balance-algorithm id="loadBalancerName" type="xxx"> |
| + <props> |
| + <prop key="xxx">xxx</prop> |
| + </props> |
| +</readwrite-splitting:load-balance-algorithm> |
| +``` |
| + |
| +## 影子算法 |
| + |
| +```xml |
| +<!-- shadowAlgorithmName 由用户指定，需要和影子库则中的 shadow-algorithm-ref 属性一致 --> |
| +<!-- type 和 props，请参考影子库内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/shadow/ --> |
| +<shadow:shadow-algorithm id="shadowAlgorithmName" type="xxx"> |
| + <props> |
| + <prop key="xxx">xxx</prop> |
| + </props> |
| +</shadow:shadow-algorithm> |
| +``` |
| + |
| +## 高可用 |
| + |
| +```xml |
| +<!-- discoveryTypeName 由用户指定，需要和数据库发现规则中的 discovery-type-name 属性一致 --> |
| +<database-discovery:discovery-type id="discoveryTypeName" type="xxx"> |
| + <props> |
| + <prop key="xxx">xxx</prop> |
| + </props> |
| +</database-discovery:discovery-type> |
| +``` |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/spring-namespace/algorithm.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/spring-namespace/algorithm.en.md |
| new file mode 100644 |
| index 00000000000..83c51ec6b14 |
| --- /dev/null |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/spring-namespace/algorithm.en.md |
| @@ -0,0 +1,63 @@ |
| ++++ |
| +title = "Algorithm" |
| +weight = 4 |
| ++++ |
| + |
| +## Sharding |
| + |
| +```xml |
| +<!-- algorithmName is specified by users and its property should be consistent with that of algorithm-ref in the sharding strategy. --> |
| +<!-- type and props, please refer to the built-in sharding algorithm: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding/ --> |
| +<sharding:sharding-algorithm id="algorithmName" type="xxx"> |
| + <props> |
| + <prop key="xxx">xxx</prop> |
| + </props> |
| +</sharding:sharding-algorithm> |
| +``` |
| + |
| +## Encryption |
| + |
| +```xml |
| +<!-- encryptorName is specified by users, and its property should be consistent with that of encrypt-algorithm-ref in encryption rules. --> |
| +<!-- type and props, please refer to the built-in encryption algorithm: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/encrypt/ --> |
| +<encrypt:encrypt-algorithm id="encryptorName" type="xxx"> |
| + <props> |
| + <prop key="xxx">xxx</prop> |
| + </props> |
| +</encrypt:encrypt-algorithm> |
| +``` |
| + |
| +## Read/Write Splitting Load Balancer |
| + |
| +```xml |
| +<!-- loadBalancerName is specified by users, and its property has to be consistent with that of load-balance-algorithm-ref in read/write splitting rules. --> |
| +<!-- type and props, please refer to the built-in read/write splitting algorithm load balancer: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/load-balance/ --> |
| +<readwrite-splitting:load-balance-algorithm id="loadBalancerName" type="xxx"> |
| + <props> |
| + <prop key="xxx">xxx</prop> |
| + </props> |
| +</readwrite-splitting:load-balance-algorithm> |
| +``` |
| + |
| +## Shadow DB |
| + |
| +```xml |
| +<!-- shadowAlgorithmName is specified by users, and its property has to be consistent with that of shadow-algorithm-ref in shadow DB rules. --> |
| +<!-- type and props, please refer to the built-in shadow DB algorithm: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/shadow/ --> |
| +<shadow:shadow-algorithm id="shadowAlgorithmName" type="xxx"> |
| + <props> |
| + <prop key="xxx">xxx</prop> |
| + </props> |
| +</shadow:shadow-algorithm> |
| +``` |
| + |
| +## High Availability |
| + |
| +```xml |
| +<!-- discoveryTypeName is specified by users, and its property has to be consistent with that of discovery-type-name in database discovery rules. --> |
| +<database-discovery:discovery-type id="discoveryTypeName" type="xxx"> |
| + <props> |
| + <prop key="xxx">xxx</prop> |
| + </props> |
| +</database-discovery:discovery-type> |
| +``` |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/unsupported.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/unsupported.cn.md |
| index 4e820f461ed..4a85fe694bb 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/unsupported.cn.md |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/unsupported.cn.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "不支持项" |
| -weight = 9 |
| +weight = 6 |
| +++ |
| |
| ## DataSource 接口 |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/unsupported.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/unsupported.en.md |
| index a78c52d4da7..2c4055272b2 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/unsupported.en.md |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/unsupported.en.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "Unsupported Items" |
| -weight = 9 |
| +weight = 6 |
| +++ |
| |
| ## DataSource Interface |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.cn.md |
| index 9abd285eb7b..a9e794a0e51 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.cn.md |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.cn.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "YAML 配置" |
| -weight = 2 |
| +weight = 1 |
| chapter = true |
| +++ |
| |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.en.md |
| index eccf37fd221..14e62d60b22 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.en.md |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/_index.en.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "YAML Configuration" |
| -weight = 2 |
| +weight = 1 |
| chapter = true |
| +++ |
| |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/algorithm.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/algorithm.cn.md |
| new file mode 100644 |
| index 00000000000..84f1ba3ede2 |
| --- /dev/null |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/algorithm.cn.md |
| @@ -0,0 +1,63 @@ |
| ++++ |
| +title = "算法配置" |
| +weight = 4 |
| ++++ |
| + |
| +## 分片算法 |
| + |
| +```yaml |
| +shardingAlgorithms: |
| + # algorithmName 由用户指定，需要和分片策略中的 shardingAlgorithmName 属性一致 |
| + <algorithmName>: |
| + # type 和 props，请参考分片内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding/ |
| + type: xxx |
| + props: |
| + xxx: xxx |
| +``` |
| + |
| +## 加密算法 |
| + |
| +```yaml |
| +encryptors: |
| + # encryptorName 由用户指定，需要和加密规则中的 encryptorName 属性一致 |
| + <encryptorName>: |
| + # type 和 props，请参考加密内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/encrypt/ |
| + type: xxx |
| + props: |
| + xxx: xxx |
| +``` |
| + |
| +## 读写分离负载均衡算法 |
| + |
| +```yaml |
| +loadBalancers: |
| + # loadBalancerName 由用户指定，需要和读写分离规则中的 loadBalancerName 属性一致 |
| + <loadBalancerName>: |
| + # type 和 props，请参考读写分离负载均衡内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/load-balance/ |
| + type: xxx |
| + props: |
| + xxx: xxx |
| +``` |
| + |
| +## 影子算法 |
| + |
| +```yaml |
| +loadBalancers: |
| + # shadowAlgorithmName 由用户指定，需要和影子库规则中的 shadowAlgorithmNames 属性一致 |
| + <shadowAlgorithmName>: |
| + # type 和 props，请参考影子库内置算法：https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/builtin-algorithm/shadow/ |
| + type: xxx |
| + props: |
| + xxx: xxx |
| +``` |
| + |
| +## 高可用 |
| + |
| +```yaml |
| +discoveryTypes: |
| + # discoveryTypeName 由用户指定，需要和数据库发现规则中的 discoveryTypeName 属性一致 |
| + <discoveryTypeName>: |
| + type: xxx |
| + props: |
| + xxx: xxx |
| +``` |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/algorithm.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/algorithm.en.md |
| new file mode 100644 |
| index 00000000000..f615a4be32d |
| --- /dev/null |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/algorithm.en.md |
| @@ -0,0 +1,61 @@ |
| ++++ |
| +title = "Algorithm" |
| +weight = 4 |
| ++++ |
| + |
| +## Sharding |
| + |
| +```yaml |
| +shardingAlgorithms: |
| + # algorithmName is specified by users, and its property has to be consistent with that of shardingAlgorithmName in the sharding strategy. |
| + <algorithmName>: |
| + # type and props, please refer to the built-in sharding algorithm: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding/ |
| + type: xxx |
| + props: |
| + xxx: xxx |
| +``` |
| + |
| +## Encryption |
| + |
| +```yaml |
| +encryptors: |
| + # encryptorName is specified by users, and its property should be consistent with that of encryptorName in encryption rules. |
| + <encryptorName>: |
| + # type and props, please refer to the built-in encryption algorithm: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/encrypt/ |
| + type: xxx |
| + props: |
| + xxx: xxx |
| +``` |
| + |
| +## Read/Write Splitting Load Balancer |
| + |
| +```yaml |
| +loadBalancers: |
| + # loadBalancerName is specified by users, and its property has to be consistent with that of loadBalancerName in read/write splitting rules. |
| + # type and props, please refer to the built-in read/write splitting algorithm load balancer: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/load-balance/ |
| + type: xxx |
| + props: |
| + xxx: xxx |
| +``` |
| + |
| +## Shadow DB |
| + |
| +```yaml |
| +loadBalancers: |
| + # shadowAlgorithmName is specified by users, and its property has to be consistent with that of shadowAlgorithmNames in shadow DB rules. |
| + <shadowAlgorithmName>: |
| + # type and props, please refer to the built-in shadow DB algorithm: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/builtin-algorithm/shadow/ |
| + type: xxx |
| + props: |
| + xxx: xxx |
| +``` |
| + |
| +## High Availability |
| + |
| +```yaml |
| +discoveryTypes: |
| + # discoveryTypeName is specified by users, and its property has to be consistent with that of discoveryTypeName in the database discovery rules. |
| + type: xxx |
| + props: |
| + xxx: xxx |
| +``` |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/jdbc-driver/_index.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc_driver.cn.md |
| similarity index 99% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/jdbc-driver/_index.cn.md |
| rename to docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc_driver.cn.md |
| index 611c9c72290..7f5e0d07076 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/jdbc-driver/_index.cn.md |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc_driver.cn.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "JDBC 驱动" |
| -weight = 3 |
| +weight = 5 |
| chapter = true |
| +++ |
| |
| diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/jdbc-driver/_index.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc_driver.en.md |
| similarity index 99% |
| rename from docs/document/content/user-manual/shardingsphere-jdbc/jdbc-driver/_index.en.md |
| rename to docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc_driver.en.md |
| index d03cea3fbdd..a93deb2fb58 100644 |
| --- a/docs/document/content/user-manual/shardingsphere-jdbc/jdbc-driver/_index.en.md |
| +++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc_driver.en.md |
| @@ -1,6 +1,6 @@ |
| +++ |
| title = "JDBC Driver" |
| -weight = 3 |
| +weight = 5 |
| chapter = true |
| +++ |
| |
