TiDB 到 Kafka

CloudCanal 支持从 TiDB 到 Kafka 的数据迁移、同步、校验和链路能力。

选择对端数据库：

Kafka

数据链路

基本功能

功能	说明
结构迁移	如目标端不存在指定映射规则后的 Topic , 则自动进行 Topic 创建，并支持设置分区数
全量数据迁移	逻辑迁移，通过顺序扫描表数据，将数据分批写入到消息中间件
增量实时同步	支持 INSERT, UPDATE, DELETE 常见 DML 同步
修改订阅	新增、删除、修改订阅表，支持历史数据迁移，文档：修改订阅
重置位点	按 时间戳 回溯位点，重新消费过去一段时间未被 TiKV GC 掉的增量数据
元数据检索	从源端表查对端，查询设置过过滤条件的，查询设置过对端主键的

高级功能

功能	说明
消息格式	支持以下消息格式，文档：消息格式说明 CloudCanal内置格式 AlibabaCanal兼容格式
Topic 映射规则	默认按 . 拼接源端 实例id、库、表 形成对端 topic 进行匹配或待创建（如 my-vgpq6q097174t6t.dingtax.app_key），额外支持按 源端一致、转小写、转大写 映射
表级别 Topic	最小按照源端表级别设置对应的 Topic, 支持自动获取表分区
DDL 专用 Topic	支持指定 Topic 发送 DDL, 如未指定，则放置 DDL 时间在对应表 Topic 分区 0 中
定时全量迁移	文档1：创建定时全量任务 文档2：定时全量实现增量数据迁移
自定义代码	文档1：创建自定义代码任务 文档2：自定义代码任务 debug 文档3：在自定义代码中打日志
数据过滤条件	支持 WHERE 条件进行数据过滤，内容为 SQL 92 子集，文档：创建数据过滤任务

使用示例

标题	详情
跨互联网数据互通 (Kafka)	文档：跨互联网数据互通 (Kafka)
Kafka 数据中转校验	文档：Kafka 数据中转校验
CloudCanal x TiDB 数据迁移同步	文档：CloudCanal x TiDB 数据迁移同步

---

源端数据源

前置条件

条件	说明
账号权限	文档：TiDB 需要的权限
PD节点网络连通	请确保 CloudCanal 各节点能正常与 PD 各节点通讯 telnet [PD节点IP] [PD节点端口号]
TiKV GC 回收频率	在 TiDB Server 中修改 GC 周期时间为 24小时 以上 set global tidb_gc_life_time = "24h0m0s";
TiKV 历史变更数据缓存	建议根据任务所需适当调整大小 old-value-cache-memory-quota：增量旧数据占用 TiKV 节点的内存的上限 sink-memory-quota：增量数据占用 TiKV 节点的内存的上限

任务参数

参数名称	说明
printDetailLog	打印接收到的增量，常用于判断源端是否有增量数据推送
pdHost	任务请求的 PD 节点地址，格式为: [PD_IP]:[PD_PORT], 多个 PD 节点用 , 隔开 例: 127.0.0.1:2379,127.0.0.1:2380
cdcGrpcTimeout	任务与 PD 节点 gRpc 连接通道的超时时间，单位ms
cdcStubTimeout	gRpc 通道中的每个 stub 的超时时间，超过该时间会自动重新订阅，单位ms
fastFailKeywords	字符串数组，以逗号分隔，当异常信息中包含这些关键字时，任务不再尝试重连，直接重启。例如 DEADLINE_EXCEEDED 表示当 gRPC 超时异常时不再重连，直接重启任务

Tips: 通用参数配置请参考 通用参数及功能

---

目标端数据源

前置条件

条件	说明
网络准备	迁移同步节点（sidecar）可连接 Kafka 各节点

任务参数

参数名称	说明
schemaFormat	消息格式，文档：消息格式说明
batchWriteSize	单条消息最大数据条数，超过则拆分消息
defaultTopic	无法找到对应 Topic 的消息则发送到此 Topic (如新增表)
ddlTopic	专门发送 DDL 的 Topic, 为空则发送到对应 Topic 的第 0 个分区
compressionType	Kafka compression.type 参数, 设置压缩算法, 支持 GZIP, SNAPPY, LZ4, ZSTD 算法
batchSize	Kafka batch.size 参数
acks	Kafka acks 参数, 默认 all
maxRequestBytes	Kafka max.request.size 参数
lingerMs	Kafka linger.ms 参数, 默认 1
envelopSchemaInclude	当 schemaFormat 设置为 DEBEZIUM_ENVELOP_JSON_FOR_MQ 时，消息体是否包含 schema 信息
customClientProps	自定义传入到 Kafka Client 参数，JSON 格式，key为参数名，value为参数值。此配置项以最高优先级生效。例如：AWS IAM 访问控制

Tips: 通用参数配置请参考 通用参数及功能