| title | summary |
|---|---|
Changefeed 概述 |
了解 Changefeed 的基本概念和 Changefeed 状态的定义与流转 |
Changefeed 是 TiCDC 中的单个同步任务。Changefeed 将一个 TiDB 集群中数张表的变更数据输出到一个指定的下游。TiCDC 集群可以运行和管理多个 Changefeed。
同步任务状态标识了同步任务的运行情况。在 TiCDC 运行过程中，同步任务可能会运行出错、手动暂停、恢复，或达到指定的 TargetTs，这些行为都可以导致同步任务状态发生变化。本节描述 TiCDC 同步任务的各状态以及状态之间的流转关系。
以上状态流转图中的状态说明如下：
- Normal：同步任务正常进行，checkpoint-ts 正常推进。
- Stopped：同步任务停止，由于用户手动暂停 (pause) changefeed。处于这个状态的 changefeed 会阻挡 GC 推进。
- Error：同步任务报错，由于某些可恢复的错误导致同步无法继续进行，处于这个状态的 changefeed 会不断尝试继续推进，直到状态转为 Normal。处于这个状态的 changefeed 会阻挡 GC 推进。
- Finished：同步任务完成，同步任务进度已经达到预设的 TargetTs。处于这个状态的 changefeed 不会阻挡 GC 推进。
- Failed：同步任务失败。由于发生了某些不可恢复的错误，导致同步无法继续进行，并且无法恢复。TiCDC 将为发生故障的 changefeed 保留数据 24 小时，以防止其在 GC 过程中被清除。
以上状态流转图中的编号说明如下：
- ① 执行
changefeed pause命令。 - ② 执行
changefeed resume恢复同步任务。 - ③
changefeed运行过程中发生可恢复的错误，自动进行恢复。 - ④ 执行
changefeed resume恢复同步任务。 - ⑤
changefeed运行过程中发生不可恢复的错误。 - ⑥
changefeed已经进行到预设的 TargetTs，同步自动停止。 - ⑦
changefeed停滞时间超过gc-ttl所指定的时长，不可被恢复。 - ⑧
changefeed尝试自动恢复过程中发生不可恢复的错误。
通过 TiCDC 提供的命令行工具 cdc cli，你可以管理 TiCDC 集群和同步任务，具体可参考管理 TiCDC Changefeed。你也可以通过 HTTP 接口，即 TiCDC OpenAPI 来管理 TiCDC 集群和同步任务，详见 TiCDC OpenAPI。
如果你使用的 TiCDC 是用 TiUP 部署的，可以通过 tiup ctl:v<CLUSTER_VERSION> cdc 来使用 TiCDC 命令行工具，注意需要将 <version> 替换为 TiCDC 集群版本。你也可以通过直接执行 cdc cli 直接使用命令行工具。