Skip to content

Commit fc3a68c

Browse files
hongyunyanti-chi-bot
authored andcommitted
This is an automated cherry-pick of pingcap#20967
Signed-off-by: ti-chi-bot <[email protected]>
1 parent 40a1b0a commit fc3a68c

File tree

3 files changed

+80
-0
lines changed

3 files changed

+80
-0
lines changed

TOC.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,34 @@
129129
- Integration Scenarios
130130
- [Integrate with Confluent Cloud and Snowflake](/ticdc/integrate-confluent-using-ticdc.md)
131131
- [Integrate with Apache Kafka and Apache Flink](/replicate-data-to-kafka.md)
132+
<<<<<<< HEAD
133+
=======
134+
- Reference
135+
- [TiCDC Architecture](/ticdc/ticdc-architecture.md)
136+
- [TiCDC Data Replication Capabilities](/ticdc/ticdc-data-replication-capabilities.md)
137+
- [TiCDC Server Configurations](/ticdc/ticdc-server-config.md)
138+
- [TiCDC Changefeed Configurations](/ticdc/ticdc-changefeed-config.md)
139+
- [TiCDC Client Authentication](/ticdc/ticdc-client-authentication.md)
140+
- [Data Integrity Validation for Single-Row Data](/ticdc/ticdc-integrity-check.md)
141+
- [Data Consistency Validation for Upstream and Downstream TiDB Clusters](/ticdc/ticdc-upstream-downstream-check.md)
142+
- [TiCDC Behavior in Splitting UPDATE Events](/ticdc/ticdc-split-update-behavior.md)
143+
- Output Protocols
144+
- [TiCDC Avro Protocol](/ticdc/ticdc-avro-protocol.md)
145+
- [TiCDC Canal-JSON Protocol](/ticdc/ticdc-canal-json.md)
146+
- [TiCDC CSV Protocol](/ticdc/ticdc-csv.md)
147+
- [TiCDC Debezium Protocol](/ticdc/ticdc-debezium.md)
148+
- [TiCDC Open Protocol](/ticdc/ticdc-open-protocol.md)
149+
- [TiCDC Simple Protocol](/ticdc/ticdc-simple-protocol.md)
150+
- [TiCDC Open API v2](/ticdc/ticdc-open-api-v2.md)
151+
- [TiCDC Open API v1](/ticdc/ticdc-open-api.md)
152+
- TiCDC Data Consumption
153+
- [TiCDC Row Data Checksum Verification Based on Avro](/ticdc/ticdc-avro-checksum-verification.md)
154+
- [Guide for Developing a Storage Sink Consumer](/ticdc/ticdc-storage-consumer-dev-guide.md)
155+
- [TiCDC Compatibility](/ticdc/ticdc-compatibility.md)
156+
- [Troubleshoot](/ticdc/troubleshoot-ticdc.md)
157+
- [FAQs](/ticdc/ticdc-faq.md)
158+
- [Glossary](/ticdc/ticdc-glossary.md)
159+
>>>>>>> 2ebdc6db76 (ticdc: add new doc for TiCDC data replication capabilities (#20967))
132160
- Maintain
133161
- Security
134162
- [Best Practices for TiDB Security Configuration](/best-practices-for-security-configuration.md)
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: TiCDC Data Replication Capabilities
3+
summary: Learn the data replication capabilities of TiCDC.
4+
---
5+
6+
# TiCDC Data Replication Capabilities
7+
8+
[TiCDC](/ticdc/ticdc-overview.md) (TiDB Change Data Capture) is a core component in the TiDB ecosystem for real-time data replication. This document provides a detailed explanation of TiCDC data replication capabilities.
9+
10+
## How TiCDC works
11+
12+
- TiCDC listens to TiKV change logs (Raft logs) and converts row-level data changes (`INSERT`, `UPDATE`, and `DELETE` operations) into downstream-compatible SQL statements. TiCDC does not rely on the original SQL statements executed on the upstream database. For details, see [how TiCDC processes data changes](/ticdc/ticdc-overview.md#implementation-of-processing-data-changes).
13+
14+
- TiCDC generates logical operations (such as `INSERT`, `UPDATE`, and `DELETE`) equivalent to SQL semantics, rather than restoring the original SQL statements executed on the upstream database one by one. For details, see [how TiCDC processes data changes](/ticdc/ticdc-overview.md#implementation-of-processing-data-changes).
15+
16+
- TiCDC ensures eventual consistency of transactions. With [redo log](/ticdc/ticdc-sink-to-mysql.md#eventually-consistent-replication-in-disaster-scenarios) enabled, TiCDC can guarantee eventual consistency in disaster recovery scenarios. With [Syncpoint](/ticdc/ticdc-upstream-downstream-check.md#enable-syncpoint) enabled, TiCDC supports consistent snapshot reads and data consistency validation.
17+
18+
## Supported downstream systems
19+
20+
TiCDC supports replicating data to various downstream systems, including the following:
21+
22+
- [TiDB database or other MySQL-compatible databases](/ticdc/ticdc-sink-to-mysql.md)
23+
- [Apache Kafka](/ticdc/ticdc-sink-to-kafka.md)
24+
- [Message Queue (MQ)-type sinks](/ticdc/ticdc-changefeed-config.md#sink), such as [Pulsar](/ticdc/ticdc-sink-to-pulsar.md)
25+
- [Storage services (Amazon S3, GCS, Azure Blob Storage, and NFS)](/ticdc/ticdc-sink-to-cloud-storage.md)
26+
- [Snowflake, ksqlDB, SQL Server via Confluent Cloud integration](/ticdc/integrate-confluent-using-ticdc.md)
27+
- [Apache Flink for consuming Kafka-replicated data](/replicate-data-to-kafka.md)
28+
29+
## Scope of data replication
30+
31+
TiCDC supports the following types of upstream data changes:
32+
33+
+ **Supported:**
34+
35+
- DDL and DML statements(excluding system tables).
36+
- Index operations (`ADD INDEX`, `CREATE INDEX`): to reduce the impact on changefeed replication latency, if the downstream is TiDB, TiCDC [asynchronously executes the `ADD INDEX` and `CREATE INDEX` DDL operations](/ticdc/ticdc-ddl.md#asynchronous-execution-of-add-index-and-create-index-ddls).
37+
- Foreign key constraint DDL statements (`ADD FOREIGN KEY`): TiCDC does **not** replicate upstream system variable settings. You need to manually configure [`foreign_key_checks`](/system-variables.md#foreign_key_checks) in the downstream to determine whether the downstream foreign key constraint check is enabled. TiCDC does **not** validate whether the data complies with foreign key constraints.
38+
39+
+ **Not supported**:
40+
41+
- DDL and DML statements executed in upstream system tables (including `mysql.*` and `information_schema.*`).
42+
- DDL and DML statements executed in upstream temporary tables.
43+
- DQL (Data Query Language) and DCL (Data Control Language) statements.
44+
45+
## Limitations​
46+
47+
- TiCDC does not support certain scenarios. For details, see [unsupported scenarios](/ticdc/ticdc-overview.md#unsupported-scenarios).
48+
- TiCDC only verifies the integrity of upstream data changes. It does not validate whether the changes conform to upstream or downstream constraints. If the data violates downstream constraints, TiCDC will return an error when writing to the downstream. For example, TiCDC does **not** perform any foreign key validation.

ticdc/ticdc-overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ summary: Learn what TiCDC is, what features TiCDC provides, etc.
55

66
# TiCDC Overview
77

8+
<<<<<<< HEAD
89
[TiCDC](https://github.com/pingcap/tiflow/tree/master/cdc) is a tool used for replicating incremental data of TiDB. Specifically, TiCDC pulls TiKV change logs, sorts captured data, and exports row-based incremental data to downstream databases.
10+
=======
11+
[TiCDC](https://github.com/pingcap/tiflow/tree/master/cdc) is a tool used to replicate incremental data from TiDB. Specifically, TiCDC pulls TiKV change logs, sorts captured data, and exports row-based incremental data to downstream databases. For detailed data replication capabilities, see [TiCDC Data Replication Capabilities](/ticdc/ticdc-data-replication-capabilities.md).
12+
>>>>>>> 2ebdc6db76 (ticdc: add new doc for TiCDC data replication capabilities (#20967))
913
1014
## Usage scenarios
1115

0 commit comments

Comments
 (0)