TiDB Data Migration 任务前置检查
本文介绍了 TiDB Data Migration (DM) 的任务前置检查功能。此功能用于提前检测出上游 MySQL 实例配置中可能存在的一些错误。
使用场景
为了使数据迁移任务顺利进行，DM 在启动迁移任务时会自动触发任务前置检查，并返回检查结果。只有当前置检查通过后，DM 才开始执行迁移任务。
如果你想要手动触发前置检查，运行 check-task 命令即可。
例如：
tiup dmctl check-task ./task.yaml
检查项说明
当任务前置检查被触发时，DM 会按照配置的迁移模式对相应的检查项进行检查。
本小节列出了前置检查中的所有检查项。
通用检查项
对于任何一种迁移模式，前置检查都会包含以下通用检查项：
数据库版本
MySQL 版本 > 5.5
MariaDB 版本 >= 10.1.2
上游 MySQL 表结构的兼容性
检查上游表是否设置了外键。TiDB 不支持外键，如果上游表设置了外键，则返回警告。
检查上游字符集是否与 TiDB 兼容，详见 TiDB 支持的字符集。
检查上游表中是否存在主键或唯一键约束（从 v1.0.7 版本引入）。
全量数据迁移检查项
对于全量数据迁移模式（task-mode: full），除了通用检查项，前置检查还会包含以下检查项：
（必须）上游数据库的 dump 权限
- 检查是否有 INFORMATION_SCHEMA 和 dump 表的 SELECT 权限。
- 如果 consistency=flush，将检查是否有 RELOAD 权限。
- 如果 consistency=flush/lock，将检查是否有 dump 表的 LOCK TABLES 权限。
（必须）上游 MySQL 多实例分库分表的一致性
悲观协调模式下，检查所有分表的表结构是否一致，检查内容包括：
- Column 数量
- Column 名称
- Column 顺序
- Column 类型
- 主键
- 唯一索引
乐观协调模式下，检查所有分表结构是否满足乐观协调兼容。
如果曾经通过
start-task命令成功启动任务，那么将不会对一致性进行检查。
分表中自增主键检查
- 分表存在自增主键时返回警告。如果存在自增主键冲突，请参照自增主键冲突处理解决。
Physical Import 检查项
在任务配置中使用 import-mode: "physical" 后，会增加如下的前置检查项以保证物理导入模式正常运行。如果参照提示后仍然难以完成这些前置检查，你可以尝试使用逻辑导入模式进行导入。
下游数据库中的空 Region
- 如果空 Region 的数量大于
max(1000, 表的数量 * 3)，即大于“1000”和“3 倍表数量”二者中的较大者，前置检查会向用户返回警告。可以调整 PD 相关参数加快空 Region 的合并速度，并等待空 Region 数量下降以解除警告。参见 PD 调度策略最佳实践 - Region Merge 速度慢
- 如果空 Region 的数量大于
下游数据库中的 Region 分布
- 统计不同的 TiKV 上的 Region 数目。假设 Region 数最少的 TiKV 节点上拥有
a个 Region，Region 数最多的 TiKV 节点上拥有b个 Region，如果 a/b 小于 0.75，则前置检查会向用户返回警告。可以调整 PD 相关参数加快 Region 调度速度，并等待 Region 数目变化以解除警告。参见 PD 调度策略最佳实践 - Leader/Region 分布不均衡
- 统计不同的 TiKV 上的 Region 数目。假设 Region 数最少的 TiKV 节点上拥有
下游数据库 TiDB、PD、TiKV 组件的版本
- 物理导入模式需要调用 TiDB、PD、TiKV 接口，如果版本不符合要求，会返回错误。
下游数据库的剩余空间
- 估算上游数据库所有白名单表的大小之和 (
source_size)，如果下游数据库剩余空间小于source_size，前置检查会返回错误；如果下游数据库剩余空间小于 TiKV 副本数 *source_size* 2，前置检查会返回警告。
- 估算上游数据库所有白名单表的大小之和 (
下游数据库是否在运行与 Physical Import 不兼容的任务
增量数据迁移检查项
对于增量数据迁移模式（task-mode: incremental），除了通用检查项，前置检查还会包含以下检查项：
（必须）上游数据库的 REPLICATION 权限
- 检查是否有 REPLICATION CLIENT 权限。
- 检查是否有 REPLICATION SLAVE 权限。
数据库主从配置
- 建议上游数据库设置数据库 ID
server_id（非 AWS Aurora 环境建议开启 GTID），防止主从复制切换出错。
- 建议上游数据库设置数据库 ID
（必须）MySQL binlog 配置
- 检查 binlog 是否开启（DM 要求 binlog 必须开启）。
- 检查是否有
binlog_format=ROW（DM 只支持 ROW 格式的 binlog 迁移）。 - 检查是否有
binlog_row_image=FULL（DM 只支持binlog_row_image=FULL）。 - 如果配置了
binlog_do_db或者binlog_ignore_db，那么检查需要迁移的库表，是否满足binlog_do_db和binlog_ignore_db的条件。
（必须）检查上游是否处于 Online-DDL 过程中，即创建了
ghost表，但还未执行rename的阶段。如果处于 online-DDL 中，则检查报错，请等待 DDL 结束后重试。
全量加增量数据迁移检查项
对于全量加增量数据迁移模式（task-mode: all），除了通用检查项，前置检查还会包含全量数据迁移检查项，以及增量数据迁移检查项。
可忽略检查项
一般情况下前置检查项用于提前发现环境中可能存在的风险，不建议忽略。如果你的数据迁移任务面临特殊场景，你可以通过 ignore-checking-items 配置项来跳过部分检查项。
| 值 | 含义 |
|---|---|
| dump_privilege | 检查上游 MySQL 实例用户的 dump 相关权限 |
| replication_privilege | 检查上游 MySQL 实例用户的 replication 相关权限 |
| version | 检查上游数据库版本 |
| server_id | 检查上游数据库是否设置 server_id |
| binlog_enable | 检查上游数据库是否已启用 binlog |
| table_schema | 检查上游 MySQL 表结构的兼容性 |
| schema_of_shard_tables | 检查上游 MySQL 多实例分库分表的表结构一致性 |
| auto_increment_ID | 检查上游 MySQL 多实例分库分表的自增主键冲突 |
| online_ddl | 检查上游是否处于 Online-DDL 过程中 |
| empty_region | 物理导入模式检查空 Region 的数目 |
| region_distribution | 物理导入模式检查 Region 的分布 |
| downstream_version | 检查下游数据库 TiDB、PD、TiKV 的版本 |
| free_space | 检查下游数据库的剩余空间 |
| downstream_mutex_features | 检查下游数据库是否存在与物理导入模式不兼容的任务 |
配置检查参数
任务前置检查支持多线程并行。即使分表数目达到万级别，检查也可以在分钟级完成。
你可以通过数据迁移任务配置文件里 mydumpers 字段中的 threads 参数指定线程的数量。
mydumpers: # dump 处理单元的运行配置参数
global: # 配置名称
threads: 4 # dump 处理单元从上游数据库实例导出数据和执行前置检查时访问上游的线程数量，默认值为 4
chunk-filesize: 64 # dump 处理单元生成的数据文件大小，默认值为 64，单位为 MB
extra-args: "--consistency none" # dump 处理单元的其他参数，不需要在 extra-args 中配置 table-list，DM 会自动生成