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 2022/05/16 07:27:43 UTC
[shardingsphere] branch master updated: Merge scaling quick start doc (#17699)
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 9886434bd2a Merge scaling quick start doc (#17699)
9886434bd2a is described below
commit 9886434bd2a1800d9323e9e01c954f661601401c
Author: Hongsheng Zhong <sa...@126.com>
AuthorDate: Mon May 16 15:27:32 2022 +0800
Merge scaling quick start doc (#17699)
---
.../shardingsphere-scaling-quick-start.cn.md | 38 ----------------------
.../shardingsphere-scaling-quick-start.en.md | 38 ----------------------
.../user-manual/shardingsphere-scaling/build.cn.md | 13 ++++++--
.../user-manual/shardingsphere-scaling/build.en.md | 13 ++++++--
.../user-manual/shardingsphere-scaling/usage.cn.md | 12 ++-----
.../user-manual/shardingsphere-scaling/usage.en.md | 10 +-----
6 files changed, 25 insertions(+), 99 deletions(-)
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
deleted file mode 100644
index cca035f20d0..00000000000
--- a/docs/document/content/quick-start/shardingsphere-scaling-quick-start.cn.md
+++ /dev/null
@@ -1,38 +0,0 @@
-+++
-pre = "<b>2.3. </b>"
-title = "ShardingSphere-Scaling (Experimental)"
-weight = 3
-+++
-
-## 规则配置
-
-编辑 `%SHARDINGSPHERE_PROXY_HOME%/conf/server.yaml`。
-
-> %SHARDINGSPHERE_PROXY_HOME% 为 Proxy 解压后的路径，例：/opt/shardingsphere-proxy-bin/
-
-详情请参见[运行部署](/cn/user-manual/shardingsphere-scaling/build/)。
-
-## 引入依赖
-
-如果后端连接 PostgreSQL 数据库，不需要引入额外依赖。
-
-如果后端连接 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_HOME%/lib` 目录。
-
-## 启动服务
-
-```bash
-sh %SHARDINGSPHERE_PROXY_HOME%/bin/start.sh
-```
-
-## 任务管理
-
-通过相应的 DistSQL 接口管理迁移任务。
-
-详情请参见[使用手册](/cn/user-manual/shardingsphere-scaling/usage/)。
-
-## 相关文档
-
-- [功能#弹性伸缩](/cn/features/scaling/)：核心概念、使用规范
-- [用户手册#弹性伸缩](/cn/user-manual/shardingsphere-scaling/)：运行部署、使用手册
-- [RAL#弹性伸缩](/cn/user-manual/shardingsphere-proxy/distsql/syntax/ral/#%E5%BC%B9%E6%80%A7%E4%BC%B8%E7%BC%A9)：弹性伸缩的 DistSQL
-- [开发者手册#弹性伸缩](/cn/dev-manual/scaling/)：SPI 接口及实现类
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
deleted file mode 100644
index 299594ab4b1..00000000000
--- a/docs/document/content/quick-start/shardingsphere-scaling-quick-start.en.md
+++ /dev/null
@@ -1,38 +0,0 @@
-+++
-pre = "<b>2.3. </b>"
-title = "ShardingSphere-Scaling (Experimental)"
-weight = 3
-+++
-
-## Rule Configuration
-
-Edit `%SHARDINGSPHERE_PROXY_HOME%/conf/server.yaml`.
-
-> %SHARDINGSPHERE_PROXY_HOME% is the shardingsphere proxy extract path. for example: /opt/shardingsphere-proxy-bin/
-
-Please refer to [Build Manual](/en/user-manual/shardingsphere-scaling/build/) for more details.
-
-## Import Dependencies
-
-If the backend database is PostgreSQL, there's no need for additional dependencies.
-
-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_HOME%/lib` directory.
-
-## Start Server
-
-```bash
-sh %SHARDINGSPHERE_PROXY_HOME%/bin/start.sh
-```
-
-## Create Migration Job
-
-Use DistSQL interface to manage the migration jobs.
-
-Please refer to [Usage Manual](/en/user-manual/shardingsphere-scaling/usage/) for more details.
-
-## Related documents
-
-- [Features#Scaling](/en/features/scaling/) : Core Concept, User Norms
-- [User Manual#Scaling](/en/user-manual/shardingsphere-scaling/) : Build, Manual
-- [RAL#Scaling](/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/#scaling) : DistSQL for Scaling
-- [Dev Manual#Scaling](/en/dev-manual/scaling/) : SPI interfaces and implementations
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 5de5f3d2a48..7ff78b62eb7 100644
--- a/docs/document/content/user-manual/shardingsphere-scaling/build.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-scaling/build.cn.md
@@ -176,13 +176,22 @@ DATA_CONSISTENCY_CHECKER(TYPE(NAME=DATA_MATCH, PROPERTIES("chunk-size"=1000)))
详情请参见 [RDL#数据分片](/cn/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/)。
-5. 启动 ShardingSphere-Proxy：
+5. 引入 JDBC 驱动
+
+如果后端连接以下数据库，请下载相应 JDBC 驱动 jar 包，并将其放入 `${shardingsphere-proxy}/lib` 目录。
+
+| 数据库 | JDBC 驱动 | 参考 |
+| --------------------- | ------------------------------------ | -------------------- |
+| 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 ) | [Connector/J Versions]( https://dev.mysql.com/doc/connector-j/5.1/en/connector-j-versions.html ) |
+| openGauss | [opengauss-jdbc-2.0.1-compatibility.jar]( https://repo1.maven.org/maven2/org/opengauss/opengauss-jdbc/2.0.1-compatibility/opengauss-jdbc-2.0.1-compatibility.jar ) | |
+
+6. 启动 ShardingSphere-Proxy：
```
sh bin/start.sh
```
-6. 查看 proxy 日志 `logs/stdout.log`，看到日志中出现：
+7. 查看 proxy 日志 `logs/stdout.log`，看到日志中出现：
```
[INFO ] [main] o.a.s.p.frontend.ShardingSphereProxy - ShardingSphere-Proxy start success
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 4feee8d2655..2be229745cc 100644
--- a/docs/document/content/user-manual/shardingsphere-scaling/build.en.md
+++ b/docs/document/content/user-manual/shardingsphere-scaling/build.en.md
@@ -175,13 +175,22 @@ DATA_CONSISTENCY_CHECKER(TYPE(NAME=DATA_MATCH, PROPERTIES("chunk-size"=1000)))
Please refer to [RDL#Sharding](/en/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/sharding/) for more details.
-5. Start up ShardingSphere-Proxy:
+5. Import JDBC driver dependency
+
+If the backend database is in following table, please download JDBC driver jar and put it into `${shardingsphere-proxy}/lib` directory.
+
+| RDBMS | JDBC driver | Reference |
+| --------------------- | ------------------------------------ | -------------------- |
+| 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 ) | [Connector/J Versions]( https://dev.mysql.com/doc/connector-j/5.1/en/connector-j-versions.html ) |
+| openGauss | [opengauss-jdbc-2.0.1-compatibility.jar]( https://repo1.maven.org/maven2/org/opengauss/opengauss-jdbc/2.0.1-compatibility/opengauss-jdbc-2.0.1-compatibility.jar ) | |
+
+6. Start up ShardingSphere-Proxy:
```
sh bin/start.sh
```
-6. Check proxy log `logs/stdout.log`:
+7. Check proxy log `logs/stdout.log`:
```
[INFO ] [main] o.a.s.p.frontend.ShardingSphereProxy - ShardingSphere-Proxy start success
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 61a7c253ced..0c542f99d41 100644
--- a/docs/document/content/user-manual/shardingsphere-scaling/usage.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-scaling/usage.cn.md
@@ -9,7 +9,7 @@ weight = 2
纯 JAVA 开发，JDK 建议 1.8 以上版本。
-支持迁移场景如下：
+支持的数据库及版本如下：
| 源端 | 目标端 |
| --------------------- | ----------------------- |
@@ -17,15 +17,6 @@ weight = 2
| PostgreSQL(9.4 ~ ) | PostgreSQL(9.4 ~ ) |
| openGauss(2.1.0) | openGauss(2.1.0) |
-**注意**：
-
-如果后端连接以下数据库，请下载相应 JDBC 驱动 jar 包，并将其放入 `${shardingsphere-proxy}/lib` 目录。
-
-| 数据库 | JDBC 驱动 | 参考 |
-| --------------------- | ------------------------------------ | -------------------- |
-| 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 ) | [Connector/J Versions]( https://dev.mysql.com/doc/connector-j/5.1/en/connector-j-versions.html ) |
-| openGauss | [opengauss-jdbc-2.0.1-compatibility.jar]( https://repo1.maven.org/maven2/org/opengauss/opengauss-jdbc/2.0.1-compatibility/opengauss-jdbc-2.0.1-compatibility.jar ) | |
-
功能支持情况：
| 功能 | MySQL | PostgreSQL | openGauss |
@@ -98,6 +89,7 @@ SHOW GRANTS FOR 'user';
```
wal_level = logical
max_replication_slots = 10
+max_connections = 600
```
详情请参见 [Write Ahead Log](https://www.postgresql.org/docs/9.6/runtime-config-wal.html) 和 [Replication](https://www.postgresql.org/docs/9.6/runtime-config-replication.html )。
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 a19dd25da36..57331b11ad9 100644
--- a/docs/document/content/user-manual/shardingsphere-scaling/usage.en.md
+++ b/docs/document/content/user-manual/shardingsphere-scaling/usage.en.md
@@ -17,15 +17,6 @@ The migration scene we support:
| PostgreSQL(9.4 ~ ) | PostgreSQL(9.4 ~ ) |
| openGauss(2.1.0) | openGauss(2.1.0) |
-**Attention**:
-
-If the backend database is in following table, please download JDBC driver jar and put it into `${shardingsphere-proxy}/lib` directory.
-
-| RDBMS | JDBC driver | Reference |
-| --------------------- | ------------------------------------ | -------------------- |
-| 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 ) | [Connector/J Versions]( https://dev.mysql.com/doc/connector-j/5.1/en/connector-j-versions.html ) |
-| openGauss | [opengauss-jdbc-2.0.1-compatibility.jar]( https://repo1.maven.org/maven2/org/opengauss/opengauss-jdbc/2.0.1-compatibility/opengauss-jdbc-2.0.1-compatibility.jar ) | |
-
Supported features:
| Feature | MySQL | PostgreSQL | openGauss |
@@ -100,6 +91,7 @@ Configuration Example of `postgresql.conf`:
```
wal_level = logical
max_replication_slots = 10
+max_connections = 600
```
Please refer to [Write Ahead Log](https://www.postgresql.org/docs/9.6/runtime-config-wal.html) and [Replication](https://www.postgresql.org/docs/9.6/runtime-config-replication.html ) for more details.