You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2021/10/30 13:13:41 UTC
[shardingsphere] branch master updated: Recheck and update scaling
doc for 5.0.0 (#13358)
This is an automated email from the ASF dual-hosted git repository.
zhangliang 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 d7f17ed Recheck and update scaling doc for 5.0.0 (#13358)
d7f17ed is described below
commit d7f17ed069746a196dff8aace600f7e0292ff519
Author: Hongsheng Zhong <sa...@126.com>
AuthorDate: Sat Oct 30 21:13:05 2021 +0800
Recheck and update scaling doc for 5.0.0 (#13358)
* Recheck and update scaling doc for 5.0.0
* Add openGauss as supported
---
docs/document/content/dev-manual/scaling.en.md | 2 +-
.../shardingsphere-scaling-quick-start.cn.md | 2 +-
.../shardingsphere-scaling-quick-start.en.md | 4 ++--
.../user-manual/shardingsphere-scaling/build.cn.md | 12 ++----------
.../user-manual/shardingsphere-scaling/build.en.md | 12 ++----------
.../user-manual/shardingsphere-scaling/usage.cn.md | 14 +++++++++-----
.../user-manual/shardingsphere-scaling/usage.en.md | 22 +++++++++++++---------
7 files changed, 30 insertions(+), 38 deletions(-)
diff --git a/docs/document/content/dev-manual/scaling.en.md b/docs/document/content/dev-manual/scaling.en.md
index 2a79012..798572f 100644
--- a/docs/document/content/dev-manual/scaling.en.md
+++ b/docs/document/content/dev-manual/scaling.en.md
@@ -5,7 +5,7 @@ weight = 10
chapter = true
+++
-### ScalingEntry
+## ScalingEntry
| *SPI Name* | *Description* |
| ---------------------- | --------------------------- |
diff --git a/docs/document/content/quick-start/shardingsphere-scaling-quick-start.cn.md b/docs/document/content/quick-start/shardingsphere-scaling-quick-start.cn.md
index 44a4939..3e5f530 100644
--- a/docs/document/content/quick-start/shardingsphere-scaling-quick-start.cn.md
+++ b/docs/document/content/quick-start/shardingsphere-scaling-quick-start.cn.md
@@ -6,7 +6,7 @@ weight = 3
## 1. 规则配置
-编辑`%SHARDINGSPHERE_PROXY_HOME%/conf/server.yaml`。详情请参见[使用手册](/cn/user-manual/shardingsphere-scaling/usage/)。
+编辑`%SHARDINGSPHERE_PROXY_HOME%/conf/server.yaml`。详情请参见[运行部署](/cn/user-manual/shardingsphere-scaling/build/)。
> %SHARDINGSPHERE_PROXY_HOME% 为 Proxy 解压后的路径，例：/Users/ss/shardingsphere-proxy-bin/
diff --git a/docs/document/content/quick-start/shardingsphere-scaling-quick-start.en.md b/docs/document/content/quick-start/shardingsphere-scaling-quick-start.en.md
index aaea1db..83459ae 100644
--- a/docs/document/content/quick-start/shardingsphere-scaling-quick-start.en.md
+++ b/docs/document/content/quick-start/shardingsphere-scaling-quick-start.en.md
@@ -6,7 +6,7 @@ weight = 3
## 1. Rule Configuration
-Edit `%SHARDINGSPHERE_PROXY_HOME%/conf/server.yaml`. Please refer to [Configuration Manual](/en/user-manual/shardingsphere-scaling/usage/) for more details.
+Edit `%SHARDINGSPHERE_PROXY_HOME%/conf/server.yaml`. Please refer to [Build Manual](/en/user-manual/shardingsphere-scaling/build/) for more details.
> %SHARDINGSPHERE_PROXY_HOME% is the shardingsphere proxy extract path. for example: /Users/ss/shardingsphere-proxy-bin/
@@ -26,7 +26,7 @@ sh %SHARDINGSPHERE_PROXY_HOME%/bin/start.sh
Use DistSQL interface to manage the migration jobs.
-Please refer to [Configuration Manual](/en/user-manual/shardingsphere-scaling/usage/) for more details.
+Please refer to [Usage Manual](/en/user-manual/shardingsphere-scaling/usage/) for more details.
## 5. Related documents
- [Features#Scaling](/en/features/scaling/) : Core Concept, User Norms
diff --git a/docs/document/content/user-manual/shardingsphere-scaling/build.cn.md b/docs/document/content/user-manual/shardingsphere-scaling/build.cn.md
index b76807a..0b9077b 100644
--- a/docs/document/content/user-manual/shardingsphere-scaling/build.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-scaling/build.cn.md
@@ -46,13 +46,9 @@ mode:
打开`clusterAutoSwitchAlgorithm`配置代表开启自动检测任务是否完成及切换配置，目前系统提供了`IDLE`类型实现。
-打开`dataConsistencyCheckAlgorithm`配置设置数据校验算法，目前系统提供了`DEFAULT`类型实现。`DEFAULT`算法目前支持的数据库：`MySQL`。其他数据库还不能打开这个配置项。其他数据库的支持还在开发中。
+打开`dataConsistencyCheckAlgorithm`配置设置数据校验算法，关闭该配置系统将不进行数据校验。目前系统提供了`DEFAULT`类型实现，`DEFAULT`算法目前支持的数据库：`MySQL`。其他数据库还不能打开这个配置项，相关支持还在开发中。
-可以通过`ScalingClusterAutoSwitchAlgorithm`接口自定义一个SPI实现。
-
-可以通过`ScalingDataConsistencyCheckAlgorithm`接口自定义一个SPI实现。
-
-详情请参见[开发者手册#弹性伸缩](/cn/dev-manual/scaling/)。
+可以通过`ScalingClusterAutoSwitchAlgorithm`接口自定义一个SPI实现，通过`ScalingDataConsistencyCheckAlgorithm`接口自定义一个SPI实现。详情请参见[开发者手册#弹性伸缩](/cn/dev-manual/scaling/)。
3. 启动 ShardingSphere-Proxy：
@@ -64,16 +60,12 @@ sh bin/start.sh
## 结束
-### ShardingSphere-Proxy
-
```
sh bin/stop.sh
```
## 应用配置项
-### ShardingSphere-Scaling
-
应用现有配置项如下，相应的配置可在 `conf/server.yaml` 中修改：
| 名称 | 说明 | 默认值 |
diff --git a/docs/document/content/user-manual/shardingsphere-scaling/build.en.md b/docs/document/content/user-manual/shardingsphere-scaling/build.en.md
index 5fab5a5..91d107f 100644
--- a/docs/document/content/user-manual/shardingsphere-scaling/build.en.md
+++ b/docs/document/content/user-manual/shardingsphere-scaling/build.en.md
@@ -46,13 +46,9 @@ mode:
Enable `clusterAutoSwitchAlgorithm` indicate system will detect when scaling job is finished and switch cluster configuration automatically. Currently, system supply `IDLE` type implementation.
-Enable `dataConsistencyCheckAlgorithm` indicate system will use this defined algorithm to do data consistency check when it's emitted. Currently, system supply `DEFAULT` type implementation. `DEFAULT` type algorithm support following database types: `MySQL`, you could not enable it if you're running other database types for now. Support of other database types is under development.
+Enable `dataConsistencyCheckAlgorithm` indicate system will use this defined algorithm to do data consistency check when it's emitted, if it's disabled, then data consistency check will be ignored. Currently, system supply `DEFAULT` type implementation, it supports following database types: `MySQL`, you could not enable it if you're running other database types for now, support of other database types is under development.
-You could customize an auto switch algorithm by implementing `ScalingClusterAutoSwitchAlgorithm` SPI interface.
-
-You could customize a check algorithm by implementing `ScalingDataConsistencyCheckAlgorithm` SPI interface.
-
-Please refer to [Dev Manual#Scaling](/en/dev-manual/scaling/).
+You could customize an auto switch algorithm by implementing `ScalingClusterAutoSwitchAlgorithm` SPI interface, and customize a check algorithm by implementing `ScalingDataConsistencyCheckAlgorithm` SPI interface. Please refer to [Dev Manual#Scaling](/en/dev-manual/scaling/) for more details.
3. Start up ShardingSphere-Proxy:
@@ -64,16 +60,12 @@ sh bin/start.sh
## Shutdown
-### ShardingSphere-Proxy
-
```
sh bin/stop.sh
```
## Configuration
-### ShardingSphere-Scaling
-
The existing configuration items are as follows, we can modify them in `conf/server.yaml`:
| Name | Description | Default value |
diff --git a/docs/document/content/user-manual/shardingsphere-scaling/usage.cn.md b/docs/document/content/user-manual/shardingsphere-scaling/usage.cn.md
index 6698de7..cacd27f 100644
--- a/docs/document/content/user-manual/shardingsphere-scaling/usage.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-scaling/usage.cn.md
@@ -11,14 +11,15 @@ weight = 2
支持迁移场景如下：
-| 源端 | 目标端 | 是否支持 |
-| --------------------- | -------------------- | ------- |
-| MySQL(5.1.15 ~ 5.7.x) | ShardingSphere-Proxy | 是 |
-| PostgreSQL(9.4 ~ ) | ShardingSphere-Proxy | 是 |
+| 源端 | 目标端 |
+| --------------------- | -------------------- |
+| MySQL(5.1.15 ~ 5.7.x) | MySQL |
+| PostgreSQL(9.4 ~ ) | PostgreSQL |
+| openGauss(2.1.0) | openGauss |
**注意**：
-如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-5.1.47.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/5.1.47/mysql-connector-java-5.1.47.jar)，并将其放入 `${shardingsphere-proxy}\lib` 目录。
+如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-5.1.47.jar]( https://repo1.maven.org/maven2/mysql/mysql-connector-java/5.1.47/mysql-connector-java-5.1.47.jar )，并将其放入 `${shardingsphere-proxy}/lib` 目录。
### 权限要求
@@ -71,6 +72,7 @@ mysql> preview select count(1) from t_order;
#### 创建迁移任务
1. 添加新的数据源
+
详情请参见[RDL#数据源资源](/cn/user-manual/shardingsphere-proxy/usage/distsql/syntax/rdl/rdl-resource/)。
示例：
@@ -85,6 +87,7 @@ ADD RESOURCE ds_2 (
```
2. 修改分片规则
+
详情请参见[RDL#数据分片](/cn/user-manual/shardingsphere-proxy/usage/distsql/syntax/rdl/rdl-sharding-rule/)。
示例：
@@ -100,6 +103,7 @@ GENERATED_KEY(COLUMN=another_id,TYPE(NAME=snowflake,PROPERTIES("worker-id"=123))
比如说`RESOURCES`和`sharding-count`修改了会触发迁移。
#### 查询所有迁移任务
+
详情请参见[RAL#弹性伸缩](/cn/user-manual/shardingsphere-proxy/usage/distsql/syntax/ral/ral/#%E5%BC%B9%E6%80%A7%E4%BC%B8%E7%BC%A9)。
示例：
diff --git a/docs/document/content/user-manual/shardingsphere-scaling/usage.en.md b/docs/document/content/user-manual/shardingsphere-scaling/usage.en.md
index bf56f93..b837516 100644
--- a/docs/document/content/user-manual/shardingsphere-scaling/usage.en.md
+++ b/docs/document/content/user-manual/shardingsphere-scaling/usage.en.md
@@ -11,14 +11,15 @@ JAVA，JDK 1.8+.
The migration scene we support:
-| Source | Target | Support |
-| -------------------------- | -------------------- | ------- |
-| MySQL(5.1.15 ~ 5.7.x) | ShardingSphere-Proxy | Yes |
-| PostgreSQL(9.4 ~ ) | ShardingSphere-Proxy | Yes |
+| Source | Target |
+| -------------------------- | -------------------- |
+| MySQL(5.1.15 ~ 5.7.x) | MySQL |
+| PostgreSQL(9.4 ~ ) | PostgreSQL |
+| openGauss(2.1.0) | openGauss |
**Attention**:
-If the backend database is MySQL, please download [mysql-connector-java-5.1.47.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/5.1.47/mysql-connector-java-5.1.47.jar) and put it into `${shardingsphere-scaling}\lib directory`.
+If the backend database is MySQL, please download [mysql-connector-java-5.1.47.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/5.1.47/mysql-connector-java-5.1.47.jar) and put it into `${shardingsphere-proxy}/lib directory`.
### Privileges
@@ -71,7 +72,8 @@ mysql> preview select count(1) from t_order;
#### Start scaling job
1. Add new data source resources
-Please refer to [RDL#Data Source](/en/user-manual/shardingsphere-proxy/usage/distsql/syntax/rdl/rdl-resource/).
+
+Please refer to [RDL#Data Source](/en/user-manual/shardingsphere-proxy/usage/distsql/syntax/rdl/rdl-resource/) for more details.
Example:
```sql
@@ -85,7 +87,8 @@ ADD RESOURCE ds_2 (
```
2. Alter sharding table rule
-Please refer to [RDL#Sharding](/en/user-manual/shardingsphere-proxy/usage/distsql/syntax/rdl/rdl-sharding-rule/).
+
+Please refer to [RDL#Sharding](/en/user-manual/shardingsphere-proxy/usage/distsql/syntax/rdl/rdl-sharding-rule/) for more details.
Example:
```sql
@@ -100,7 +103,8 @@ GENERATED_KEY(COLUMN=another_id,TYPE(NAME=snowflake,PROPERTIES("worker-id"=123))
If `RESOURCES` and `sharding-count` is changed, then scaling job will be emitted.
#### List scaling jobs
-Please refer to [RAL#Scaling](/en/user-manual/shardingsphere-proxy/usage/distsql/syntax/ral/ral/#scaling).
+
+Please refer to [RAL#Scaling](/en/user-manual/shardingsphere-proxy/usage/distsql/syntax/ral/ral/#scaling) for more details.
Example:
```sql
@@ -177,4 +181,4 @@ mysql> preview select count(1) from t_order;
```
#### Other DistSQL
-Please refer to [RAL#Scaling](/en/user-manual/shardingsphere-proxy/usage/distsql/syntax/ral/ral/#scaling).
+Please refer to [RAL#Scaling](/en/user-manual/shardingsphere-proxy/usage/distsql/syntax/ral/ral/#scaling) for more details.