Important

You are viewing the documentation of TiDB v6.0 (DMR). PingCAP does not provide bug fixes for v6.0. Any bugs will be fixed in future releases.

For general purposes, please use the latest LTS version of the TiDB database.

Stop a Data Migration Task

You can use the stop-task command to stop a data migration task. For differences between stop-task and pause-task, refer to Pause a Data Migration Task.

help stop-task
stop a specified task

Usage:
 dmctl stop-task [-s source ...] <task-name | task-file> [flags]

Flags:
 -h, --help   help for stop-task

Global Flags:
 -s, --source strings   MySQL Source ID

Usage example

stop-task [-s "mysql-replica-01"]  task-name

Flags description

  • -s: (Optional) Specifies the MySQL source where the subtasks of the migration task (that you want to stop) run. If it is set, only subtasks on the specified MySQL source are stopped.
  • task-name | task-file: (Required) Specifies the task name or task file path.

Returned results

stop-task test
{
    "op": "Stop",
    "result": true,
    "msg": "",
    "sources": [
        {
            "result": true,
            "msg": "",
            "source": "mysql-replica-01",
            "worker": "worker1"
        }
    ]
}
Was this page helpful?