TiDB Data Migration Binlog 事件过滤

TiDB Data Migration (DM) 的 Binlog 事件过滤 (Binlog event filter) 是比迁移表黑白名单更加细粒度的过滤规则，可以指定只迁移、过滤、或者拦截并报错某些 schema / table 的指定类型 binlog，比如 INSERT 和 TRUNCATE TABLE。

配置 Binlog 事件过滤

在迁移任务配置文件中，添加如下配置：

filters:
  rule-1:
    schema-pattern: "test_*"
    table-pattern: "t_*"
    events: ["truncate table", "drop table"]
    sql-pattern: ["^DROP\\s+PROCEDURE", "^CREATE\\s+PROCEDURE"]
    action: Ignore

从 DM v2.0.2 开始，你也可以在上游数据库配置文件中配置 Binlog 事件过滤。见上游数据库配置文件介绍。

使用通配符匹配库表名时，注意以下事项：

schema-pattern 和 table-pattern 仅支持通配符，支持的通配符包括 *、? 和 []。注意通配符匹配中的 * 符号只能有一个，且必须在末尾。例如 table-pattern: "t_*" 中的 "t_*" 表示以 t_ 开头的表。详情请参考通配符匹配。
sql-pattern 仅支持正则表达式。

参数解释

schema-pattern/table-pattern：对匹配上的上游 MySQL/MariaDB 实例的表的 binlog events 或者 DDL SQL 语句通过以下规则进行过滤。

events：binlog events 数组，仅支持从以下 Event 中选择一项或多项。

Event	分类	解释
all		代表包含下面所有的 events
all dml		代表包含下面所有 DML events
all ddl		代表包含下面所有 DDL events
incompatible ddl changes		代表包含下面所有 incompatible DDL events，即可能导致数据丢失的 DDL
none		代表不包含下面所有 events
none ddl		代表不包含下面所有 DDL events
none dml		代表不包含下面所有 DML events
insert	DML	insert DML event
update	DML	update DML event
delete	DML	delete DML event
create database	DDL	create database event
drop database	incompatible DDL	drop database event
create table	DDL	create table event
create index	DDL	create index event
drop table	incompatible DDL	drop table event
truncate table	incompatible DDL	truncate table event
rename table	incompatible DDL	rename table event
drop index	incompatible DDL	drop index event
alter table	DDL	alter table event
value range decrease	incompatible DDL	缩短列字段长度的 DDL 语句，如将 `VARCHAR(20)` 改为 `VARCHAR(10)` 的 `ALTER TABLE MODIFY COLUMN` 语句
precision decrease	incompatible DDL	降低列字段精度的 DDL 语句，如将 `Decimal(10, 2)` 改为 `Decimal(10, 1)` 的 `ALTER TABLE MODIFY COLUMN` 语句
modify column	incompatible DDL	变更列字段类型的 DDL 语句，如将 `INT` 改为 `VARCHAR` 的 `ALTER TABLE MODIFY COLUMN` 语句
rename column	incompatible DDL	变更列名的 DDL 语句，如 `ALTER TABLE RENAME COLUMN` 语句
rename index	incompatible DDL	变更索引名的 DDL 语句，如 `ALTER TABLE RENAME INDEX` 语句
drop column	incompatible DDL	删除表中的列的 DDL 语句，如 `ALTER TABLE DROP COLUMN` 语句
drop index	incompatible DDL	删除表中的索引的 DDL 语句，如 `ALTER TABLE DROP INDEX` 语句
truncate table partition	incompatible DDL	清空表中指定分区的 DDL 语句，如 `ALTER TABLE TRUNCATE PARTITION` 语句
drop primary key	incompatible DDL	删除主键的 DDL 语句，如 `ALTER TABLE DROP PRIMARY KEY` 语句
drop unique key	incompatible DDL	删除唯一键的 DDL 语句，如 `ALTER TABLE DROP UNIQUE KEY` 语句
modify default value	incompatible DDL	修改列默认值的 DDL 语句，如 `ALTER TABLE CHANGE DEFAULT` 语句
modify constraint	incompatible DDL	修改约束条件的 DDL 语句，如 `ALTER TABLE ADD CONSTRAINT` 语句
modify columns order	incompatible DDL	修改列顺序的 DDL 语句，如 `ALTER TABLE CHANGE AFTER` 语句
modify charset	incompatible DDL	修改列字符集的 DDL 语句，如 `ALTER TABLE MODIFY CHARSET` 语句
modify collation	incompatible DDL	修改列排序规则的 DDL 语句，如 `ALTER TABLE MODIFY COLLATE` 语句
remove auto increment	incompatible DDL	删除自增键的 DDL 语句
modify storage engine	incompatible DDL	修改表存储引擎的 DDL 语句，如 `ALTER TABLE ENGINE = MyISAM` 语句
reorganize table partition	incompatible DDL	重组分区的 DDL 语句，如 `ALTER TABLE REORGANIZE PARTITION` 语句
rebuild table partition	incompatible DDL	重建分区的 DDL 语句，如 `ALTER TABLE REBUILD PARTITION` 语句
exchange table partition	incompatible DDL	交换分区的 DDL 语句，如 `ALTER TABLE EXCHANGE PARTITION` 语句
coalesce table partition	incompatible DDL	减少分区数量的 DDL 语句，如 `ALTER COALESCE PARTITION` 语句

