You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by pa...@apache.org on 2023/04/25 13:55:13 UTC
[shardingsphere] branch master updated: Update docs format (#25327)
This is an automated email from the ASF dual-hosted git repository.
panjuan 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 a8e3f3c10f4 Update docs format (#25327)
a8e3f3c10f4 is described below
commit a8e3f3c10f455c81529cb7cd2157edd2e306128c
Author: Liang Zhang <zh...@apache.org>
AuthorDate: Tue Apr 25 21:55:05 2023 +0800
Update docs format (#25327)
---
docs/document/content/features/encrypt/_index.cn.md | 3 +--
docs/document/content/features/encrypt/_index.en.md | 3 +--
docs/document/content/features/migration/concept.cn.md | 4 ++++
.../content/features/readwrite-splitting/concept.cn.md | 4 ++++
.../content/features/readwrite-splitting/concept.en.md | 4 ++++
.../content/test-manual/integration-test/_index.cn.md | 2 +-
.../content/test-manual/integration-test/_index.en.md | 2 +-
.../content/test-manual/pipeline-e2e-test/_index.cn.md | 2 +-
.../content/user-manual/error-code/sql-error-code.cn.md | 6 +++---
.../content/user-manual/error-code/sql-error-code.en.md | 6 +++---
.../java-api/rules/readwrite-splitting.cn.md | 14 +++++++-------
.../java-api/rules/readwrite-splitting.en.md | 4 ++--
.../shardingsphere-proxy/distsql/syntax/_index.cn.md | 1 -
.../shardingsphere-proxy/distsql/syntax/_index.en.md | 1 -
.../distsql/syntax/ral/show-dist-variable.en.md | 2 +-
15 files changed, 33 insertions(+), 25 deletions(-)
diff --git a/docs/document/content/features/encrypt/_index.cn.md b/docs/document/content/features/encrypt/_index.cn.md
index 07c18bebe5c..16671940eb0 100644
--- a/docs/document/content/features/encrypt/_index.cn.md
+++ b/docs/document/content/features/encrypt/_index.cn.md
@@ -12,8 +12,7 @@ chapter = true
对于数据加密的需求，在现实的业务场景中一般分为两种情况：
1. 新业务上线，安全部门规定需将涉及用户敏感信息，例如银行、手机号码等进行加密后存储到数据库，在使用的时候再进行解密处理。因为是全新系统，因而没有存量数据清洗问题，所以实现相对简单。
-
-1. 已上线业务，之前一直将明文存储在数据库中。相关部门突然需要对已上线业务进行加密整改。这种场景一般需要处理 3 个问题：
+2. 已上线业务，之前一直将明文存储在数据库中。相关部门突然需要对已上线业务进行加密整改。这种场景一般需要处理 3 个问题：
- 历史数据需要如何进行加密处理，即洗数。
- 如何能在不改动业务 SQL 和逻辑情况下，将新增数据进行加密处理，并存储到数据库；在使用时，再进行解密取出。
diff --git a/docs/document/content/features/encrypt/_index.en.md b/docs/document/content/features/encrypt/_index.en.md
index 3629da5bc11..bb50d16b310 100644
--- a/docs/document/content/features/encrypt/_index.en.md
+++ b/docs/document/content/features/encrypt/_index.en.md
@@ -12,8 +12,7 @@ Security control has always been a crucial link of data governance, data encrypt
The demand for data encryption is generally divided into two situations in real business scenarios:
1. When the new business start to launch, and the security department stipulates that the sensitive information related to users, such as banks and mobile phone numbers, should be encrypted and stored in the database, and then decrypted when used. Because it is a brand new system, there is no inventory data cleaning problem, so the implementation is relatively simple.
-
-1. For the service has been launched, and plaintext has been stored in the database before. The relevant department suddenly needs to encrypt the data from the on-line business. This scenario generally needs to deal with three issues as followings:
+2. For the service has been launched, and plaintext has been stored in the database before. The relevant department suddenly needs to encrypt the data from the on-line business. This scenario generally needs to deal with three issues as followings:
- How to encrypt the historical data, a.k.a.s data clean.
- How to encrypt the newly added data and store it in the database without changing the business SQL and logic; then decrypt the taken out data when use it.
diff --git a/docs/document/content/features/migration/concept.cn.md b/docs/document/content/features/migration/concept.cn.md
index 6b8962b750c..2c272bc05d3 100644
--- a/docs/document/content/features/migration/concept.cn.md
+++ b/docs/document/content/features/migration/concept.cn.md
@@ -4,15 +4,19 @@ weight = 1
+++
## 节点
+
运行计算层或存储层组件进程的实例，可以是物理机、虚拟机、容器等。
## 集群
+
为了提供特定服务而集合在一起的多个节点。
## 源端
+
原始数据所在的存储集群。
## 目标端
+
原始数据将要迁移的目标存储集群。
## 数据迁移作业
diff --git a/docs/document/content/features/readwrite-splitting/concept.cn.md b/docs/document/content/features/readwrite-splitting/concept.cn.md
index 730ac7c911b..3e5e252cae5 100644
--- a/docs/document/content/features/readwrite-splitting/concept.cn.md
+++ b/docs/document/content/features/readwrite-splitting/concept.cn.md
@@ -4,13 +4,17 @@ weight = 1
+++
## 主库
+
添加、更新以及删除数据操作所使用的数据库，目前仅支持单主库。
## 从库
+
查询数据操作所使用的数据库，可支持多从库。
## 主从同步
+
将主库的数据异步的同步到从库的操作。 由于主从同步的异步性，从库与主库的数据会短时间内不一致。
## 负载均衡策略
+
通过负载均衡策略将查询请求疏导至不同从库。
diff --git a/docs/document/content/features/readwrite-splitting/concept.en.md b/docs/document/content/features/readwrite-splitting/concept.en.md
index 941b6f4bf76..31ea9458867 100644
--- a/docs/document/content/features/readwrite-splitting/concept.en.md
+++ b/docs/document/content/features/readwrite-splitting/concept.en.md
@@ -4,14 +4,18 @@ weight = 1
+++
## Primary database
+
The primary database is used to add, update, and delete data operations. Currently, only single primary database is supported.
## Secondary database
+
The secondary database is used to query data operations and multi-secondary databases are supported.
## Primary-Secondary synchronization
+
It refers to the operation of asynchronously synchronizing data from a primary database to a secondary database. Due to the asynchronism of primary-secondary synchronization,
data from the primary and secondary databases may be inconsistent for a short time.
## Load balancer policy
+
Channel query requests to different secondary databases through load balancer policy.
diff --git a/docs/document/content/test-manual/integration-test/_index.cn.md b/docs/document/content/test-manual/integration-test/_index.cn.md
index c5c6a4d4c39..784474a3f69 100644
--- a/docs/document/content/test-manual/integration-test/_index.cn.md
+++ b/docs/document/content/test-manual/integration-test/_index.cn.md
@@ -195,4 +195,4 @@ IDEA -> Run -> Edit Configurations -> Add New Configuration -> Remote JVM Debug
#### 注意事项
1. 如需测试 Oracle，请在 pom.xml 中增加 Oracle 驱动依赖；
-1. 为了保证测试数据的完整性和易读性，整合测试中的分库分表采用了 10 库 10 表的方式，完全运行测试用例所需时间较长。
+2. 为了保证测试数据的完整性和易读性，整合测试中的分库分表采用了 10 库 10 表的方式，完全运行测试用例所需时间较长。
diff --git a/docs/document/content/test-manual/integration-test/_index.en.md b/docs/document/content/test-manual/integration-test/_index.en.md
index 7abac58023e..81cf709d9d5 100644
--- a/docs/document/content/test-manual/integration-test/_index.en.md
+++ b/docs/document/content/test-manual/integration-test/_index.en.md
@@ -194,4 +194,4 @@ After editing the above information, run Run -> Run -> e2e-debug in IDEA to star
#### Notice
1. To test Oracle, add an Oracle driver dependency to pom.xml.
-1. In order to ensure the integrity and legibility of the test data, 10 database shards and 10 table shards are used in the sharding of the integration testing, which takes a long time to run the test cases completely.
\ No newline at end of file
+2. In order to ensure the integrity and legibility of the test data, 10 database shards and 10 table shards are used in the sharding of the integration testing, which takes a long time to run the test cases completely.
\ No newline at end of file
diff --git a/docs/document/content/test-manual/pipeline-e2e-test/_index.cn.md b/docs/document/content/test-manual/pipeline-e2e-test/_index.cn.md
index 90a422bf7c6..ae157285bef 100644
--- a/docs/document/content/test-manual/pipeline-e2e-test/_index.cn.md
+++ b/docs/document/content/test-manual/pipeline-e2e-test/_index.cn.md
@@ -13,7 +13,7 @@ weight = 4
目前支持 Native 和 Docker。
1. Native：运行在开发者本机环境。需要在本机启动 ShardingSphere-Proxy 实例（通过 proxy 安装包或者在 IDE 运行 `org.apache.shardingsphere.proxy.Bootstrap`）和数据库实例。一般用于本机调试。
-1. Docker：运行在 Maven 插件拉起的 Docker 环境。一般用于 GitHub Action，也可以在本机运行。
+2. Docker：运行在 Maven 插件拉起的 Docker 环境。一般用于 GitHub Action，也可以在本机运行。
支持的数据库：MySQL、PostgreSQL、openGauss。
diff --git a/docs/document/content/user-manual/error-code/sql-error-code.cn.md b/docs/document/content/user-manual/error-code/sql-error-code.cn.md
index 6e3071cb53f..75f718ed4f9 100644
--- a/docs/document/content/user-manual/error-code/sql-error-code.cn.md
+++ b/docs/document/content/user-manual/error-code/sql-error-code.cn.md
@@ -24,7 +24,7 @@ SQL 错误码以标准的 SQL State，Vendor Code 和详细错误信息提供，
| 42S02 | 10021 | Single table \`%s\` does not exist. |
| HY000 | 10022 | Can not load table with database name \`%s\` and data source name \`%s\`. |
| 0A000 | 10030 | Can not drop schema \`%s\` because of contains tables. |
-| 0A000 | 10040 | Unsupported storage type of \`%s.%s\`. |
+| 0A000 | 10040 | Unsupported storage type of \`%s.%s\`. |
### 数据
@@ -71,8 +71,8 @@ SQL 错误码以标准的 SQL State，Vendor Code 和详细错误信息提供，
| 25000 | 14200 | Can not start new XA transaction in a active transaction. |
| 25000 | 14201 | Failed to create \`%s\` XA data source. |
| 25000 | 14202 | Max length of xa unique resource name \`%s\` exceeded: should be less than 45. |
-| 25000 | 14203 | Check privileges failed on data source, reason is: \`%s\` |
-| 25000 | 14204 | Failed to create XA transaction manager, requires \`%s\` privileges |
+| 25000 | 14203 | Check privileges failed on data source, reason is: \`%s\` |
+| 25000 | 14204 | Failed to create XA transaction manager, requires \`%s\` privileges |
| 25000 | 14301 | ShardingSphere Seata-AT transaction has been disabled. |
| 25000 | 14302 | Please config application id within seata.conf file. |
diff --git a/docs/document/content/user-manual/error-code/sql-error-code.en.md b/docs/document/content/user-manual/error-code/sql-error-code.en.md
index 612b90037eb..f83b773d8ae 100644
--- a/docs/document/content/user-manual/error-code/sql-error-code.en.md
+++ b/docs/document/content/user-manual/error-code/sql-error-code.en.md
@@ -24,7 +24,7 @@ SQL error codes provide by standard `SQL State`, `Vendor Code` and `Reason`, whi
| 42S02 | 10021 | Single table \`%s\` does not exist. |
| HY000 | 10022 | Can not load table with database name \`%s\` and data source name \`%s\`. |
| 0A000 | 10030 | Can not drop schema \`%s\` because of contains tables. |
-| 0A000 | 10040 | Unsupported storage type of \`%s.%s\`. |
+| 0A000 | 10040 | Unsupported storage type of \`%s.%s\`. |
### Data
@@ -71,8 +71,8 @@ SQL error codes provide by standard `SQL State`, `Vendor Code` and `Reason`, whi
| 25000 | 14200 | Can not start new XA transaction in a active transaction. |
| 25000 | 14201 | Failed to create \`%s\` XA data source. |
| 25000 | 14202 | Max length of xa unique resource name \`%s\` exceeded: should be less than 45. |
-| 25000 | 14203 | Check privileges failed on data source, reason is: \`%s\` |
-| 25000 | 14204 | Failed to create XA transaction manager, requires \`%s\` privileges |
+| 25000 | 14203 | Check privileges failed on data source, reason is: \`%s\` |
+| 25000 | 14204 | Failed to create XA transaction manager, requires \`%s\` privileges |
| 25000 | 14301 | ShardingSphere Seata-AT transaction has been disabled. |
| 25000 | 14302 | Please config application id within seata.conf file. |
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 591c7e6025a..4cf082e092d 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（同一事务内路由至非固定数据源） | DYNAMIC |
+| loadBalancerName (?) | String | 读库负载均衡算法名称 | 轮询负载均衡算法 |
算法类型的详情，请参见[内置负载均衡算法列表](/cn/user-manual/common-config/builtin-algorithm/load-balance)。
查询一致性路由的详情，请参见[核心特性：读写分离](/cn/features/readwrite-splitting/)。
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 94d0bc95bda..18c94feca9f 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
@@ -29,8 +29,8 @@ 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 | - |
+| 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 |
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/_index.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/_index.cn.md
index 0087dccbd9b..73715be255d 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/_index.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/_index.cn.md
@@ -23,7 +23,6 @@ chapter = true
- 算法名称
2. 标识符中允许使用的字符有：[`a-z,A-Z,0-9,_`]（字母、数字、下划线），且应以字母开头。
-
3. 当标识符中出现关键字或特殊字符时，使用反引号 (`) 。
### 字面量
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/_index.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/_index.en.md
index f8b9e30df7a..02fc361d99a 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/_index.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/_index.en.md
@@ -23,7 +23,6 @@ In DistSQL statement, except for keywords, the input format of other elements sh
- algorithm name
2. The allowed characters in the identifier are: [`A-Z, A-Z, 0-9, _`] (letters, numbers, underscores) and should start with a letter.
-
3. When keywords or special characters appear in the identifier, use the backticks (`).
### Literal
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-dist-variable.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-dist-variable.en.md
index 44d1a90817f..580907d31d9 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-dist-variable.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-dist-variable.en.md
@@ -29,7 +29,7 @@ variableName ::=
| Columns | Description |
|----------------|-----------------------|
| variable_name | system variable name |
-| variable_value | systen variable value |
+| variable_value | system variable value |
### Supplement