Changefeed DDL 同步

本文档介绍了 TiCDC 同步 DDL 的规则和特殊情况。

DDL 白名单

目前 TiCDC 在同步 DDL 时使用白名单策略，只有在白名单中的 DDL 操作才会被同步到下游系统，不在白名单中的 DDL 操作将不会被 TiCDC 同步。

以下为 TiCDC 支持同步的 DDL 的列表。

create database
drop database
create table
drop table
add column
drop column
create index / add index
drop index
truncate table
modify column
rename table
alter column default value
alter table comment
rename index
add partition
drop partition
truncate partition
create view
drop view
alter table character set
alter database character set
recover table
add primary key
drop primary key
rebase auto id
alter table index visibility
exchange partition
reorganize partition
alter table ttl
alter table remove ttl

DDL 同步注意事项

由于同步过程中缺乏一些上下文信息，因此 TiCDC 对 rename table 类型的 DDL 同步有一些约束。

一条 DDL 语句内 rename 单个表

如果一条 DDL 语句重命名单个表，则只有旧表名符合过滤规则时，TiCDC 才会同步该 DDL 语句。下面使用具体示例进行说明。

假设你的 changefeed 的配置文件如下：

[filter]
rules = ['test.t*']

那么，TiCDC 对该类型 DDL 的处理行为如下表所示：

DDL	是否同步	原因和处理方式
`RENAME TABLE test.t1 TO test.t2`	同步	test.t1 符合 filter 规则
`RENAME TABLE test.t1 TO ignore.t1`	同步	test.t1 符合 filter 规则
`RENAME TABLE ignore.t1 TO ignore.t2`	忽略	ignore.t1 不符合 filter 规则
`RENAME TABLE test.n1 TO test.t1`	报错，并停止同步。	test.n1 不符合 filter 规则，但是 test.t1 符合 filter 规则，这是非法操作。请参考错误提示信息进行处理
`RENAME TABLE ignore.t1 TO test.t1`	报错，并停止同步。	理由同上

一条 DDL 语句内 rename 多个表

如果一条 DDL 语句重命名多个表，则只有当旧的表库名和新的库名都符合过滤规则时，TiCDC 才会同步该 DDL 语句。此外，TiCDC 不支持同步对表名进行交换的 rename table DDL。下面使用具体示例进行说明。

假设你的 changefeed 的配置文件如下：

[filter]
rules = ['test.t*']

那么，TiCDC 对该类型的处理行为如下表所示：

DDL	是否同步	原因
`RENAME TABLE test.t1 TO test.t2, test.t3 TO test.t4`	同步	新旧表库名都符合 filter 规则
`RENAME TABLE test.t1 TO test.ignore1, test.t3 TO test.ignore2`	同步	旧的表库名，新的库名都符合 filter 规则
`RENAME TABLE test.t1 TO ignore.t1, test.t2 TO test.t22;`	报错	新的库名 ignore 不符合 filter 规则
`RENAME TABLE test.t1 TO test.t4, test.t3 TO test.t1, test.t4 TO test.t3;`	报错	在一条 DDL 中交换 test.t1 和 test.t3 两个表的名字，TiCDC 无法正确处理。请参考错误提示提示信息处理。

SQL 模式

TiCDC 默认采用 TiDB 的默认 SQL 模式来解析 DDL 语句。如果你的上游 TiDB 集群使用了非默认的 SQL 模式，你需要在 TiCDC 的配置文件中指定 SQL 模式，否则 TiCDC 可能无法正确解析 DDL。关于 TiDB SQL 模式的更多信息，请参考 SQL 模式。

例如，如果你的上游 TiDB 集群设置了 ANSI_QUOTES 模式，你需要在 changefeed 的配置文件中指定 SQL 模式：

# 其中，前面的 "ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION" 是 TiDB 默认的 SQL 模式
# 后面的 "ANSI_QUOTES" 是你的上游 TiDB 集群添加的 SQL 模式

sql-mode = "ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION,ANSI_QUOTES"

如果未设置 SQL 模式，那么 TiCDC 可能无法正确解析一些 DDL 语句，例如：

CREATE TABLE "t1" ("a" int PRIMARY KEY);

因为在 TiDB 的默认 SQL 模式下，双引号会被视为字符串而不是标志符，这将会导致 TiCDC 无法正确解析该 DDL 语句。

因此，在创建同步任务的时候，建议在配置文件中指定使用上游 TiDB 集群设置的 SQL 模式。