sql-pattern：用于过滤指定的 DDL SQL 语句，支持正则表达式匹配，例如上面示例中的 "^DROP\\s+PROCEDURE"。
action：string (Do / Ignore/ Error)；进行下面规则判断：
- Do：白名单。binlog event 如果满足下面两个条件之一就会被过滤掉：
  - 不在该 rule 的 events 中。
  - 如果规则的 sql-pattern 不为空的话，对应的 SQL 没有匹配上 sql-pattern 中任意一项。
- Ignore：黑名单。如果满足下面两个条件之一就会被过滤掉：
  - 在该 rule 的 events 中。
  - 如果规则的 sql-pattern 不为空的话，对应的 SQL 可以匹配上 sql-pattern 中任意一项。
- Error：报错名单。如果满足下面两个条件之一就会报错：
  - 在该 rule 的 events 中。
  - 如果规则的 sql-pattern 不为空的话，对应的 SQL 可以匹配上 sql-pattern 中任意一项。
- 同一个表匹配上多个规则时，将会按顺序依次应用这些规则，并且黑名单的优先级高于报错名单，报错名单的优先级高于白名单，即如果同时存在规则 Ignore 和 Error 应用在某个表上，那么 Ignore 生效；如果同时存在规则 Error 和 Do 应用在某个表上，那么 Error 生效。

使用示例

过滤分库分表的所有删除操作

需要设置下面两个 Binlog event filter rule 来过滤掉所有的删除操作：

filter-table-rule 过滤掉所有匹配到 pattern test_*.t_* 的 table 的 turncate table、drop table、delete statement 操作。
filter-schema-rule 过滤掉所有匹配到 pattern test_* 的 schema 的 drop database 操作。

filters:
  filter-table-rule:
    schema-pattern: "test_*"
    table-pattern: "t_*"
    events: ["truncate table", "drop table", "delete"]
    action: Ignore
  filter-schema-rule:
    schema-pattern: "test_*"
    events: ["drop database"]
    action: Ignore

只迁移分库分表的 DML 操作

需要设置下面两个 Binlog event filter rule 只迁移 DML 操作：

do-table-rule 只迁移所有匹配到 pattern test_*.t_* 的 table 的 create table、insert、update、delete 操作。
do-schema-rule 只迁移所有匹配到 pattern test_* 的 schema 的 create database 操作。

注意

迁移 create database/table 的原因是创建库和表后才能迁移 DML。

filters:
  do-table-rule:
    schema-pattern: "test_*"
    table-pattern: "t_*"
    events: ["create table", "all dml"]
    action: Do
  do-schema-rule:
    schema-pattern: "test_*"
    events: ["create database"]
    action: Do

过滤 TiDB 不支持的 SQL 语句

可设置如下规则过滤 TiDB 不支持的 PROCEDURE 语句：

filters:
  filter-procedure-rule:
    schema-pattern: "test_*"
    table-pattern: "t_*"
    sql-pattern: ["^DROP\\s+PROCEDURE", "^CREATE\\s+PROCEDURE"]
    action: Ignore

过滤 TiDB parser 不支持的 SQL 语句

对于 TiDB parser 不支持的 SQL 语句，DM 无法解析获得 schema/table 信息，因此需要使用全局过滤规则：schema-pattern: "*"。

注意

全局过滤规则的设置必须尽可能严格，以避免过滤掉需要迁移的数据。

可设置如下规则过滤某些版本的 TiDB parser 不支持的 PARTITION 语句：

filters:
  filter-partition-rule:
    schema-pattern: "*"
    sql-pattern: ["ALTER\\s+TABLE[\\s\\S]*ADD\\s+PARTITION", "ALTER\\s+TABLE[\\s\\S]*DROP\\s+PARTITION"]
    action: Ignore

对部分 DDL 语句报错

如需在 DM 同步上游业务数据到 TiDB 之前对部分 DDL 语句进行拦截并报错，可采用如下设置：

filters:
  filter-procedure-rule:
    schema-pattern: "test_*"
    table-pattern: "t_*"
    events: ["truncate table", "truncate table partition"]
    action: Error