Skip to content
This repository has been archived by the owner on Jan 3, 2025. It is now read-only.

zh: add files about manage task #90

Merged
merged 35 commits into from
May 25, 2020
Merged
Show file tree
Hide file tree
Changes from 33 commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
37e708e
add task manage for special week
GMHDBJD May 21, 2020
53efd1a
minor change
GMHDBJD May 21, 2020
ffb8a4a
rename file
GMHDBJD May 21, 2020
f07bc32
rename file
GMHDBJD May 21, 2020
59064ee
minor change
GMHDBJD May 21, 2020
1fbf68b
minor change
GMHDBJD May 21, 2020
9afdd2d
fix CI
GMHDBJD May 21, 2020
e0643fd
fix CI
GMHDBJD May 21, 2020
fa3a358
address comment
GMHDBJD May 21, 2020
2991fc6
minor change
GMHDBJD May 21, 2020
82e23ab
Update skip-or-replace-abnormal-sql-statements.md
GMHDBJD May 21, 2020
30f479e
Update zh/create-task.md
GMHDBJD May 22, 2020
5fdfe82
address comment
GMHDBJD May 22, 2020
6891c11
address comment
GMHDBJD May 22, 2020
4a2450f
update TOC
GMHDBJD May 22, 2020
540649d
address comment
GMHDBJD May 22, 2020
6b0cc3a
Update TOC.md
GMHDBJD May 22, 2020
38dd1d7
add query-status and query-error in TOC
GMHDBJD May 22, 2020
cabd71d
Merge remote-tracking branch 'upstream/docs-special-week' into sw-tas…
GMHDBJD May 25, 2020
9309d76
fix toc
GMHDBJD May 25, 2020
d07f038
Update zh/query-error.md
toutdesuite May 25, 2020
c8da0cd
Update zh/query-status.md
toutdesuite May 25, 2020
4e700df
rm manage-replication-tasks.md
GMHDBJD May 25, 2020
18fb2c2
fix CI
GMHDBJD May 25, 2020
b991023
fix CI
toutdesuite May 25, 2020
5342ce2
address comment
GMHDBJD May 25, 2020
e535a99
Merge branch 'docs-special-week' into sw-task-manage
WangXiangUSTC May 25, 2020
1ef152d
fix bug
GMHDBJD May 25, 2020
8f47ed0
update TOC
GMHDBJD May 25, 2020
e94e7ce
add dmctl-intro.md
GMHDBJD May 25, 2020
4863013
Merge branch 'docs-special-week' into sw-task-manage
GMHDBJD May 25, 2020
a6f99ba
Update zh/dmctl-intro.md
GMHDBJD May 25, 2020
cc9cf1f
rename file
GMHDBJD May 25, 2020
7bb0e5d
Update TOC.md
GMHDBJD May 25, 2020
34889d0
address comment
GMHDBJD May 25, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions zh/TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,17 @@
- [版本升级](dm-upgrade.md)
- [扩缩容](scale-a-dm-cluster.md)
- [重启集群](cluster-operations.md#重启集群组件)
+ 任务管理 参考 [任务前置检查](precheck.md),[任务状态查询](query-status.md),[跳过或替代执行异常的 SQL 语句](skip-or-replace-abnormal-sql-statements.md)
- 创建 [参考](manage-replication-tasks.md##创建数据同步任务)
- 查询 [参考](manage-replication-tasks.md#查询数据同步任务状态)
- 暂停 [参考](manage-replication-tasks.md#暂停数据同步任务)
- 重启
- 删除
+ 任务管理
- [dmctl 使用简介](dmctl-intro.md)
- [管理上游数据源](manage-source.md)
- [任务前置检查](precheck.md)
- [创建任务](create-task.md)
- [查询状态](query-status.md)
- [查询错误](query-error.md)
- [暂停任务](pause-task.md)
- [恢复任务](resume-task.md)
- [停止任务](stop-task.md)
- [跳过或替代执行异常的 SQL 语句](skip-or-replace-abnormal-sql-statements.md)
- [手动处理 Sharding DDL Lock](manually-handling-sharding-ddl-locks.md)
- [告警处理](handle-alerts.md)
- [日常巡检](daily-check.md)
Expand Down
4 changes: 2 additions & 2 deletions zh/config-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ category: reference

具体步骤如下:

1. [使用 dmctl 将数据源配置加载到 DM 集群](manage-replication-tasks.md#加载数据源配置)
1. [使用 dmctl 将数据源配置加载到 DM 集群](manage-source.md#加载数据源配置)
2. 参考[任务配置文件](task-configuration-file.md)来创建 `your_task.yaml` 文件。
3. [使用 dmctl 创建数据同步任务](manage-replication-tasks.md#创建数据同步任务)。
3. [使用 dmctl 创建数据同步任务](create-task.md)。

### 关键概念

Expand Down
69 changes: 69 additions & 0 deletions zh/create-task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
title: 创建数据同步任务
summary: 了解 TiDB Data Migration 如何创建数据同步任务。
category: reference
---

# 创建数据同步任务

`start-task` 命令用于创建数据同步任务。当数据同步任务启动时,DM 将[自动对相应权限和配置进行前置检查](precheck.md)。

{{< copyable "" >}}

```bash
help start-task
```

```
start a task as defined in the config file

Usage:
dmctl start-task [-s source ...] <config-file> [flags]

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

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

## 命令用法示例

{{< copyable "" >}}

```bash
start-task [ -s "mysql-replica-01"] ./task.yaml
```

## 参数解释

+ `-s`:
- 可选
- 指定在特定的一个 MySQL 源上执行 `task.yaml`
- 如果设置,则只启动指定任务在该 MySQL 源上的子任务
+ `config-file`:
- 必选
- 指定 `task.yaml` 的文件路径

## 返回结果示例

{{< copyable "" >}}

```bash
start-task task.yaml
```

```
{
"result": true,
"msg": "",
"sources": [
{
"result": true,
"msg": "",
"source": "mysql-replica-01",
"worker": "worker1"
}
]
}
```
110 changes: 110 additions & 0 deletions zh/dmctl-introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
title: dmctl 使用简介
summary: 了解如何使用 dmctl 管理数据同步任务。
category: reference
---

# dmctl 使用简介

dmctl 是用来控制 DM 集群的命令行工具。对于用 DM-Ansible 部署的 DM 集群,dmctl 二进制文件路径为 `dm-ansible/dmctl`。

dmctl 支持交互模式用于人工操作,同时也支持命令模式用于脚本。

## dmctl 交互模式

进入交互模式,与 DM-master 进行交互:

{{< copyable "shell-regular" >}}

```bash
./dmctl -master-addr 172.16.30.14:8261
```

```
Welcome to dmctl
Release Version: v1.0.1
Git Commit Hash: e63c6cdebea0edcf2ef8c91d84cff4aaa5fc2df7
Git Branch: release-1.0
UTC Build Time: 2019-09-10 06:15:05
Go Version: go version go1.12 linux/amd64

» help
DM control

Usage:
dmctl [command]

Available Commands:
check-task check the config file of the task
help help about any command
migrate-relay migrate DM-worker's relay unit
offline-worker offline worker which has been closed
operate-source create/update/stop upstream MySQL/MariaDB source
pause-relay pause DM-worker's relay unit
pause-task pause a specified running task
purge-relay purge relay log files of the DM-worker according to the specified filename
query-error query task error
query-status query task status
resume-relay resume DM-worker's relay unit
resume-task resume a specified paused task
show-ddl-locks show un-resolved DDL locks
sql-inject inject (limited) SQLs into binlog replication unit as binlog events
sql-replace replace SQLs matched by a specific binlog position (binlog-pos) or a SQL pattern (sql-pattern); each SQL must end with a semicolon
sql-skip skip the binlog event matched by a specific binlog position (binlog-pos) or a SQL pattern (sql-pattern)
start-task start a task as defined in the config file
stop-task stop a specified task
switch-relay-master switch the master server of the DM-worker's relay unit
unlock-ddl-lock forcefully unlock DDL lock
update-master-config update the config of the DM-master
update-relay update the relay unit config of the DM-worker
update-task update a task's config for routes, filters, or black-white-list

Flags:
-h, --help help for dmctl
-s, --source strings MySQL Source ID

Use `dmctl [command] --help` to get more information about a command.
```

## dmctl 命令模式

命令模式跟交互模式的区别是,执行命令时只需要在 dmctl 命令后紧接着执行任务操作,任务操作同交互模式的参数一致。

> **注意:**
>
> + 一条 dmctl 命令只能跟一个任务操作
> + 任务操作只能放在 dmctl 命令的最后

{{< copyable "shell-regular" >}}

```bash
./dmctl -master-addr 172.16.30.14:8261 start-task task.yaml
./dmctl -master-addr 172.16.30.14:8261 stop-task task
./dmctl -master-addr 172.16.30.14:8261 query-status
```

```
Available Commands:
check-task check-task <config-file>
migrate-relay migrate-relay <source> <binlogName> <binlogPos>
offline-worker offline-worker <name> <address>
operate-source operate-source <operate-type> <config-file>
pause-relay pause-relay <-s source ...>
pause-task pause-task [-s source ...] <task-name>
purge-relay purge-relay <-s source> [--filename] [--sub-dir]
query-error query-error [-s source ...] [task-name]
query-status query-status [-s source ...] [task-name] [--more]
resume-relay resume-relay <-s source ...>
resume-task resume-task [-s source ...] <task-name>
show-ddl-locks show-ddl-locks [-s source ...] [task-name]
sql-inject sql-inject <-s source> <task-name> <sql1;sql2;>
sql-replace sql-replace <-s source> [-b binlog-pos] [-p sql-pattern] [--sharding] <task-name> <sql1;sql2;>
sql-skip sql-skip <-s source> [-b binlog-pos] [-p sql-pattern] [--sharding] <task-name>
start-task start-task [-s source ...] <config-file>
stop-task stop-task [-s source ...] <task-name>
switch-relay-master switch-relay-master <-s source ...>
unlock-ddl-lock unlock-ddl-lock [-s source ...] <lock-ID>
update-master-config update-master-config <config-file>
update-relay update-relay [-s source ...] <config-file>
update-task update-task [-s source ...] <config-file>
```
Loading