blob: b25003687942ee4d24f1f9c13cb2243f989b0213 [file] [log] [blame]
commit d589884c9882e644316fc9a53a0b1d864cd719a6
Author: yx9o <yangx_soft@163.com>
Date: Fri Aug 12 18:51:31 2022 +0800
Updated documentation for Scaling. (#20108)
* Updated documentation for Scaling.
* Update algorithmName to algorithmTypeName.
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.cn.md
index 31ead6ee630..ed49c847bb5 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.cn.md
@@ -30,7 +30,7 @@ RAL (Resource & Rule Administration Language) Apache ShardingSphere 的管
| RESET SCALING jobId | 重置任务进度,xx:任务 id | RESET SCALING 1234 |
| CHECK SCALING jobId | 数据一致性校验,使用 `server.yaml` 里的校验算法,xx:任务 id | CHECK SCALING 1234 |
| SHOW SCALING CHECK ALGORITHMS | 展示可用的一致性校验算法 | SHOW SCALING CHECK ALGORITHMS |
-| CHECK SCALING {jobId} by type(name={algorithmType}) | 数据一致性校验,使用指定的校验算法 | CHECK SCALING 1234 by type(name=DEFAULT) |
+| CHECK SCALING jobId (by type(name=algorithmTypeName)? | 数据一致性校验,使用指定的校验算法 | CHECK SCALING 1234 by type(name="DEFAULT") |
| STOP SCALING SOURCE WRITING jobId | 旧的 ShardingSphere 数据源停写,xx:任务 id | STOP SCALING SOURCE WRITING 1234 |
| RESTORE SCALING SOURCE WRITING jobId | 旧的 ShardingSphere 数据源恢复写,xx:任务 id | RESTORE SCALING SOURCE WRITING 1234 |
| APPLY SCALING jobId | 切换至新的 ShardingSphere 元数据,xx:任务 id | APPLY SCALING 1234 |
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.en.md
index a5f4b8ffcc9..12655495052 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.en.md
@@ -30,7 +30,7 @@ RAL (Resource & Rule Administration Language) responsible for hint, circuit brea
| RESET SCALING jobId | reset progress, xx: jobId | RESET SCALING 1234 |
| CHECK SCALING jobId | Data consistency check with algorithm in `server.yaml`, xx: jobId | CHECK SCALING 1234 |
| SHOW SCALING CHECK ALGORITHMS | Show available consistency check algorithms | SHOW SCALING CHECK ALGORITHMS |
-| CHECK SCALING {jobId} by type(name={algorithmType}) | Data consistency check with defined algorithm | CHECK SCALING 1234 by type(name=DEFAULT) |
+| CHECK SCALING jobId (by type(name=algorithmTypeName)? | Data consistency check with defined algorithm | CHECK SCALING 1234 by type(name="DEFAULT") |
| STOP SCALING SOURCE WRITING jobId | The source ShardingSphere data source is discontinued, xx: jobId | STOP SCALING SOURCE WRITING 1234 |
| RESTORE SCALING SOURCE WRITING jobId | Restore source data source writing, xx: jobId | RESTORE SCALING SOURCE WRITING 1234 |
| APPLY SCALING jobId | Switch to target ShardingSphere metadata, xx: jobId | APPLY SCALING 1234 |
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.cn.md
index 1fef57f38de..dd81e4f2c0b 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.cn.md
@@ -299,9 +299,9 @@ OUTPUT(
WORKER_THREAD=40,
BATCH_SIZE=1000
),
-STREAM_CHANNEL(TYPE(NAME=MEMORY, PROPERTIES("block-queue-size"=10000))),
-COMPLETION_DETECTOR(TYPE(NAME=IDLE, PROPERTIES("incremental-task-idle-seconds-threshold"=1800))),
-DATA_CONSISTENCY_CHECKER(TYPE(NAME=DATA_MATCH, PROPERTIES("chunk-size"=1000)))
+STREAM_CHANNEL(TYPE(NAME="MEMORY", PROPERTIES("block-queue-size"="10000"))),
+COMPLETION_DETECTOR(TYPE(NAME="IDLE", PROPERTIES("incremental-task-idle-seconds-threshold"="1800"))),
+DATA_CONSISTENCY_CHECKER(TYPE(NAME="DATA_MATCH", PROPERTIES("chunk-size"="1000")))
);
ENABLE SHARDING SCALING RULE sharding_scaling;
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.en.md
index 751ba7011b5..c73a7dd0afa 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding.en.md
@@ -297,9 +297,9 @@ OUTPUT(
WORKER_THREAD=40,
BATCH_SIZE=1000
),
-STREAM_CHANNEL(TYPE(NAME=MEMORY, PROPERTIES("block-queue-size"=10000))),
-COMPLETION_DETECTOR(TYPE(NAME=IDLE, PROPERTIES("incremental-task-idle-seconds-threshold"=1800))),
-DATA_CONSISTENCY_CHECKER(TYPE(NAME=DATA_MATCH, PROPERTIES("chunk-size"=1000)))
+STREAM_CHANNEL(TYPE(NAME="MEMORY", PROPERTIES("block-queue-size"="10000"))),
+COMPLETION_DETECTOR(TYPE(NAME="IDLE", PROPERTIES("incremental-task-idle-seconds-threshold"="1800"))),
+DATA_CONSISTENCY_CHECKER(TYPE(NAME="DATA_MATCH", PROPERTIES("chunk-size"="1000")))
);
ENABLE SHARDING SCALING RULE sharding_scaling;
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/scaling/build.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/scaling/build.cn.md
index 8cadcefaf38..13467b07da7 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/scaling/build.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/scaling/build.cn.md
@@ -18,7 +18,7 @@ mvn clean install -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true -Drat.skip=tr
或者通过[下载页面]( https://shardingsphere.apache.org/document/current/cn/downloads/ )获取安装包。
-> Scaling还是实验性质的功能,建议使用master分支最新版本,点击此处[下载每日构建版本]( https://github.com/apache/shardingsphere#nightly-builds )
+> Scaling 还是实验性质的功能,建议使用 master 分支最新版本,点击此处[下载每日构建版本]( https://github.com/apache/shardingsphere#nightly-builds )
2. 解压缩 proxy 发布包,修改配置文件 `conf/config-sharding.yaml`。详情请参见 [proxy 启动手册](/cn/user-manual/shardingsphere-proxy/startup/bin/)。
@@ -152,9 +152,9 @@ OUTPUT(
WORKER_THREAD=40,
BATCH_SIZE=1000
),
-STREAM_CHANNEL(TYPE(NAME=MEMORY, PROPERTIES("block-queue-size"=10000))),
-COMPLETION_DETECTOR(TYPE(NAME=IDLE, PROPERTIES("incremental-task-idle-seconds-threshold"=1800))),
-DATA_CONSISTENCY_CHECKER(TYPE(NAME=DATA_MATCH, PROPERTIES("chunk-size"=1000)))
+STREAM_CHANNEL(TYPE(NAME="MEMORY", PROPERTIES("block-queue-size"="10000"))),
+COMPLETION_DETECTOR(TYPE(NAME="IDLE", PROPERTIES("incremental-task-idle-seconds-threshold"="1800"))),
+DATA_CONSISTENCY_CHECKER(TYPE(NAME="DATA_MATCH", PROPERTIES("chunk-size"="1000")))
);
```
@@ -169,8 +169,8 @@ OUTPUT(
WORKER_THREAD=40,
BATCH_SIZE=1000
),
-STREAM_CHANNEL(TYPE(NAME=MEMORY, PROPERTIES("block-queue-size"=10000))),
-DATA_CONSISTENCY_CHECKER(TYPE(NAME=DATA_MATCH, PROPERTIES("chunk-size"=1000)))
+STREAM_CHANNEL(TYPE(NAME="MEMORY", PROPERTIES("block-queue-size"="10000"))),
+DATA_CONSISTENCY_CHECKER(TYPE(NAME="DATA_MATCH", PROPERTIES("chunk-size"="1000")))
);
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/scaling/build.en.md b/docs/document/content/user-manual/shardingsphere-proxy/scaling/build.en.md
index 742fbfdf402..f1415802544 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/scaling/build.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/scaling/build.en.md
@@ -151,9 +151,9 @@ OUTPUT(
WORKER_THREAD=40,
BATCH_SIZE=1000
),
-STREAM_CHANNEL(TYPE(NAME=MEMORY, PROPERTIES("block-queue-size"=10000))),
-COMPLETION_DETECTOR(TYPE(NAME=IDLE, PROPERTIES("incremental-task-idle-seconds-threshold"=1800))),
-DATA_CONSISTENCY_CHECKER(TYPE(NAME=DATA_MATCH, PROPERTIES("chunk-size"=1000)))
+STREAM_CHANNEL(TYPE(NAME="MEMORY", PROPERTIES("block-queue-size"="10000"))),
+COMPLETION_DETECTOR(TYPE(NAME="IDLE", PROPERTIES("incremental-task-idle-seconds-threshold"="1800"))),
+DATA_CONSISTENCY_CHECKER(TYPE(NAME="DATA_MATCH", PROPERTIES("chunk-size"="1000")))
);
```
@@ -168,8 +168,8 @@ OUTPUT(
WORKER_THREAD=40,
BATCH_SIZE=1000
),
-STREAM_CHANNEL(TYPE(NAME=MEMORY, PROPERTIES("block-queue-size"=10000))),
-DATA_CONSISTENCY_CHECKER(TYPE(NAME=DATA_MATCH, PROPERTIES("chunk-size"=1000)))
+STREAM_CHANNEL(TYPE(NAME="MEMORY", PROPERTIES("block-queue-size"="10000"))),
+DATA_CONSISTENCY_CHECKER(TYPE(NAME="DATA_MATCH", PROPERTIES("chunk-size"="1000")))
);
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/scaling/usage.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/scaling/usage.cn.md
index fd403d93d47..8268b8deabc 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/scaling/usage.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/scaling/usage.cn.md
@@ -127,19 +127,19 @@ mysql> preview SELECT COUNT(1) FROM t_order;
```sql
ADD RESOURCE ds_2 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_2?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=10,"idleTimeout"="30000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="10","idleTimeout"="30000")
), ds_3 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_3?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=10,"idleTimeout"="30000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="10","idleTimeout"="30000")
), ds_4 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_4?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=10,"idleTimeout"="30000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="10","idleTimeout"="30000")
);
```
@@ -313,14 +313,14 @@ USE scaling_db
```sql
ADD RESOURCE ds_0 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_0?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=50,"idleTimeout"="60000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="50","idleTimeout"="60000")
), ds_1 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_1?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=50,"idleTimeout"="60000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="50","idleTimeout"="60000")
);
```
@@ -350,7 +350,7 @@ KEY_GENERATE_STRATEGY(COLUMN=order_item_id,TYPE(NAME=snowflake))
);
CREATE SHARDING SCALING RULE scaling_manual2 (
-DATA_CONSISTENCY_CHECKER(TYPE(NAME=CRC32_MATCH))
+DATA_CONSISTENCY_CHECKER(TYPE(NAME="CRC32_MATCH"))
);
```
@@ -396,19 +396,19 @@ CREATE DATABASE scaling_ds_12 DEFAULT CHARSET utf8;
```sql
ADD RESOURCE ds_2 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_10?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=50,"idleTimeout"="60000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="50","idleTimeout"="60000")
), ds_3 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_11?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=50,"idleTimeout"="60000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="50","idleTimeout"="60000")
), ds_4 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_12?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=50,"idleTimeout"="60000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="50","idleTimeout"="60000")
);
```
@@ -441,7 +441,7 @@ mysql> SHOW SCALING LIST;
+--------------------------------------------+----------------------+----------------------+--------+---------------------+-----------+
1 row in set (0.34 sec)
-mysql> SHOW SCALING STATUS 0130317c30317c3054317c7363616c696e675f6462;
+mysql> SHOW SCALING STATUS "0130317c30317c3054317c7363616c696e675f6462";
+------+-------------+--------------------------+--------+-------------------------------+--------------------------+
| item | data_source | status | active | inventory_finished_percentage | incremental_idle_seconds |
+------+-------------+--------------------------+--------+-------------------------------+--------------------------+
@@ -457,13 +457,13 @@ mysql> SHOW SCALING STATUS 0130317c30317c3054317c7363616c696e675f6462;
proxy 停写:
```sql
-mysql> STOP SCALING SOURCE WRITING 0130317c30317c3054317c7363616c696e675f6462;
+mysql> STOP SCALING SOURCE WRITING "0130317c30317c3054317c7363616c696e675f6462";
Query OK, 0 rows affected (0.07 sec)
```
数据一致性校验:
```sql
-mysql> CHECK SCALING 0130317c30317c3054317c7363616c696e675f6462 BY TYPE (NAME=CRC32_MATCH);
+mysql> CHECK SCALING "0130317c30317c3054317c7363616c696e675f6462" BY TYPE (NAME="CRC32_MATCH");
+--------------+----------------------+----------------------+-----------------------+-------------------------+
| table_name | source_records_count | target_records_count | records_count_matched | records_content_matched |
+--------------+----------------------+----------------------+-----------------------+-------------------------+
@@ -475,7 +475,7 @@ mysql> CHECK SCALING 0130317c30317c3054317c7363616c696e675f6462 BY TYPE (NAME=CR
切换元数据:
```sql
-mysql> APPLY SCALING 0130317c30317c3054317c7363616c696e675f6462;
+mysql> APPLY SCALING "0130317c30317c3054317c7363616c696e675f6462";
Query OK, 0 rows affected (0.22 sec)
```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/scaling/usage.en.md b/docs/document/content/user-manual/shardingsphere-proxy/scaling/usage.en.md
index c1c3246d61f..2f7ca8f28cc 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/scaling/usage.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/scaling/usage.en.md
@@ -129,19 +129,19 @@ Example:
```sql
ADD RESOURCE ds_2 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_2?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=10,"idleTimeout"="30000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="10","idleTimeout"="30000")
), ds_3 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_3?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=10,"idleTimeout"="30000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="10","idleTimeout"="30000")
), ds_4 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_4?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=10,"idleTimeout"="30000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="10","idleTimeout"="30000")
);
```
@@ -315,14 +315,14 @@ Add source database resource:
```sql
ADD RESOURCE ds_0 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_0?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=50,"idleTimeout"="60000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="50","idleTimeout"="60000")
), ds_1 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_1?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=50,"idleTimeout"="60000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="50","idleTimeout"="60000")
);
```
@@ -352,7 +352,7 @@ KEY_GENERATE_STRATEGY(COLUMN=order_item_id,TYPE(NAME=snowflake))
);
CREATE SHARDING SCALING RULE scaling_manual2 (
-DATA_CONSISTENCY_CHECKER(TYPE(NAME=CRC32_MATCH))
+DATA_CONSISTENCY_CHECKER(TYPE(NAME="CRC32_MATCH"))
);
```
@@ -398,19 +398,19 @@ Add target database resource:
```sql
ADD RESOURCE ds_2 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_10?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=50,"idleTimeout"="60000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="50","idleTimeout"="60000")
), ds_3 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_11?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=50,"idleTimeout"="60000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="50","idleTimeout"="60000")
), ds_4 (
URL="jdbc:mysql://127.0.0.1:3306/scaling_ds_12?serverTimezone=UTC&useSSL=false",
- USER=root,
- PASSWORD=root,
- PROPERTIES("maximumPoolSize"=50,"idleTimeout"="60000")
+ USER="root",
+ PASSWORD="root",
+ PROPERTIES("maximumPoolSize"="50","idleTimeout"="60000")
);
```
@@ -443,7 +443,7 @@ mysql> SHOW SCALING LIST;
+--------------------------------------------+----------------------+----------------------+--------+---------------------+-----------+
1 row in set (0.34 sec)
-mysql> SHOW SCALING STATUS 0130317c30317c3054317c7363616c696e675f6462;
+mysql> SHOW SCALING STATUS "0130317c30317c3054317c7363616c696e675f6462";
+------+-------------+--------------------------+--------+-------------------------------+--------------------------+
| item | data_source | status | active | inventory_finished_percentage | incremental_idle_seconds |
+------+-------------+--------------------------+--------+-------------------------------+--------------------------+
@@ -458,13 +458,13 @@ Choose an idle time of business system, stop source database writing or stop upp
Stop source writing in proxy:
```sql
-mysql> STOP SCALING SOURCE WRITING 0130317c30317c3054317c7363616c696e675f6462;
+mysql> STOP SCALING SOURCE WRITING "0130317c30317c3054317c7363616c696e675f6462";
Query OK, 0 rows affected (0.07 sec)
```
Data consistency check:
```sql
-mysql> CHECK SCALING 0130317c30317c3054317c7363616c696e675f6462 BY TYPE (NAME=CRC32_MATCH);
+mysql> CHECK SCALING "0130317c30317c3054317c7363616c696e675f6462" BY TYPE (NAME="CRC32_MATCH");
+--------------+----------------------+----------------------+-----------------------+-------------------------+
| table_name | source_records_count | target_records_count | records_count_matched | records_content_matched |
+--------------+----------------------+----------------------+-----------------------+-------------------------+
@@ -476,7 +476,7 @@ mysql> CHECK SCALING 0130317c30317c3054317c7363616c696e675f6462 BY TYPE (NAME=CR
Apply metadata:
```sql
-mysql> APPLY SCALING 0130317c30317c3054317c7363616c696e675f6462;
+mysql> APPLY SCALING "0130317c30317c3054317c7363616c696e675f6462";
Query OK, 0 rows affected (0.22 sec)
```