You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by ji...@apache.org on 2022/11/01 14:02:35 UTC
[shardingsphere] branch master updated: Update DistSql documents (#21889)
This is an automated email from the ASF dual-hosted git repository.
jianglongtao 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 829cab13c50 Update DistSql documents (#21889)
829cab13c50 is described below
commit 829cab13c506503aa6af437661824c9f947e729d
Author: Zichao <57...@users.noreply.github.com>
AuthorDate: Wed Nov 2 03:02:20 2022 +1300
Update DistSql documents (#21889)
---
.../syntax/ral/migration/check-migration.cn.md | 44 ++++++++++++++++
.../syntax/ral/migration/check-migration.en.md | 43 ++++++++++++++++
.../syntax/ral/migration/commit-migration.cn.md | 38 ++++++++++++++
.../syntax/ral/migration/commit-migration.en.md | 38 ++++++++++++++
.../syntax/ral/migration/migrate-table-into.cn.md | 49 ++++++++++++++++++
.../syntax/ral/migration/migrate-table-into.en.md | 50 ++++++++++++++++++
.../syntax/ral/migration/rollback-migration.cn.md | 40 +++++++++++++++
.../syntax/ral/migration/rollback-migration.en.md | 40 +++++++++++++++
.../migration/show-migration-check-algorithm.cn.md | 48 +++++++++++++++++
.../migration/show-migration-check-algorithm.en.md | 50 ++++++++++++++++++
.../migration/show-migration-check-status.cn.md | 60 ++++++++++++++++++++++
.../migration/show-migration-check-status.en.md | 60 ++++++++++++++++++++++
.../syntax/ral/migration/show-migration-list.cn.md | 53 +++++++++++++++++++
.../syntax/ral/migration/show-migration-list.en.md | 52 +++++++++++++++++++
.../ral/migration/show-migration-status.cn.md | 60 ++++++++++++++++++++++
.../ral/migration/show-migration-status.en.md | 60 ++++++++++++++++++++++
.../ral/migration/start-migration-check.cn.md | 38 ++++++++++++++
.../ral/migration/start-migration-check.en.md | 38 ++++++++++++++
.../syntax/ral/migration/start-migration.cn.md | 38 ++++++++++++++
.../syntax/ral/migration/start-migration.en.md | 38 ++++++++++++++
.../ral/migration/stop-migration-check.cn.md | 38 ++++++++++++++
.../ral/migration/stop-migration-check.en.md | 38 ++++++++++++++
.../syntax/ral/migration/stop-migration.cn.md | 38 ++++++++++++++
.../syntax/ral/migration/stop-migration.en.md | 38 ++++++++++++++
24 files changed, 1089 insertions(+)
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/check-migration.cn.md b/docs/document/content/reference/distsql/syntax/ral/migration/check-migration.cn.md
new file mode 100644
index 00000000000..f4ceb8885b3
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/check-migration.cn.md
@@ -0,0 +1,44 @@
++++
+title = "CHECK MIGRATION BY"
+weight = 11
+
++++
+
+### 描述
+
+`CHECK MIGRATION BY` 语法用于校验数据迁移作业中的数据一致性
+
+### 语法
+
+```sql
+ShowMigrationList ::=
+ 'CHECK' 'MIGRATION' migrationJobId 'BY' 'TYPE' '(' 'NAME' '=' migrationCheckAlgorithmType ')'
+
+migrationJobId ::=
+ string
+
+migrationCheckAlgorithmType ::=
+ string
+```
+
+### 补充说明
+
+- `migrationJobId` 需要通过 `SHOW MIGRATION LIST` 语法查询获得
+
+- `migrationCheckAlgorithmType` 需要通过 `SHOW MIGRATION CHECK ALGORITHMS` 语法查询获得
+
+### 示例
+
+- 校验数据迁移作业中数据一致性
+
+```sql
+CHECK MIGRATION 'j01016e501b498ed1bdb2c373a2e85e2529a6' BY TYPE (NAME='CRC32_MATCH');
+```
+
+### 保留字
+
+`CHECK`、`MIGRATION`、`BY`、`TYPE`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/check-migration.en.md b/docs/document/content/reference/distsql/syntax/ral/migration/check-migration.en.md
new file mode 100644
index 00000000000..120e6ebbf82
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/check-migration.en.md
@@ -0,0 +1,43 @@
++++
+title = "CHECK MIGRATION "
+weight = 11
++++
+
+### Description
+
+The `CHECK MIGRATION LIST` syntax is used to check data consistancy in migration job.
+
+### Syntax
+
+```sql
+ShowMigrationList ::=
+ 'CHECK' 'MIGRATION' migrationJobId 'BY' 'TYPE' '(' 'NAME' '=' migrationCheckAlgorithmType ')'
+
+migrationJobId ::=
+ string
+
+migrationCheckAlgorithmType ::=
+ string
+```
+
+### Supplement
+
+- `migrationJobId` needs to be obtained through `SHOW MIGRATION LIST` syntax query
+
+- `migrationCheckAlgorithmType` needs to be obtained through `SHOW MIGRATION CHECK ALGORITHMS` syntax query
+
+### Example
+
+- check data consistancy in migration job
+
+```sql
+CHECK MIGRATION 'j01016e501b498ed1bdb2c373a2e85e2529a6' BY TYPE (NAME='CRC32_MATCH');
+```
+
+### Reserved word
+
+`CHECK`, `MIGRATION`, `BY`, `TYPE`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/commit-migration.cn.md b/docs/document/content/reference/distsql/syntax/ral/migration/commit-migration.cn.md
new file mode 100644
index 00000000000..e9507b899af
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/commit-migration.cn.md
@@ -0,0 +1,38 @@
++++
+title = "COMMIT MIGRATION"
+weight = 18
++++
+
+### 描述
+
+`COMMIT MIGRATION` 语法用于完成指定的数据迁移作业
+
+### 语法
+
+```sql
+CommitMigration ::=
+ 'COMMIT' 'MIGRATION' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### 补充说明
+
+- `migrationJobId` 需要通过 `SHOW MIGRATION LIST` 语法查询获得
+
+### 示例
+
+- 完成指定的数据迁移作业
+
+```sql
+COMMIT MIGRATION 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+### 保留字
+
+`COMMIT`、`MIGRATION`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/commit-migration.en.md b/docs/document/content/reference/distsql/syntax/ral/migration/commit-migration.en.md
new file mode 100644
index 00000000000..0d3ab5a3750
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/commit-migration.en.md
@@ -0,0 +1,38 @@
++++
+title = "COMMIT MIGRATION"
+weight = 18
++++
+
+### Description
+
+The `COMMIT MIGRATION` syntax is used to commit migration process.
+
+### Syntax
+
+```sql
+CommitMigration ::=
+ 'COMMIT' 'MIGRATION' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### Supplement
+
+- `migrationJobId` needs to be obtained through `SHOW MIGRATION LIST` syntax query
+
+### Example
+
+- Commit migration process
+
+```sql
+COMMIT MIGRATION 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+### Reserved word
+
+`COMMIT`, `MIGRATION`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/migrate-table-into.cn.md b/docs/document/content/reference/distsql/syntax/ral/migration/migrate-table-into.cn.md
new file mode 100644
index 00000000000..7a8c7a34885
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/migrate-table-into.cn.md
@@ -0,0 +1,49 @@
++++
+title = "MIGRATE TABLE INTO"
+weight = 7
++++
+
+### 描述
+
+`MIGRATE TABLE INTO` 语法用于将表从源端迁移到目标端。
+
+### 语法
+
+```sql
+MigrateTableInto ::=
+ 'MIGRATE' 'TABLE' migrationSource '.' tableName 'INTO' (databaseName '.')?tableName
+
+migrationSource ::=
+ identifier
+
+databaseName ::=
+ identifier
+
+tableName ::=
+ identifier
+```
+
+### 补充说明
+
+- 未指定 `databaseName` 时，默认是当前使用的 `DATABASE`。 如果也未使用 `DATABASE` 则会提示 `No database selected`。
+
+### 示例
+
+- 将表从源端迁移到当前逻辑库
+
+```sql
+MIGRATE TABLE ds_0.t_order INTO t_order;
+```
+
+- 将表从源端迁移到指定逻辑库
+```sql
+MIGRATE TABLE ds_0.t_order INTO sharding_db.t_order;
+```
+
+### 保留字
+
+`MIGRATE`、`TABLE`、`INTO`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/migrate-table-into.en.md b/docs/document/content/reference/distsql/syntax/ral/migration/migrate-table-into.en.md
new file mode 100644
index 00000000000..59144667860
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/migrate-table-into.en.md
@@ -0,0 +1,50 @@
++++
+title = "MIGRATE TABLE INTO"
+weight = 7
++++
+
+### Description
+
+`MIGRATE TABLE INTO` syntax is used to migration table from source to target
+
+### Syntax
+
+```sql
+MigrateTableInto ::=
+ 'MIGRATE' 'TABLE' migrationSource '.' tableName 'INTO' (databaseName '.')? tableName
+
+migrationSource ::=
+ identifier
+
+databaseName ::=
+ identifier
+
+tableName ::=
+ identifier
+```
+
+### Supplement
+
+- When `databaseName` is not specified, the default is the currently used `DATABASE`. If `DATABASE` is not used, `No database selected` will be prompted.
+
+### Example
+
+- Migrate table from source to current database
+
+```sql
+MIGRATE TABLE ds_0.t_order INTO t_order;
+```
+
+- Migrate table from source to specified database
+
+```sql
+UNREGISTER MIGRATION SOURCE STORAGE UNIT su_1, su_2;
+```
+
+### Reserved word
+
+`MIGRATE`, `TABLE`, `INTO`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/rollback-migration.cn.md b/docs/document/content/reference/distsql/syntax/ral/migration/rollback-migration.cn.md
new file mode 100644
index 00000000000..a4c8d3faf6c
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/rollback-migration.cn.md
@@ -0,0 +1,40 @@
++++
+title = "ROLLBACK MIGRATION"
+weight = 17
++++
+
+### 描述
+
+`ROLLBACK MIGRATION` 语法用于撤销指定的数据迁移作业
+
+### 语法
+
+```sql
+RollbackMigration ::=
+ 'ROLLBACK' 'MIGRATION' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### 补充说明
+
+- `migrationJobId` 需要通过 `SHOW MIGRATION LIST` 语法查询获得
+
+- 该语句执行后会清理目标端
+
+### 示例
+
+- 撤销指定的数据迁移作业
+
+```sql
+ROLLBACK MIGRATION 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+### 保留字
+
+`ROLLBACK`、`MIGRATION`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/rollback-migration.en.md b/docs/document/content/reference/distsql/syntax/ral/migration/rollback-migration.en.md
new file mode 100644
index 00000000000..c8993dafa22
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/rollback-migration.en.md
@@ -0,0 +1,40 @@
++++
+title = "ROLLBACK MIGRATION"
+weight = 17
++++
+
+### Description
+
+The `ROLLBACK MIGRATION` syntax is used to rollback migration process.
+
+### Syntax
+
+```sql
+RollbackMigration ::=
+ 'ROLLBACK' 'MIGRATION' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### Supplement
+
+- `migrationJobId` needs to be obtained through `SHOW MIGRATION LIST` syntax query
+
+- After the statement is executed, the target will be cleaned up
+
+### Example
+
+- Rollback migration process
+
+```sql
+ROLLBACK MIGRATION 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+### Reserved word
+
+`ROLLBACK`, `MIGRATION`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-check-algorithm.cn.md b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-check-algorithm.cn.md
new file mode 100644
index 00000000000..2608c3cbdf9
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-check-algorithm.cn.md
@@ -0,0 +1,48 @@
++++
+title = "SHOW MIGRATION CHECK ALGORITHM"
+weight = 10
++++
+
+### 描述
+
+`SHOW MIGRATION CHECK ALGORITHM` 语法用于查询数据迁移一致性校验算法
+### 语法
+
+```sql
+ShowMigrationCheckAlgorithm ::=
+ 'SHOW' 'MIGRATION' 'CHECK' 'ALGORITHMS'
+```
+
+### 返回值说明
+
+| 列 | 说明 |
+|-------------------------|------------------|
+|type | 一致性校验算法类型 |
+|supported_database_types | 支持数据库类型 |
+|description | 说明 |
+### 示例
+
+- 查询数据迁移一致性校验算法
+
+```sql
+SHOW MIGRATION CHECK ALGORITHMS;
+```
+
+```sql
+mysql> SHOW MIGRATION CHECK ALGORITHMS;
++-------------+--------------------------------------------------------------+----------------------------+
+| type | supported_database_types | description |
++-------------+--------------------------------------------------------------+----------------------------+
+| CRC32_MATCH | MySQL | Match CRC32 of records. |
+| DATA_MATCH | SQL92,MySQL,MariaDB,PostgreSQL,openGauss,Oracle,SQLServer,H2 | Match raw data of records. |
++-------------+--------------------------------------------------------------+----------------------------+
+2 rows in set (0.03 sec)
+```
+
+### 保留字
+
+`SHOW`、`MIGRATION`、`CHECK`、`ALGORITHMS`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-check-algorithm.en.md b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-check-algorithm.en.md
new file mode 100644
index 00000000000..43441e5adf0
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-check-algorithm.en.md
@@ -0,0 +1,50 @@
++++
+title = "SHOW MIGRATION CHECK ALGORITHM"
+weight = 10
++++
+
+### Description
+
+The `SHOW MIGRATION RULE` syntax is used to query migration check algorithm.
+
+### Syntax
+
+```sql
+ShowMigrationCheckAlgorithm ::=
+ 'SHOW' 'MIGRATION' 'CHECK' 'ALGORITHMS'
+```
+
+### Return Value Description
+
+| Column | Description |
+|--------------------------|--------------------------------------------|
+| type | migration check algorithm type |
+| supported_database_types | supported database type |
+| description | Description of migration check algorithm |
+
+### Example
+
+- Query migration check algorithm
+
+```sql
+SHOW MIGRATION CHECK ALGORITHMS;
+```
+
+```sql
+mysql> SHOW MIGRATION CHECK ALGORITHMS;
++-------------+--------------------------------------------------------------+----------------------------+
+| type | supported_database_types | description |
++-------------+--------------------------------------------------------------+----------------------------+
+| CRC32_MATCH | MySQL | Match CRC32 of records. |
+| DATA_MATCH | SQL92,MySQL,MariaDB,PostgreSQL,openGauss,Oracle,SQLServer,H2 | Match raw data of records. |
++-------------+--------------------------------------------------------------+----------------------------+
+2 rows in set (0.03 sec)
+```
+
+### Reserved word
+
+`SHOW`, `MIGRATION`, `CHECK`, `ALGORITHMS`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-check-status.cn.md b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-check-status.cn.md
new file mode 100644
index 00000000000..40b19733968
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-check-status.cn.md
@@ -0,0 +1,60 @@
++++
+title = "SHOW MIGRATION CHECK STATUS"
+weight = 12
++++
+
+### 描述
+
+`SHOW MIGRATION CHECK STATUS` 语法用于查询指定数据迁移作业的数据校验情况
+
+### 语法
+
+```sql
+ShowMigrationCheckStatus ::=
+ 'SHOW' 'MIGRATION' 'CHECK' 'STATUS' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### 补充说明
+
+- `migrationJobId` 需要通过 `SHOW MIGRATION LIST` 语法查询获得
+
+### 返回值说明
+
+| 列 | 说明 |
+|-----------------------|-------------------|
+| tables | 校验表 |
+| result | 校验结果 |
+| finished_percentage | 校验完成度 |
+| remaining_seconds | 剩余时间 |
+| check_begin_time | 校验开始时间 |
+| check_end_time | 校验结束时间 |
+| error_message | 错误信息提示 |
+
+### 示例
+
+- 查询指定数据迁移作业的数据校验情况
+
+```sql
+SHOW MIGRATION CHECK STATUS 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+```sql
+mysql> SHOW MIGRATION CHECK STATUS 'j010180026753ef0e25d3932d94d1673ba551';
++---------+--------+---------------------+-------------------+-------------------------+-------------------------+------------------+---------------+
+| tables | result | finished_percentage | remaining_seconds | check_begin_time | check_end_time | duration_seconds | error_message |
++---------+--------+---------------------+-------------------+-------------------------+-------------------------+------------------+---------------+
+| t_order | true | 100 | 0 | 2022-11-01 17:57:39.940 | 2022-11-01 17:57:40.587 | 0 | |
++---------+--------+---------------------+-------------------+-------------------------+-------------------------+------------------+---------------+
+1 row in set (0.01 sec)
+```
+
+### 保留字
+
+`SHOW`、`MIGRATION`、`CHECK`、`STATUS`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-check-status.en.md b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-check-status.en.md
new file mode 100644
index 00000000000..b69a0e62acf
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-check-status.en.md
@@ -0,0 +1,60 @@
++++
+title = "SHOW MIGRATION CHECK STATUS"
+weight = 12
++++
+
+### Description
+
+The `SHOW MIGRATION CHECK STATUS` syntax is used to query migration check status for specified migration job.
+
+### Syntax
+
+```sql
+ShowMigrationCheckStatus ::=
+ 'SHOW' 'MIGRATION' 'CHECK' 'STATUS' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### Supplement
+
+- `migrationJobId` needs to be obtained through `SHOW MIGRATION LIST` syntax query
+
+### Return Value Description
+
+| Columns | Description |
+|-----------------------|---------------------------|
+| tables | migration check table |
+| result | check result |
+| finished_percentage | check finished percentag |
+| remaining_seconds | check remaining time |
+| check_begin_time | check begin time |
+| check_end_time | check end time |
+| error_message | error message |
+
+### Example
+
+- Query migration check status
+
+```sql
+SHOW MIGRATION CHECK STATUS 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+```sql
+mysql> SHOW MIGRATION CHECK STATUS 'j010180026753ef0e25d3932d94d1673ba551';
++---------+--------+---------------------+-------------------+-------------------------+-------------------------+------------------+---------------+
+| tables | result | finished_percentage | remaining_seconds | check_begin_time | check_end_time | duration_seconds | error_message |
++---------+--------+---------------------+-------------------+-------------------------+-------------------------+------------------+---------------+
+| t_order | true | 100 | 0 | 2022-11-01 17:57:39.940 | 2022-11-01 17:57:40.587 | 0 | |
++---------+--------+---------------------+-------------------+-------------------------+-------------------------+------------------+---------------+
+1 row in set (0.01 sec)
+```
+
+### Reserved word
+
+`SHOW`, `MIGRATION`, `CHECK`, `STATUS`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-list.cn.md b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-list.cn.md
new file mode 100644
index 00000000000..a8884ceee79
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-list.cn.md
@@ -0,0 +1,53 @@
++++
+title = "SHOW MIGRATION LIST"
+weight = 8
+
++++
+
+### 描述
+
+`SHOW MIGRATION LIST` 语法用于查询数据迁移作业列表
+
+### 语法
+
+```sql
+ShowMigrationList ::=
+ 'SHOW' 'MIGRATION' 'LIST'
+```
+
+### 返回值说明
+
+| 列 | 说明 |
+|----------------|----------------------------|
+| id | 数据迁移作业ID |
+| tables | 迁移表 |
+| job_item_count | 数据迁移作业分片数量 |
+| active | 数据迁移作业状态 |
+| create_time | 数据迁移作业创建时间 |
+| stop_time | 数据迁移作业停止时间 |
+
+### 示例
+
+- 查询数据迁移作业列表
+
+```sql
+SHOW MIGRATION LIST;
+```
+
+```sql
+mysql> SHOW MIGRATION LIST;
++---------------------------------------+---------+----------------+--------+---------------------+---------------------+
+| id | tables | job_item_count | active | create_time | stop_time |
++---------------------------------------+---------+----------------+--------+---------------------+---------------------+
+| j01013a38b0184e07c864627b5bb05da09ee0 | t_order | 1 | false | 2022-10-31 18:18:24 | 2022-10-31 18:18:31 |
++---------------------------------------+---------+----------------+--------+---------------------+---------------------+
+1 row in set (0.28 sec)
+```
+
+### 保留字
+
+`SHOW`、`MIGRATION`、`LIST`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-list.en.md b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-list.en.md
new file mode 100644
index 00000000000..61e58b0c2b9
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-list.en.md
@@ -0,0 +1,52 @@
++++
+title = "SHOW MIGRATION LIST"
+weight = 8
++++
+
+### Description
+
+The `SHOW MIGRATION LIST` syntax is used to query migration job list.
+
+### Syntax
+
+```sql
+ShowMigrationList ::=
+ 'SHOW' 'MIGRATION' 'LIST'
+```
+
+### Return Values Description
+
+| Columns | Description |
+|----------------|--------------------------------|
+| id | migration job id |
+| tables | migration tables |
+| job_item_count | migration job sharding number |
+| active | migration job states |
+| create_time | migration job create time |
+| stop_time | migration job stop time |
+
+### Example
+
+- Query migration job list
+
+```sql
+SHOW MIGRATION LIST;
+```
+
+```sql
+mysql> SHOW MIGRATION LIST;
++---------------------------------------+---------+----------------+--------+---------------------+---------------------+
+| id | tables | job_item_count | active | create_time | stop_time |
++---------------------------------------+---------+----------------+--------+---------------------+---------------------+
+| j01013a38b0184e07c864627b5bb05da09ee0 | t_order | 1 | false | 2022-10-31 18:18:24 | 2022-10-31 18:18:31 |
++---------------------------------------+---------+----------------+--------+---------------------+---------------------+
+1 row in set (0.28 sec)
+```
+
+### Reserved word
+
+`SHOW`, `MIGRATION`, `LIST`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-status.cn.md b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-status.cn.md
new file mode 100644
index 00000000000..6f36c63d6fe
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-status.cn.md
@@ -0,0 +1,60 @@
++++
+title = "SHOW MIGRATION STATUS"
+weight = 9
++++
+
+### 描述
+
+`SHOW MIGRATION STATUS` 语法用于查询指定数据迁移作业的详细情况
+
+### 语法
+
+```sql
+ShowMigrationStatus ::=
+ 'SHOW' 'MIGRATION' 'STATUS' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### 补充说明
+
+- `migrationJobId` 需要通过 `SHOW MIGRATION LIST` 语法查询获得
+
+### 返回值说明
+
+| 列 | 说明 |
+|--------------------------------|-------------------|
+| item | 数据迁移作业分片编号 |
+| data source | 数据迁移源 |
+| status | 数据迁移作业状态 |
+| processed_records_count | 处理数据行数 |
+| inventory_finished_percentage | 数据迁移作业完成度 |
+| incremental_idle_seconds | 增量闲置时间 |
+| error_message | 错误信息提示 |
+
+### 示例
+
+- 查询指定数据迁移作业的详细情况
+
+```sql
+SHOW MIGRATION STATUS 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+```sql
+mysql> SHOW MIGRATION STATUS 'j010180026753ef0e25d3932d94d1673ba551';
++------+-------------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
+| item | data_source | status | active | processed_records_count | inventory_finished_percentage | incremental_idle_seconds | error_message |
++------+-------------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
+| 0 | su_1 | EXECUTE_INCREMENTAL_TASK | true | 6 | 100 | 25 | |
++------+-------------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
+1 row in set (0.01 sec)
+```
+
+### 保留字
+
+`SHOW`、`MIGRATION`、`STATUS`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-status.en.md b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-status.en.md
new file mode 100644
index 00000000000..353ff459d12
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/show-migration-status.en.md
@@ -0,0 +1,60 @@
++++
+title = "SHOW MIGRATION STATUS"
+weight = 9
++++
+
+### Description
+
+The `SHOW MIGRATION STATUS` syntax is used to query migration job status for specified migration job.
+
+### Syntax
+
+```sql
+ShowMigrationStatus ::=
+ 'SHOW' 'MIGRATION' 'STATUS' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### Supplement
+
+- `migrationJobId` needs to be obtained through `SHOW MIGRATION LIST` syntax query
+
+### Return Value Description
+
+| column | Description |
+|--------------------------------|--------------------------------------|
+| item | migration job sharding serial number |
+| data source | migration source |
+| status | migration job status |
+| processed_records_count | number of processed rows |
+| inventory_finished_percentage | finished percentage of migration job |
+| incremental_idle_seconds | incremental idle time |
+| error_message | error message |
+
+### Example
+
+- Query migration job status
+
+```sql
+SHOW MIGRATION STATUS 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+```sql
+mysql> SHOW MIGRATION STATUS 'j010180026753ef0e25d3932d94d1673ba551';
++------+-------------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
+| item | data_source | status | active | processed_records_count | inventory_finished_percentage | incremental_idle_seconds | error_message |
++------+-------------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
+| 0 | su_1 | EXECUTE_INCREMENTAL_TASK | true | 6 | 100 | 25 | |
++------+-------------+--------------------------+--------+-------------------------+-------------------------------+--------------------------+---------------+
+1 row in set (0.01 sec)
+```
+
+### Reserved word
+
+`SHOW`, `MIGRATION`, `STATUS`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/start-migration-check.cn.md b/docs/document/content/reference/distsql/syntax/ral/migration/start-migration-check.cn.md
new file mode 100644
index 00000000000..a671d719d8d
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/start-migration-check.cn.md
@@ -0,0 +1,38 @@
++++
+title = "START MIGRATION CHECK"
+weight = 14
++++
+
+### 描述
+
+`START MIGRATION CHECK` 语法用于开始指定数据迁移作业的数据校验
+
+### 语法
+
+```sql
+StartMigrationCheck ::=
+ 'START' 'MIGRATION' 'CHECK' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### 补充说明
+
+- `migrationJobId` 需要通过 `SHOW MIGRATION LIST` 语法查询获得
+
+### 示例
+
+- 开始指定数据迁移作业的数据校验
+
+```sql
+START MIGRATION CHECK 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+### 保留字
+
+`START`、`MIGRATION`、`CHECK`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/start-migration-check.en.md b/docs/document/content/reference/distsql/syntax/ral/migration/start-migration-check.en.md
new file mode 100644
index 00000000000..a57af6db58a
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/start-migration-check.en.md
@@ -0,0 +1,38 @@
++++
+title = "START MIGRATION CHECK"
+weight = 14
++++
+
+### Description
+
+The `START MIGRATION CHECK` syntax is used to stop migration check process.
+
+### Syntax
+
+```sql
+StartMigrationCheck ::=
+ 'START' 'MIGRATION' 'CHECK' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### Supplement
+
+- `migrationJobId` needs to be obtained through `SHOW MIGRATION LIST` syntax query
+
+### Example
+
+- Stop migration check process
+
+```sql
+START MIGRATION CHECK 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+### Reserved word
+
+`START`, `MIGRATION`, `CHECK`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/start-migration.cn.md b/docs/document/content/reference/distsql/syntax/ral/migration/start-migration.cn.md
new file mode 100644
index 00000000000..6bc20c67a21
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/start-migration.cn.md
@@ -0,0 +1,38 @@
++++
+title = "START MIGRATION"
+weight = 16
++++
+
+### 描述
+
+`START MIGRATION` 语法用于开始指定的数据迁移作业
+
+### 语法
+
+```sql
+StartMigration ::=
+ 'START' 'MIGRATION' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### 补充说明
+
+- `migrationJobId` 需要通过 `SHOW MIGRATION LIST` 语法查询获得
+
+### 示例
+
+- 停止指定的数据迁移作业
+
+```sql
+START MIGRATION 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+### 保留字
+
+`START`、`MIGRATION`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/start-migration.en.md b/docs/document/content/reference/distsql/syntax/ral/migration/start-migration.en.md
new file mode 100644
index 00000000000..04c132c108c
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/start-migration.en.md
@@ -0,0 +1,38 @@
++++
+title = "START MIGRATION"
+weight = 16
++++
+
+### Description
+
+The `START MIGRATION` syntax is used to start migration process.
+
+### Syntax
+
+```sql
+StartMigration ::=
+ 'START' 'MIGRATION' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### Supplement
+
+- `migrationJobId` needs to be obtained through `SHOW MIGRATION LIST` syntax query
+
+### Example
+
+- Start migration process
+
+```sql
+START MIGRATION 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+### Reserved word
+
+`START`, `MIGRATION`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/stop-migration-check.cn.md b/docs/document/content/reference/distsql/syntax/ral/migration/stop-migration-check.cn.md
new file mode 100644
index 00000000000..c819ac8fea4
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/stop-migration-check.cn.md
@@ -0,0 +1,38 @@
++++
+title = "STOP MIGRATION CHECK"
+weight = 13
++++
+
+### 描述
+
+`STOP MIGRATION CHECK` 语法用于停止指定数据迁移作业的数据校验
+
+### 语法
+
+```sql
+StopMigrationCheck ::=
+ 'STOP' 'MIGRATION' 'CHECK' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### 补充说明
+
+- `migrationJobId` 需要通过 `SHOW MIGRATION LIST` 语法查询获得
+
+### 示例
+
+- 停止指定数据迁移作业的数据校验
+
+```sql
+STOP MIGRATION CHECK 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+### 保留字
+
+`STOP`、`MIGRATION`、`CHECK`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/stop-migration-check.en.md b/docs/document/content/reference/distsql/syntax/ral/migration/stop-migration-check.en.md
new file mode 100644
index 00000000000..e8ee82b49b3
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/stop-migration-check.en.md
@@ -0,0 +1,38 @@
++++
+title = "STOP MIGRATION CHECK"
+weight = 13
++++
+
+### Description
+
+The `STOP MIGRATION CHECK` syntax is used to stop migration check process.
+
+### Syntax
+
+```sql
+StopMigrationCheck ::=
+ 'STOP' 'MIGRATION' 'CHECK' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### Supplement
+
+- `migrationJobId` needs to be obtained through `SHOW MIGRATION LIST` syntax query
+
+### Example
+
+- Stop migration check process
+
+```sql
+STOP MIGRATION CHECK 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+### Reserved word
+
+`STOP`, `MIGRATION`, `CHECK`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/stop-migration.cn.md b/docs/document/content/reference/distsql/syntax/ral/migration/stop-migration.cn.md
new file mode 100644
index 00000000000..f072a4813d2
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/stop-migration.cn.md
@@ -0,0 +1,38 @@
++++
+title = "STOP MIGRATION"
+weight = 15
++++
+
+### 描述
+
+`STOP MIGRATION` 语法用于停止指定的数据迁移作业
+
+### 语法
+
+```sql
+StopMigration ::=
+ 'STOP' 'MIGRATION' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### 补充说明
+
+- `migrationJobId` 需要通过 `SHOW MIGRATION LIST` 语法查询获得
+
+### 示例
+
+- 停止指定的数据迁移作业
+
+```sql
+STOP MIGRATION 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+### 保留字
+
+`STOP`、`MIGRATION`
+
+### 相关链接
+
+- [保留字](/cn/reference/distsql/syntax/reserved-word/)
\ No newline at end of file
diff --git a/docs/document/content/reference/distsql/syntax/ral/migration/stop-migration.en.md b/docs/document/content/reference/distsql/syntax/ral/migration/stop-migration.en.md
new file mode 100644
index 00000000000..523404253b6
--- /dev/null
+++ b/docs/document/content/reference/distsql/syntax/ral/migration/stop-migration.en.md
@@ -0,0 +1,38 @@
++++
+title = "STOP MIGRATION"
+weight = 15
++++
+
+### Description
+
+The `STOP MIGRATION` syntax is used to stop migration process.
+
+### Syntax
+
+```sql
+StopMigration ::=
+ 'STOP' 'MIGRATION' ' migrationJobId
+
+migrationJobId ::=
+ string
+```
+
+### Supplement
+
+- `migrationJobId` needs to be obtained through `SHOW MIGRATION LIST` syntax query
+
+### Example
+
+- Stop migration process
+
+```sql
+STOP MIGRATION 'j010180026753ef0e25d3932d94d1673ba551';
+```
+
+### Reserved word
+
+`STOP`, `MIGRATION`
+
+### Related links
+
+- [Reserved word](/en/reference/distsql/syntax/reserved-word/)