git clone --depth 1 https://github.com/apache/shardingsphere.git
cd shardingsphere
mvn clean install -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true -Drat.skip=true -Djacoco.skip=true -DskipITs -DskipTests -Prelease
发布包：
或者通过下载页面获取安装包。
Scaling还是实验性质的功能，建议使用master分支最新版本，点击此处下载每日构建版本
解压缩 proxy 发布包，修改配置文件 conf/config-sharding.yaml。详情请参见 proxy 启动手册。
修改配置文件 conf/server.yaml，详情请参见模式配置。
目前 mode 必须是 Cluster，需要提前启动对应的注册中心。
配置示例：
mode:
type: Cluster
repository:
type: ZooKeeper
props:
namespace: governance_ds
server-lists: localhost:2181
retryIntervalMilliseconds: 500
timeToLiveSeconds: 60
maxRetries: 3
operationTimeoutMilliseconds: 500
overwrite: false
方法1：修改配置文件 conf/config-sharding.yaml 的 scalingName 和 scaling 部分。
配置项说明：
rules:
- !SHARDING
# 忽略的配置
scalingName: # 启用的弹性伸缩配置名称
scaling:
<scaling-action-config-name> (+):
input: # 数据读取配置。如果不配置则部分参数默认生效。
workerThread: # 从源端摄取全量数据的线程池大小。如果不配置则使用默认值。
batchSize: # 一次查询操作返回的最大记录数。如果不配置则使用默认值。
rateLimiter: # 限流算法。如果不配置则不限流。
type: # 算法类型。可选项：
props: # 算法属性
output: # 数据写入配置。如果不配置则部分参数默认生效。
workerThread: # 数据写入到目标端的线程池大小。如果不配置则使用默认值。
batchSize: # 一次批量写入操作的最大记录数。如果不配置则使用默认值。
rateLimiter: # 限流算法。如果不配置则不限流。
type: # 算法类型。可选项：
props: # 算法属性
streamChannel: # 数据通道，连接生产者和消费者，用于 input 和 output 环节。如果不配置则默认使用 MEMORY 类型
type: # 算法类型。可选项：MEMORY
props: # 算法属性
block-queue-size: # 属性：阻塞队列大小
completionDetector: # 作业是否接近完成检测算法。如果不配置则无法自动进行后续步骤，可以通过 DistSQL 手动操作。
type: # 算法类型。可选项：IDLE
props: # 算法属性
incremental-task-idle-seconds-threshold: # 如果增量同步任务不再活动超过一定时间，那么可以认为增量同步任务接近完成。适用算法类型：IDLE
dataConsistencyChecker: # 数据一致性校验算法。如果不配置则跳过这个步骤。
type: # 算法类型。可选项：DATA_MATCH, CRC32_MATCH
props: # 算法属性
chunk-size: # 一次查询操作返回的最大记录数
dataConsistencyChecker 的 type 可以通过执行 DistSQL SHOW SCALING CHECK ALGORITHMS 查询到。简单对比：
DATA_MATCH：支持所有数据库，但是性能不是最好的。CRC32_MATCH：只支持 MySQL，但是性能更好。自动模式配置示例：
rules:
- !SHARDING
# 忽略的配置
scalingName: scaling_auto
scaling:
scaling_auto:
input:
workerThread: 40
batchSize: 1000
output:
workerThread: 40
batchSize: 1000
streamChannel:
type: MEMORY
props:
block-queue-size: 10000
completionDetector:
type: IDLE
props:
incremental-task-idle-seconds-threshold: 1800
dataConsistencyChecker:
type: DATA_MATCH
props:
chunk-size: 1000
手动模式配置示例：
rules:
- !SHARDING
# 忽略的配置
scalingName: scaling_manual
scaling:
scaling_manual:
input:
workerThread: 40
batchSize: 1000
output:
workerThread: 40
batchSize: 1000
streamChannel:
type: MEMORY
props:
block-queue-size: 10000
dataConsistencyChecker:
type: DATA_MATCH
props:
chunk-size: 1000
方法2：通过 DistSQL 配置 scaling
自动模式配置示例：
CREATE SHARDING SCALING RULE scaling_auto (
INPUT(
WORKER_THREAD=40,
BATCH_SIZE=1000
),
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)))
);
手动模式配置示例：
CREATE SHARDING SCALING RULE scaling_manual (
INPUT(
WORKER_THREAD=40,
BATCH_SIZE=1000
),
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)))
);
详情请参见 RDL#数据分片。
如果后端连接以下数据库，请下载相应 JDBC 驱动 jar 包，并将其放入 ${shardingsphere-proxy}/lib 目录。
| 数据库 | JDBC 驱动 | 参考 |
|---|---|---|
| MySQL | mysql-connector-java-5.1.47.jar | Connector/J Versions |
| openGauss | opengauss-jdbc-2.0.1-compatibility.jar |
sh bin/start.sh
logs/stdout.log，看到日志中出现：[INFO ] [main] o.a.s.p.frontend.ShardingSphereProxy - ShardingSphere-Proxy start success
确认启动成功。
sh bin/stop.sh