Essential changefeed

TOC-tidb-cloud-essential.md

@@ -232,6 +232,10 @@
     - [CSV Configurations for Importing Data](/tidb-cloud/csv-config-for-import-data.md)
     - [Troubleshoot Access Denied Errors during Data Import from Amazon S3](/tidb-cloud/troubleshoot-import-access-denied-error.md)
     - [Connect AWS DMS to TiDB Cloud clusters](/tidb-cloud/tidb-cloud-connect-aws-dms.md)
+- Stream Data
+  - [Changefeed Overview](/tidb-cloud/essential-changefeed-overview.md)
+  - [Sink to MySQL](/tidb-cloud/essential-changefeed-sink-to-mysql.md)
+  - [Sink to Apache Kafka](/tidb-cloud/essential-changefeed-sink-to-kafka.md)
 - Vector Search ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png)
   - [Overview](/vector-search/vector-search-overview.md)
   - Get Started

tidb-cloud/essential-changefeed-overview.md

@@ -0,0 +1,163 @@
+---
+title: Changefeed
+summary: TiDB Cloud changefeed helps you stream data from TiDB Cloud to other data services.
+---
+
+# 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:**
+>
+> - Currently, TiDB Cloud only allows up to 10 changefeeds per {{{ .essential }}} cluster.
+> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) clusters, the changefeed feature is unavailable.
+
+## View the Changefeed page
+
+To access the changefeed feature, take the following steps:
+
+1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project.
+
+    > **Tip:**
+    >
+    > You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters.
+
+2. Click the name of your target cluster to go to its overview page, and then click **Data** > **Changefeed** in the left navigation pane. The changefeed page is displayed.
+
+On the **Changefeed** page, you can create a changefeed, view a list of existing changefeeds, and operate the existing changefeeds (such as scaling, pausing, resuming, editing, and deleting a changefeed).
+
+## Create a changefeed
+
+To create a changefeed, refer to the tutorials:
+
+- [Sink to Apache Kafka](/tidb-cloud/essential-changefeed-sink-to-kafka.md)
+- [Sink to MySQL](/tidb-cloud/essential-changefeed-sink-to-mysql.md)
+
+## View a changefeed
+
+<SimpleTab>
+<div label="Console">
+
+1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster.
+2. Locate the corresponding changefeed you want to view, and click **...** > **View** in the **Action** column.
+3. You can see the details of a changefeed, including its configuration, status, and metrics.
+
+</div>
+
+<div label="CLI">
+
+```
+ticloud serverless changefeed get -c <cluster-id> --changefeed-id <changefeed-id>
+```
+
+</div>
+</SimpleTab>
+
+## Pause or resume a changefeed
+
+<SimpleTab>
+<div label="Console">
+
+1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster.
+2. Locate the corresponding changefeed you want to pause or resume, and click **...** > **Pause/Resume** in the **Action** column.
+
+</div>
+
+<div label="CLI">
+
+To pause a changefeed:
+
+```
+ticloud serverless changefeed pause -c <cluster-id> --changefeed-id <changefeed-id>
+```
+
+To resume a changefeed:
+
+```
+ticloud serverless changefeed resume -c <cluster-id> --changefeed-id <changefeed-id>
+```
+
+</div>
+</SimpleTab>
+
+## Edit a changefeed
+
+> **Note:**
+>
+> TiDB Cloud currently only allows editing changefeeds that are in the `Paused` state.
+
+<SimpleTab>
+<div label="Console">
+
+1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster.
+2. Locate the changefeed you want to pause, and click **...** > **Pause** in the **Action** column.
+3. 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:
+
+    - Apache Kafka sink: all configurations except **Destination**, **Connection** and **Start Position**
+    - MySQL sink: all configurations except **Destination**, **Connection** and **Start Position**
+
+4. After editing the configuration, click **...** > **Resume** to resume the corresponding changefeed.
+
+</div>
+
+<div label="CLI">
+
+Edit a changefeed with Apache Kafka sink:
+
+```
+ticloud serverless changefeed edit -c <cluster-id> --changefeed-id <changefeed-id> --name <new-displayName> --kafka <full-specified-kafka> --filter <full-specified-filter>
+```
+
+Edit a changefeed with MySQL sink:
+
+```
+ticloud serverless changefeed edit -c <cluster-id> --changefeed-id <changefeed-id> --name <new-displayName> --mysql <full-specified-mysql> --filter <full-specified-filter>
+```
+
+</div>
+</SimpleTab>
+
+## Duplicate a changefeed
+
+1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster.
+2. Locate the changefeed that you want to duplicate. In the **Action** column, click **...** > **Duplicate**.
+3. TiDB Cloud automatically populates the new changefeed configuration with the original settings. You can review and modify the configuration as needed.
+4. After confirming the configuration, click **Submit** to create and start the new changefeed.
+
+## Delete a changefeed
+
+<SimpleTab>
+<div label="Console">
+
+1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster.
+2. Locate the corresponding changefeed you want to delete, and click **...** > **Delete** in the **Action** column.
+
+</div>
+
+<div label="CLI">
+
+```
+ticloud serverless changefeed delete -c <cluster-id> --changefeed-id <changefeed-id>
+```
+
+</div>
+</SimpleTab>
+
+## Changefeed billing
+
+Free of charge during the beta period.
+
+## Changefeed states
+
+During the running process, changefeeds might fail with errors, or be manually paused or resumed. These behaviors can lead to changes of the changefeed state.
+
+The states are described as follows:
+
+- `CREATING`: the changefeed is being created.
+- `CREATE_FAILED`: the changefeed creation fails. You need to delete the changefeed and create a new one.
+- `RUNNING`: the changefeed runs normally and the checkpoint-ts proceeds normally.
+- `PAUSED`: the changefeed is paused.
+- `WARNING`: the changefeed returns a warning. The changefeed 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](https://docs.pingcap.com/tidb/stable/garbage-collection-overview).
+- `RUNNING_FAILED`: the changefeed fails. Due to some errors, the changefeed cannot resume and cannot be recovered automatically. If the issues are resolved before the garbage collection (GC) of the incremental data, you can manually resume the failed changefeed. The default Time-To-Live (TTL) duration for incremental data is 24 hours, which means that the GC mechanism does not delete any data within 24 hours after the changefeed is interrupted.