Query Task Status in TiDB Data Migration
This document introduces how to use the query-status command to query the task status, and the subtask status of DM.
Query result
It is recommended that you use query-status by the following steps:
- Use
query-statusto check whether each on-going task is in the normal state. - If any error occurs in a task, use the
query-status <taskName>command to see detailed error information.<taskName>in this command indicates the name of the task that encounters the error.
A successful query result is as follows:
» query-status
{
"result": true,
"msg": "",
"tasks": [
{
"taskName": "test",
"taskStatus": "Running",
"sources": [
"mysql-replica-01",
"mysql-replica-02"
]
},
{
"taskName": "test2",
"taskStatus": "Paused",
"sources": [
"mysql-replica-01",
"mysql-replica-02"
]
}
]
}
Some fields in the query result are described as follows:
result: Whether the query is successful.msg: The error message returned when the query fails.tasks: The list of migration tasks. Each task contains the following fields:taskName: The name of the task.taskStatus: The status of the task. For detailed descriptions oftaskStatus, refer to Task status.sources: The list of upstream MySQL databases.
Task status
The status of a DM migration task depends on the status of each subtask assigned to DM-worker. For detailed descriptions of subtask status, see Subtask status. The table below shows how the subtask status is related to task status.
| Subtask status in a task | Task status |
|---|---|
One subtask is in the paused state and error information is returned. | Error - Some error occurred in subtask |
One subtask in the Sync phase is in the Running state but its Relay processing unit is not running (in the Error/Paused/Stopped state). | Error - Relay status is Error/Paused/Stopped |
One subtask is in the Paused state and no error information is returned. | Paused |
All subtasks are in the New state. | New |
All subtasks are in the Finished state. | Finished |
All subtasks are in the Stopped state. | Stopped |
| Other situations | Running |
Detailed query result
» query-status test
{
"result": true,
"msg": "",
"sources": [
{
"result": true,
"msg": "",
"sourceStatus": {
"source": "mysql-replica-01",
"worker": "worker1",
"result": null,
"relayStatus": null
},
"subTaskStatus": [
{
"name": "test",
"stage": "Running",
"unit": "Sync",
"result": null,
"unresolvedDDLLockID": "test-`test`.`t_target`",
"sync": {
"masterBinlog": "(bin.000001, 3234)",
"masterBinlogGtid": "c0149e17-dff1-11e8-b6a8-0242ac110004:1-14",
"syncerBinlog": "(bin.000001, 2525)",
"syncerBinlogGtid": "",
"blockingDDLs": [
"USE `test`; ALTER TABLE `test`.`t_target` DROP COLUMN `age`;"
],
"unresolvedGroups": [
{
"target": "`test`.`t_target`",
"DDLs": [
"USE `test`; ALTER TABLE `test`.`t_target` DROP COLUMN `age`;"
],
"firstPos": "(bin|000001.000001, 3130)",
"synced": [
"`test`.`t2`"
"`test`.`t3`"
"`test`.`t1`"
],
"unsynced": [
]
}
],
"synced": false,
"totalRows": "12",
"totalRps": "1",
"recentRps": "1"
}
}
]
},
{
"result": true,
"msg": "",
"sourceStatus": {
"source": "mysql-replica-02",
"worker": "worker2",
"result": null,
"relayStatus": null
},
"subTaskStatus": [
{
"name": "test",
"stage": "Running",
"unit": "Load",
"result": null,
"unresolvedDDLLockID": "",
"load": {
"finishedBytes": "115",
"totalBytes": "452",
"progress": "25.44 %",
"bps": "2734"
}
}
]
},
{
"result": true,
"sourceStatus": {
"source": "mysql-replica-03",
"worker": "worker3",
"result": null,
"relayStatus": null
},
"subTaskStatus": [
{
"name": "test",
"stage": "Paused",
"unit": "Load",
"result": {
"isCanceled": false,
"errors": [
{
"Type": "ExecSQL",
"msg": "Error 1062: Duplicate entry '1155173304420532225' for key 'PRIMARY'\n/home/jenkins/workspace/build_dm/go/src/github.com/pingcap/tidb-enterprise-tools/loader/db.go:160: \n/home/jenkins/workspace/build_dm/go/src/github.com/pingcap/tidb-enterprise-tools/loader/db.go:105: \n/home/jenkins/workspace/build_dm/go/src/github.com/pingcap/tidb-enterprise-tools/loader/loader.go:138: file test.t1.sql"
}
],
"detail": null
},
"unresolvedDDLLockID": "",
"load": {
"finishedBytes": "0",
"totalBytes": "156",
"progress": "0.00 %",
"bps": "0"
}
}
]
},
{
"result": true,
"msg": "",
"sourceStatus": {
"source": "mysql-replica-04",
"worker": "worker4",
"result": null,
"relayStatus": null
},
"subTaskStatus": [
{
"name": "test",
"stage": "Running",
"unit": "Dump",
"result": null,
"unresolvedDDLLockID": "",
"dump": {
"totalTables": "10",
"completedTables": "3",
"finishedBytes": "2542",
"finishedRows": "32",
"estimateTotalRows": "563",
"progress": "30.52 %",
"bps": "445"
}
}
]
},
]
}
Some fields in the returned result are described as follows:
result: Whether the query is successful.msg: The error message returned when the query fails.sources: The list of upstream MySQL instances. Each source contains the following fields:resultmsgsourceStatus: The information of the upstream MySQL databases.subTaskStatus: The information of all subtasks of upstream MySQL databases. Each subtask might contain the following fields:name: The name of the subtask.stage: The status of the subtask. For the status description and status switch relationship of "stage" of "subTaskStatus" of "sources", see the subtask status.unit: The processing unit of DM, including "Check", "Dump", "Load", and "Sync".result: Displays the error information if a subtask fails.unresolvedDDLLockID: The sharding DDL lock ID, used for manually handling the sharding DDL lock in the abnormal condition. For operation details of "unresolvedDDLLockID" of "subTaskStatus" of "sources", see Handle Sharding DDL Locks Manually.sync: The replication information of theSyncprocessing unit. This information is about the same component with the current processing unit.masterBinlog: The binlog position in the upstream database.masterBinlogGtid: The GTID information in the upstream database.syncerBinlog: The position of the binlog that has been replicated in theSyncprocessing unit.syncerBinlogGtid: The binlog position replicated using GTID.blockingDDLs: The DDL list that is blocked currently. It is not empty only when all the upstream tables of this DM-worker are in the "synced" status. In this case, it indicates the sharding DDL statements to be executed or that are skipped.unresolvedGroups: The sharding group that is not resolved. Each group contains the following fields:target: The downstream database table to be replicated.DDLs: A list of DDL statements.firstPos: The starting position of the sharding DDL statement.synced: The upstream sharded table whose executed sharding DDL statement has been read by theSyncunit.unsynced: The upstream table that has not executed this sharding DDL statement. If any upstream tables have not finished replication,blockingDDLsis empty.
synced: Whether the incremental replication catches up with the upstream and has the same binlog position as that in the upstream. The save point is not refreshed in real time in theSyncbackground, sofalseofsynceddoes not always mean a replication delay exits.totalRows: The total number of rows that are replicated in this subtask.totalRps: The number of rows that are replicated in this subtask per second.recentRps: The number of rows that are replicated in this subtask in the last second.
load: The replication information of theLoadprocessing unit.finishedBytes: The number of bytes that have been loaded.totalBytes: The total number of bytes that need to be loaded.progress: The progress of the loading process.bps: The speed of the full loading.
dump: The replication information of theDumpprocessing unit.totalTables: The number of tables to be dumped.completedTables: The number of tables that have been dumped.finishedBytes: The number of bytes that have been dumped.finishedRows: The number of rows that have been dumped.estimateTotalRows: The estimated number of rows to be dumped.progress: The progress of the dumping process.bps: The dumping speed in bytes/second.
Subtask status
Status description
New:- The initial status.
- If the subtask does not encounter an error, it is switched to
Running; otherwise it is switched toPaused.
Running: The normal running status.Paused:- The paused status.
- If the subtask encounters an error, it is switched to
Paused. - If you run
pause-taskwhen the subtask is in theRunningstatus, the task is switched toPaused. - When the subtask is in this status, you can run the
resume-taskcommand to resume the task.
Stopped:- The stopped status.
- If you run
stop-taskwhen the subtask is in theRunningorPausedstatus, the task is switched toStopped. - When the subtask is in this status, you cannot use
resume-taskto resume the task.
Finished:- The finished subtask status.
- Only when the full replication subtask is finished normally, the task is switched to this status.
Status switch diagram
error occurs
New --------------------------------|
| |
| resume-task |
| |----------------------------| |
| | | |
| | | |
v v error occurs | v
Finished <-------------- Running -----------------------> Paused
^ | or pause-task |
| | |
start task | | stop task |
| | |
| v stop task |
Stopped <-------------------------|