手动处理 Sharding DDL Lock
DM (Data Migration) 使用 sharding DDL lock 来确保分库分表的 DDL 操作可以正确执行。绝大多数情况下，该锁定机制可自动完成；但在部分异常情况发生时，需要使用 unlock-ddl-lock/break-ddl-lock 手动处理异常的 DDL lock。
命令介绍
show-ddl-locks
该命令用于查询当前 DM-master 上存在的 DDL lock 信息。
命令示例
show-ddl-locks [--worker=127.0.0.1:8262] [task-name]
参数解释
worker：- flag 参数，string，
--worker，可选 - 不指定时，查询所有 DM-worker 相关的 lock 信息；指定时，仅查询与这组 DM-worker 相关的 lock 信息，可重复多次指定
- flag 参数，string，
task-name：- 非 flag 参数，string，可选
- 不指定时，查询与所有任务相关的 lock 信息；指定时，仅查询特定任务相关的 lock 信息
返回结果示例
show-ddl-locks test
{
"result": true, # 查询 lock 操作本身是否成功
"msg": "", # 查询 lock 操作失败时的原因或其它描述信息（如不存在任务 lock）
"locks": [ # DM-master 上存在的 lock 信息列表
{
"ID": "test-`shard_db`.`shard_table`", # lock 的 ID 标识，当前由任务名与 DDL 对应的 schema/table 信息组成
"task": "test", # lock 所属的任务名
"owner": "127.0.0.1:8262", # lock 的 owner（第一个遇到该 DDL 的 DM-worker）
"DDLs": [ # lock 对应的 DDL 列表
"USE `shard_db`; ALTER TABLE `shard_db`.`shard_table` DROP COLUMN `c2`;"
],
"synced": [ # 已经收到对应 MySQL 实例内所有分表 DDL 的 DM-worker 列表
"127.0.0.1:8262"
],
"unsynced": [ # 尚未收到对应 MySQL 实例内所有分表 DDL 的 DM-worker 列表
"127.0.0.1:8263"
]
}
]
}
unlock-ddl-lock
该命令用于主动请求 DM-master 解除指定的 DDL lock，包括的操作：请求 owner 执行 DDL 操作，请求其他非 owner 的 DM-worker 跳过 DDL 操作，移除 DM-master 上的 lock 信息。
命令示例
unlock-ddl-lock [--worker=127.0.0.1:8262] [--owner] [--force-remove] <lock-ID>
参数解释
worker：- flag 参数，string，
--worker，可选 - 不指定时，对所有已经在等待该 lock 的 DM-worker 发起跳过 DDL 操作请求；指定时，仅对这组 DM-worker 发起跳过 DDL 操作请求，可重复多次指定
- flag 参数，string，
owner：- flag 参数，string，
--owner，可选 - 不指定时，请求默认的 owner（
show-ddl-locks返回结果中的owner）执行 DDL 操作；指定时，请求该 DM-worker（替代默认的 owner）执行 DDL 操作
- flag 参数，string，
force-remove：- flag 参数，boolean，
--force-remove，可选 - 不指定时，仅在 owner 执行 DDL 成功时移除 lock 信息；指定时，即使 owner 执行 DDL 失败也强制移除 lock 信息（此后将无法再次查询或操作该 lock）
- flag 参数，boolean，
lock-ID：- 非 flag 参数，string，必选
- 指定需要执行 unlock 操作的 DDL lock ID（即
show-ddl-locks返回结果中的ID）
返回结果示例
unlock-ddl-lock test-`shard_db`.`shard_table`
{
"result": true, # unlock lock 操作是否成功
"msg": "", # unlock lock 操作失败时的原因
"workers": [ # 各 DM-worker 执行/跳过 DDL 操作结果信息列表
{
"result": true, # 该 DM-worker 执行/跳过 DDL 操作是否成功
"worker": "127.0.0.1:8262", # DM-worker 地址 (DM-worker ID)
"msg": "" # DM-worker 执行/跳过 DDL 失败时的原因
}
]
}
break-ddl-lock
该命令用于主动请求 DM-worker 强制打破当前正在等待 unlock 的 DDL lock，包括请求 DM-worker 执行或跳过 DDL 操作、移除该 DM-worker 上的 DDL lock 信息。
命令示例
break-ddl-lock <--worker=127.0.0.1:8262> [--remove-id] [--exec] [--skip] <task-name>
参数解释
worker：- flag 参数，string，
--worker，必选 - 指定需要执行 break 操作的 DM-worker
- flag 参数，string，
remove-id：已废弃exec：- flag 参数，boolean，
--exec，可选 - 不可与
--skip参数同时指定 - 指定时，请求该 DM-worker 执行（execute）当前 lock 对应的 DDL
- flag 参数，boolean，
skip：- flag 参数，boolean，
--skip，可选 - 不可与
--exec参数同时指定 - 指定时，请求该 DM-worker 跳过（skip）当前 lock 对应的 DDL
- flag 参数，boolean，
task-name：- 非 flag 参数，string，必选
- 指定要执行 break 操作的 lock 所在的 task 名称（要查看各 task 上是否存在 lock，可通过 query-status 获得）
返回结果示例
break-ddl-lock -w 127.0.0.1:8262 --exec test
{
"result": true, # break lock 操作是否成功
"msg": "", # break lock 操作失败时的原因
"workers": [ # 执行 break lock 操作的 DM-worker 列表（当前单次操作仅支持对一个 DM-worker 执行 break lock）
{
"result": false, # 该 DM-worker break lock 操作是否成功
"worker": "127.0.0.1:8262", # 该 DM-worker 地址 (DM-worker ID)
"msg": "" # DM-worker break lock 失败时的原因
}
]
}
支持场景
目前，使用 unlock-ddl-lock/break-ddl-lock 命令仅支持处理以下三种 sharding DDL lock 异常情况。
场景一：部分 DM-worker 下线
Lock 异常原因
在 DM-master 尝试自动 unlock sharding DDL lock 之前，需要等待所有 DM-worker 的 sharding DDL events 全部到达（详见分库分表合并迁移原理）。如果 sharding DDL 已经在迁移过程中，且有部分 DM-worker 下线，并且不再计划重启它们（按业务需求移除了这部分 DM-worker），则会由于永远无法等齐所有的 DDL 而造成 lock 无法自动 unlock。
手动处理示例
假设上游有 MySQL-1 和 MySQL-2 两个实例，其中 MySQL-1 中有 shard_db_1.shard_table_1 和 shard_db_1.shard_table_2 两个表，MySQL-2 中有 shard_db_2.shard_table_1 和 shard_db_2.shard_table_2 两个表。现在需要将这 4 个表合并后迁移到下游 TiDB 的 shard_db.shard_table 表中。
初始表结构如下：
SHOW CREATE TABLE shard_db_1.shard_table_1;
+---------------+------------------------------------------+
| Table | Create Table |
+---------------+------------------------------------------+
| shard_table_1 | CREATE TABLE `shard_table_1` (
`c1` int(11) NOT NULL,
PRIMARY KEY (`c1`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1 |
+---------------+------------------------------------------+
上游分表将执行以下 DDL 语句变更表结构：
ALTER TABLE shard_db_*.shard_table_* ADD COLUMN c2 INT;
MySQL 及 DM 操作与处理流程如下：
MySQL-1 对应的 DM-worker-1 的两个分表执行了对应的 DDL 操作进行表结构变更。
ALTER TABLE shard_db_1.shard_table_1 ADD COLUMN c2 INT;ALTER TABLE shard_db_1.shard_table_2 ADD COLUMN c2 INT;DM-worker-1 接受到两个分表的 DDL 之后，将对应 MySQL-1 相关的 DDL 信息发送给 DM-master，DM-master 创建相应的 DDL lock。
使用
show-ddl-lock查看当前的 DDL lock 信息。show-ddl-locks test{ "result": true, "msg": "", "locks": [ { "ID": "test-`shard_db`.`shard_table`", "task": "test", "owner": "127.0.0.1:8262", "DDLs": [ "USE `shard_db`; ALTER TABLE `shard_db`.`shard_table` ADD COLUMN `c2` int(11);" ], "synced": [ "127.0.0.1:8262" ], "unsynced": [ "127.0.0.1:8263" ] } ] }由于业务需要，DM-worker-2 对应的 MySQL-2 的数据不再需要迁移到下游 TiDB，对 DM-worker-2 执行了下线处理。
DM-master 上 ID 为
test-`shard_db`.`shard_table`的 lock 无法等到 DM-worker-2 的 DDL 操作信息。show-ddl-locks返回的unsynced中一直包含 DM-worker-2 的信息（127.0.0.1:8263）。使用
unlock-ddl-lock来请求 DM-master 主动 unlock 该 DDL lock。如果 DDL lock 的 owner 也已经下线，可以使用
--owner参数指定其他 DM-worker 作为新 owner 来执行 DDL。当存在任意 DM-worker 报错时，
result将为false，此时请仔细检查各 DM-worker 的错误是否是预期可接受的。已下线的 DM-worker 会返回
rpc error: code = Unavailable错误属于预期行为，可以忽略。如果其它未下线的 DM-worker 返回错误，则需要根据情况额外处理。
unlock-ddl-lock test-`shard_db`.`shard_table`{ "result": false, "msg": "github.com/pingcap/tidb-enterprise-tools/dm/master/server.go:1472: DDL lock test-`shard_db`.`shard_table` owner ExecuteDDL successfully, so DDL lock removed. but some dm-workers ExecuteDDL fail, you should to handle dm-worker directly", "workers": [ { "result": true, "worker": "127.0.0.1:8262", "msg": "" }, { "result": false, "worker": "127.0.0.1:8263", "msg": "rpc error: code = Unavailable desc = all SubConns are in TransientFailure, latest connection error: connection error: desc = \"transport: Error while dialing dial tcp 127.0.0.1:8263: connect: connection refused\"" } ] }
使用
show-ddl-locks确认 DDL lock 是否被成功 unlock。show-ddl-locks test{ "result": true, "msg": "no DDL lock exists", "locks": [ ] }查看下游 TiDB 中的表结构是否变更成功。
SHOW CREATE TABLE shard_db.shard_table;+-------------+--------------------------------------------------+ | Table | Create Table | +-------------+--------------------------------------------------+ | shard_table | CREATE TABLE `shard_table` ( `c1` int(11) NOT NULL, `c2` int(11) DEFAULT NULL, PRIMARY KEY (`c1`) ) ENGINE=InnoDB DEFAULT CHARSET=latin1 COLLATE=latin1_bin | +-------------+--------------------------------------------------+使用
query-status确认迁移任务是否正常。
手动处理后的影响
使用 unlock-ddl-lock 手动执行 unlock 操作后，由于该任务的配置信息中仍然包含了已下线的 DM-worker，如果不进行处理，则当下次 sharding DDL 到达时，仍会出现 lock 无法自动完成迁移的情况。
因此，在手动解锁 DDL lock 后，需要再执行以下操作：
- 使用
stop-task停止运行中的任务。 - 更新任务配置文件，将已下线 DM-worker 对应的信息从配置文件中移除。
- 使用
start-task及新任务配置文件重新启动任务。
场景二：unlock 过程中部分 DM-worker 重启
Lock 异常原因
在 DM-master 收到所有 DM-worker 的 DDL 信息后，执行自动 unlock DDL lock 的操作主要包括以下步骤：
- 请求 lock owner 执行 DDL 操作，并更新对应分表的 checkpoint。
- 在 owner 执行 DDL 操作成功后，移除 DM-master 上保存的 DDL lock 信息。
- 在 owner 执行 DDL 操作成功后，请求其他所有 DM-worker 跳过 DDL 操作并更新对应分表的 checkpoint。
上述 unlock DDL lock 的操作不是原子的，当 owner 执行 DDL 操作成功后，请求其他 DM-worker 跳过 DDL 操作时，如果该 DM-worker 发生了重启，则会造成该 DM-worker 跳过 DDL 操作失败。
此时 DM-master 上的 lock 信息被移除，但该 DM-worker 重启后将尝试继续重新迁移该 DDL 操作。但是，由于其他 DM-worker（包括原 owner）已经迁移完该 DDL 操作，并已经在继续后续的迁移，该 DM-worker 将永远无法等待该 DDL 操作对应 lock 的自动 unlock。
手动处理示例
仍然假设是 部分 DM-worker 下线 示例中的上下游表结构及合表迁移需求。
当在 DM-master 自动执行 unlock 操作的过程中，owner (DM-worker-1) 成功执行了 DDL 操作且开始继续进行后续迁移，并移除了 DM-master 上的 DDL lock 信息；但在请求 DM-worker-2 跳过 DDL 操作的过程中，由于 DM-worker-2 发生了重启而跳过 DDL 操作失败。
DM-worker-2 重启后，将尝试重新迁移重启前已经在等待的 DDL lock。此时将在 DM-master 上创建一个新的 lock，并且该 DM-worker 将成为 lock 的 owner（其他 DM-worker 此时已经执行或跳过 DDL 操作并在进行后续迁移）。
处理流程如下：
使用
show-ddl-locks确认 DM-master 上存在该 DDL 操作对应的 lock。应该仅有该重启的 DM-worker（
127.0.0.1:8263）处于syned状态：show-ddl-locks{ "result": true, "msg": "", "locks": [ { "ID": "test-`shard_db`.`shard_table`", "task": "test", "owner": "127.0.0.1:8263", "DDLs": [ "USE `shard_db`; ALTER TABLE `shard_db`.`shard_table` ADD COLUMN `c2` int(11);" ], "synced": [ "127.0.0.1:8263" ], "unsynced": [ "127.0.0.1:8262" ] } ] }使用
unlock-ddl-lock请求 DM-master unlock 该 lock。使用
--worker参数限定操作仅针对该重启的 DM-worker（127.0.0.1:8263）。Lock 过程中该 DM-worker 会尝试再次向下游执行该 DDL 操作（重启前的原 owner 已向下游执行过该 DDL 操作），需要确保该 DDL 操作可被多次执行。
unlock-ddl-lock --worker=127.0.0.1:8263 test-`shard_db`.`shard_table`{ "result": true, "msg": "", "workers": [ { "result": true, "worker": "127.0.0.1:8263", "msg": "" } ] }
使用
show-ddl-locks确认 DDL lock 是否被成功 unlock。使用
query-status确认迁移任务是否正常。
手动处理后的影响
手动 unlock sharding DDL lock 后，后续的 sharding DDL 将可以自动正常迁移。
场景三：unlock 过程中部分 DM-worker 临时不可达
Lock 异常原因
与 unlock 过程中部分 DM-worker 重启 造成 lock 异常的原因类似。当请求 DM-worker 跳过 DDL 操作时，如果该 DM-worker 临时不可达，则会造成该 DM-worker 跳过 DDL 操作失败。此时 DM-master 上的 lock 信息被移除，但该 DM-worker 将处于等待一个不再存在的 DDL lock 的状态。
场景三与场景二的区别在于，场景三中 DM-master 没有 lock，而场景二中 DM-master 有一个新的 lock。
手动处理示例
仍然假设是 部分 DM-worker 下线 示例中的上下游表结构及合表迁移需求。
在 DM-master 自动执行 unlock 操作的过程中，owner (DM-worker-1) 成功执行了 DDL 操作且开始继续进行后续迁移，并移除了 DM-master 上的 DDL lock 信息，但在请求 DM-worker-2 跳过 DDL 操作的过程中，由于网络原因等临时不可达而跳过 DDL 操作失败。
处理流程如下：
使用
show-ddl-locks确认 DM-master 上不再存在该 DDL 操作对应的 lock。使用
query-status确认 DM-worker 仍在等待 lock 迁移。query-status test{ "result": true, "msg": "", "workers": [ ... { ... "worker": "127.0.0.1:8263", "subTaskStatus": [ { ... "unresolvedDDLLockID": "test-`shard_db`.`shard_table`", "sync": { ... "blockingDDLs": [ "USE `shard_db`; ALTER TABLE `shard_db`.`shard_table` ADD COLUMN `c2` int(11);" ], "unresolvedGroups": [ { "target": "`shard_db`.`shard_table`", "DDLs": [ "USE `shard_db`; ALTER TABLE `shard_db`.`shard_table` ADD COLUMN `c2` int(11);" ], "firstPos": "(mysql-bin|000001.000003, 1752)", "synced": [ "`shard_db_2`.`shard_table_1`", "`shard_db_2`.`shard_table_2`" ], "unsynced": [ ] } ], "synced": false } } ] ... } ] }使用
break-ddl-lock请求强制 break 该 DM-worker 当前正在等待的 DDL lock。由于 owner 已经向下游执行了 DDL 操作，因此在 break 时使用
--skip参数。break-ddl-lock --worker=127.0.0.1:8263 --skip test{ "result": true, "msg": "", "workers": [ { "result": true, "worker": "127.0.0.1:8263", "msg": "" } ] }使用
query-status确认迁移任务是否正常且不再处于等待 lock 的状态。
手动处理后的影响
手动强制 break lock 后，后续 sharding DDL 将可以自动正常迁移。