Skip to content

Commit 5f3602c

Browse files
authored
Describe TiCDC support in TiFlash (#20681) (#20686)
1 parent f403725 commit 5f3602c

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

ticdc/ticdc-compatibility.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,13 @@ In the physical import mode, TiDB Lightning imports data by inserting SST files
2828
1. Use the offline import tool provided by your downstream system to import TiDB Lightning's input files.
2929
2. Create a changefeed to replicate subsequent incremental data written through SQL. For more information, see [Create a replication task](/ticdc/ticdc-manage-changefeed.md#create-a-replication-task).
3030

31+
## Compatibility with TiFlash
32+
33+
Currently, when you use TiCDC to replicate tables to a downstream TiDB cluster, creating TiFlash replicas for the tables is not supported, which means that TiCDC does not support replicating TiFlash-related DDL statements, such as:
34+
35+
* `ALTER TABLE table_name SET TIFLASH REPLICA count;`
36+
* `ALTER DATABASE db_name SET TIFLASH REPLICA count;`
37+
3138
## CLI and configuration file compatibility
3239

3340
* In TiCDC v4.0.0, `ignore-txn-commit-ts` is removed and `ignore-txn-start-ts` is added, which uses start_ts to filter transactions.

tiflash/create-tiflash-replicas.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,11 @@ ALTER TABLE `tpch50`.`lineitem` SET TIFLASH REPLICA 0;
5353

5454
* In v5.1 and later versions, setting the replicas for the system tables is no longer supported. Before upgrading the cluster, you need to clear the replicas of the relevant system tables. Otherwise, you cannot modify the replica settings of the system tables after you upgrade the cluster to a later version.
5555

56+
* Currently, when you use TiCDC to replicate tables to a downstream TiDB cluster, creating TiFlash replicas for the tables is not supported, which means that TiCDC does not support replicating TiFlash-related DDL statements, such as:
57+
58+
* `ALTER TABLE table_name SET TIFLASH REPLICA count;`
59+
* `ALTER DATABASE db_name SET TIFLASH REPLICA count;`
60+
5661
### Check replication progress
5762

5863
You can check the status of the TiFlash replicas of a specific table using the following statement. The table is specified using the `WHERE` clause. If you remove the `WHERE` clause, you will check the replica status of all tables.
@@ -103,6 +108,8 @@ Examples:
103108
>
104109
> - This statement skips system tables, views, temporary tables, and tables with character sets not supported by TiFlash.
105110

111+
> - You can control the number of tables allowed to remain unavailable during execution by setting the [`tidb_batch_pending_tiflash_count`](/system-variables.md#tidb_batch_pending_tiflash_count-new-in-v60) system variable. Lowering this value helps reduce the pressure on the cluster during replication. Note that this limit is not real-time, so it is still possible for the number of unavailable tables to exceed the limit after the setting is applied.
112+
106113
### Check replication progress
107114

108115
Similar to creating TiFlash replicas for tables, successful execution of the DDL statement does not mean the completion of replication. You can execute the following SQL statement to check the progress of replication on target tables:

0 commit comments

Comments
 (0)