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 |
Attention:
If the backend database is MySQL, please download mysql-connector-java-5.1.47.jar and put it into ${shardingsphere-scaling}\lib directory.
MySQL need to open binlog, and binlog format should be Row model. Privileges of users scaling used should include Replication privileges.
+-----------------------------------------+---------------------------------------+
| Variable_name | Value |
+-----------------------------------------+---------------------------------------+
| log_bin | ON |
| binlog_format | ROW |
+-----------------------------------------+---------------------------------------+
+------------------------------------------------------------------------------+
|Grants for ${username}@${host} |
+------------------------------------------------------------------------------+
|GRANT REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO ${username}@${host} |
|....... |
+------------------------------------------------------------------------------+
PostgreSQL need to support and open test_decoding feature.
ShardingSphere-Scaling provides a simple HTTP API
Interface description：POST /scaling/job/start
Body:
| Parameter | Describe |
|---|---|
| ruleConfiguration.source | source data source configuration |
| ruleConfiguration.target | target data source configuration |
| jobConfiguration.concurrency | sync task proposed concurrency |
Data source configuration:
| Parameter | Describe |
|---|---|
| type | data source type(available parameters:shardingSphereJdbc,jdbc) |
| parameter | data source parameter |
Parameter configuration:
type = shardingSphereJdbc
| Parameter | Describe |
|---|---|
| dataSource | sharding sphere data source configuration |
| rule | sharding sphere data source table rule |
type = jdbc
| Parameter | Describe |
|---|---|
| name | jdbc name |
| ruleConfiguration.targetDataSources.jdbcUrl | jdbc url |
| ruleConfiguration.targetDataSources.username | jdbc username |
| ruleConfiguration.targetDataSources.password | jdbc password |
*** Notice ***
Currently source type must shardingSphereJdbc
Example：
curl -X POST \
http://localhost:8888/scaling/job/start \
-H 'content-type: application/json' \
-d '{
"ruleConfiguration": {
"source": {
"type": "shardingSphereJdbc",
"parameter": {
"dataSource":"
dataSources:
ds_0:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
props:
driverClassName: com.mysql.jdbc.Driver
jdbcUrl: jdbc:mysql://127.0.0.1:3306/scaling_0?useSSL=false
username: scaling
password: scaling
ds_1:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
props:
driverClassName: com.mysql.jdbc.Driver
jdbcUrl: jdbc:mysql://127.0.0.1:3306/scaling_1?useSSL=false
username: scaling
password: scaling
",
"rule":"
rules:
- !SHARDING
tables:
t_order:
actualDataNodes: ds_$->{0..1}.t_order_$->{0..1}
databaseStrategy:
standard:
shardingColumn: order_id
shardingAlgorithmName: t_order_db_algorith
logicTable: t_order
tableStrategy:
standard:
shardingColumn: user_id
shardingAlgorithmName: t_order_tbl_algorith
shardingAlgorithms:
t_order_db_algorith:
type: INLINE
props:
algorithm-expression: ds_$->{order_id % 2}
t_order_tbl_algorith:
type: INLINE
props:
algorithm-expression: t_order_$->{user_id % 2}
"
}
},
"target": {
"type": "jdbc",
"parameter": {
"username": "root",
"password": "root",
"jdbcUrl": "jdbc:mysql://127.0.0.1:3307/sharding_db?serverTimezone=UTC&useSSL=false"
}
}
},
"jobConfiguration":{
"concurrency":"3"
}
}'
Response：
{
"success": true,
"errorCode": 0,
"errorMsg": null,
"model": null
}
Interface description：GET /scaling/job/progress/{jobId}
Example：
curl -X GET \
http://localhost:8888/scaling/job/progress/1
Response：
{
"success": true,
"errorCode": 0,
"errorMsg": null,
"model": {
"id": 1,
"jobName": "Local Sharding Scaling Job",
"status": "RUNNING/STOPPED"
"syncTaskProgress": [{
"id": "127.0.0.1-3306-test",
"status": "PREPARING/MIGRATE_HISTORY_DATA/SYNCHRONIZE_REALTIME_DATA/STOPPING/STOPPED",
"historySyncTaskProgress": [{
"id": "history-test-t1#0",
"estimatedRows": 41147,
"syncedRows": 41147
}, {
"id": "history-test-t1#1",
"estimatedRows": 42917,
"syncedRows": 42917
}, {
"id": "history-test-t1#2",
"estimatedRows": 43543,
"syncedRows": 43543
}, {
"id": "history-test-t2#0",
"estimatedRows": 39679,
"syncedRows": 39679
}, {
"id": "history-test-t2#1",
"estimatedRows": 41483,
"syncedRows": 41483
}, {
"id": "history-test-t2#2",
"estimatedRows": 42107,
"syncedRows": 42107
}],
"realTimeSyncTaskProgress": {
"id": "realtime-test",
"delayMillisecond": 1576563771372,
"position": {
"filename": "ON.000007",
"position": 177532875,
"serverId": 0
}
}
}]
}
}
Interface description：GET /scaling/job/list
Example：
curl -X GET \
http://localhost:8888/scaling/job/list
Response：
{
"success": true,
"errorCode": 0,
"model": [
{
"jobId": 1,
"jobName": "Local Sharding Scaling Job",
"status": "RUNNING"
}
]
}
Interface description：POST /scaling/job/stop
Body：
| Parameter | Describe |
|---|---|
| jobId | job id |
Example：
curl -X POST \
http://localhost:8888/scaling/job/stop \
-H 'content-type: application/json' \
-d '{
"jobId":1
}'
Response：
{
"success": true,
"errorCode": 0,
"errorMsg": null,
"model": null
}
We provide user interface in ShardingSphere-UI, so all the operations related can be implemented with a click of the UI interface. For more information, please refer to the ShardingSphere-UI module.