Changefeed

TiDB Cloud changefeed helps you stream data from TiDB Cloud to other data services. Currently, TiDB Cloud supports streaming data to Apache Kafka and MySQL.

Note

To use the changefeed feature, make sure that your TiDB cluster version is v6.4.0 or later and the TiKV node size is at least 8 vCPU and 16 GiB.

Currently, TiDB Cloud only allows up to 10 changefeeds per cluster.

For Serverless Tier clusters, the changefeed feature is unavailable.

To access the changefeed feature, navigate to the cluster overview page of your TiDB cluster, and then click Changefeed in the left navigation pane. The changefeed list is displayed.

In the changefeed list, you can:

View the information of the created changefeed, including changefeed's id, checkpoint, and status.
Operate the changefeed, including creating, pausing, resuming, editing, and deleting the changefeed.

Create a changefeed

To create a changefeed, refer to the tutorials:

Sink to Apache Kafka (Beta)
Sink to MySQL

Delete a changefeed

Navigate to the cluster overview page of the target TiDB cluster, and then click Changefeed in the left navigation pane.
Locate the corresponding changefeed you want to delete, and click ... > Delete in the Action column.

Pause or resume a changefeed

Navigate to the cluster overview page of the target TiDB cluster, and then click Changefeed in the left navigation pane.
Locate the corresponding changefeed you want to pause or resume, and click ... > Pause/Resume in the Action column.

Edit a changefeed

Note

TiDB Cloud currently only allows editing changefeeds in the paused status.

Navigate to the cluster overview page of the target TiDB cluster, and then click Changefeed in the left navigation pane.
Locate the changefeed you want to pause, and click ... > Pause in the Action column.
When the changefeed status changes to Paused, click ... > Edit to edit the corresponding changefeed.
TiDB Cloud populates the changefeed configuration by default. You can modify the following configurations:
- MySQL sink: MySQL Connection and Table Filter.
- Kafka sink: all configurations.
After editing the configuration, click ... > Resume to resume the corresponding changefeed.

Query TiCDC RCUs

Navigate to the cluster overview page of the target TiDB cluster, and then click Changefeed in the left navigation pane.
You can see the current TiCDC Replication Capacity Units (RCUs) in the upper-left corner of the page.

Changefeed billing

To learn the billing for changefeeds in TiDB Cloud, see Changefeed billing.

Changefeed states

The state of a replication task represents the running state of the replication task. During the running process, replication tasks might fail with errors, be manually paused, resumed, or reach the specified TargetTs. These behaviors can lead to changes of the replication task state.

The states are described as follows:

CREATING: the replication task is being created.
RUNNING: the replication task runs normally and the checkpoint-ts proceeds normally.
EDITING: the replication task is being edited.
PAUSING: the replication task is being paused.
PAUSED: the replication task is paused.
RESUMING: the replication task is being resumed.
DELETING: the replication task is being deleted.
DELETED: the replication task is deleted.
WARNING: the replication task returns a warning. The replication cannot continue due to some recoverable errors. The changefeed in this state keeps trying to resume until the state transfers to RUNNING. The changefeed in this state blocks GC operations.
FAILED: the replication task fails. Due to some unrecoverable errors, the replication task cannot resume and cannot be recovered. The changefeed in this state does not block GC operations.