--- title: "Replicating TiDB Change Events Using TiCDC" version: "v2" status: "GA" description: "In this hands-on lab, you will learn how to replicate TiDB change events using TiCDC. Specifically, we will cover how to deploy TiCDC, create a replication task, and remove a TiCDC cluster." --- # Lab 11: Replicating TiDB Change Events Using TiCDC ## Overview >[!NOTE] > This hands-on lab is also included in the [TiDB Certification Training: TiDB Administration Using TiUP](https://www.pingcap.com/education/course-tidb-database-administration-for-self-hosted-deployments/) course. In this lab, you add TiCDC to an existing TiDB cluster using TiUP and create a replication task from the TiDB to the MySQL, then remove the TiCDC node. The following shows the deployment topology diagram of TiDB cluster. ![60%](https://lab-static.pingcap.com/quick-demo/TiDBClusterDeploymentTopologyExercisewithTiCDC_aa_003_20230301.png) + The TiCDC is used for replicating incremental data of upstream TiDB instance to downstream databases which is a MySQL instance. The following shows the topology diagram of `TiCDC`. ![60%](https://lab-static.pingcap.com/quick-demo/TiCDCLabToplogy_aa_003_20220626.png) > [!TIP] > Click **Start** to launch the lab environment. > Once the environment is ready, select **Next** on the bottom toolbar to advance to **Module 1**. > And, follow the step-by-step lab guide to connect to the hands-on environment and begin your tasks. ## Module 1: Deploying TiCDC ### Step 1. Log into the remote Linux + Click here - [Terminal 1](ssh://monitor1-ssh#1) to open a new terminal connected to the virtual machine assigned for your hands-on lab. + The banner after you logged in: ```output , #_ ~\_ ####_ Amazon Linux 2 ~~ \_#####\ ~~ \###| ~~ \#/ ___ ~~ V~' '-> ~~~ / A newer version of Amazon Linux is available! ~~._. _/ _/ _/ Amazon Linux 2023, GA and supported until 2028-03-15. _/m/' https://aws.amazon.com/linux/amazon-linux-2023/ ``` ### Step 2. Check the status of the TiDB cluster ```bash tiup cluster display tidb-test ``` ```output tiup is checking updates for component cluster ... Starting component `cluster`: /root/.tiup/components/cluster/v1.10.2/tiup-cluster display tidb-test Cluster type: tidb Cluster name: tidb-test Cluster version: v7.5.1 Deploy user: tidb SSH type: builtin Dashboard URL: http://10.90.1.34:2379/dashboard Grafana URL: http://10.90.4.231:3000 ID Role Host Ports OS/Arch Status Data Dir Deploy Dir -- ---- ---- ----- ------- ------ -------- ---------- 10.90.4.231:9093 alertmanager 10.90.4.231 9093/9094 linux/x86_64 Up /tidb-data/alertmanager-9093 /tidb-deploy/alertmanager-9093 10.90.4.231:3000 grafana 10.90.4.231 3000 linux/x86_64 Up - /tidb-deploy/grafana-3000 10.90.1.34:2379 pd 10.90.1.34 2379/2380 linux/x86_64 Up|L|UI /tidb-data/pd-2379 /tidb-deploy/pd-2379 10.90.2.38:2379 pd 10.90.2.38 2379/2380 linux/x86_64 Up /tidb-data/pd-2379 /tidb-deploy/pd-2379 10.90.3.188:2379 pd 10.90.3.188 2379/2380 linux/x86_64 Up /tidb-data/pd-2379 /tidb-deploy/pd-2379 10.90.4.231:9090 prometheus 10.90.4.231 9090/12020 linux/x86_64 Up /tidb-data/prometheus-9090 /tidb-deploy/prometheus-9090 10.90.1.69:4000 tidb 10.90.1.69 4000/10080 linux/x86_64 Up - /tidb-deploy/tidb-4000 10.90.2.35:4000 tidb 10.90.2.35 4000/10080 linux/x86_64 Up - /tidb-deploy/tidb-4000 10.90.4.53:9000 tiflash 10.90.4.53 9000/8123/3930/20170/20292/8234 linux/x86_64 Up /tidb-data/tiflash-9000 /tidb-deploy/tiflash-9000 10.90.1.162:20160 tikv 10.90.1.162 20160/20180 linux/x86_64 Up /tidb-data/tikv-20160 /tidb-deploy/tikv-20160 10.90.2.108:20160 tikv 10.90.2.108 20160/20180 linux/x86_64 Up /tidb-data/tikv-20160 /tidb-deploy/tikv-20160 10.90.3.12:20160 tikv 10.90.3.12 20160/20180 linux/x86_64 Up /tidb-data/tikv-20160 /tidb-deploy/tikv-20160 Total nodes: 12 ``` ### Step 3. Read the file solution-three-nodes-scale-out-ticdc.yaml ```bash cat solution-three-nodes-scale-out-ticdc.yaml ``` ```output cdc_servers: - host: 10.90.2.84 gc-ttl: 86400 data_dir: "/cdc-data" - host: 10.90.2.134 gc-ttl: 86400 data_dir: "/cdc-data" - host: 10.90.2.214 gc-ttl: 86400 data_dir: "/cdc-data" ``` ### Step 4. Deploy TiCDC nodes ```bash tiup cluster scale-out tidb-test --user ec2-user -i ~/.ssh/pe-class-key-${LAB:REGION_NAME}.pem solution-three-nodes-scale-out-ticdc.yaml ``` ```output ... Do you want to continue? [y/N]: (default=N) y ... Scaled cluster `tidb-test` out successfully ``` ### Step 5. Check the status of the TiDB cluster ```bash tiup cluster display tidb-test ``` ```output tiup is checking updates for component cluster ... Starting component `cluster`: /home/ec2-user/.tiup/components/cluster/v1.12.1/tiup-cluster display tidb-test Cluster type: tidb Cluster name: tidb-test Cluster version: v7.5.1 Deploy user: tidb SSH type: builtin Dashboard URL: http://10.90.1.34:2379/dashboard Grafana URL: http://10.90.4.231:3000 ID Role Host Ports OS/Arch Status Data Dir Deploy Dir -- ---- ---- ----- ------- ------ -------- ---------- 10.90.4.231:9093 alertmanager 10.90.4.231 9093/9094 linux/x86_64 Up /tidb-data/alertmanager-9093 /tidb-deploy/alertmanager-9093 10.90.1.34:8300 cdc 10.90.1.34 8300 linux/x86_64 Up /cdc-data /tidb-deploy/cdc-8300 10.90.2.38:8300 cdc 10.90.2.38 8300 linux/x86_64 Up /cdc-data /tidb-deploy/cdc-8300 10.90.3.188:8300 cdc 10.90.3.188 8300 linux/x86_64 Up /cdc-data /tidb-deploy/cdc-8300 10.90.4.231:3000 grafana 10.90.4.231 3000 linux/x86_64 Up - /tidb-deploy/grafana-3000 10.90.1.34:2379 pd 10.90.1.34 2379/2380 linux/x86_64 Up|L|UI /tidb-data/pd-2379 /tidb-deploy/pd-2379 10.90.2.38:2379 pd 10.90.2.38 2379/2380 linux/x86_64 Up /tidb-data/pd-2379 /tidb-deploy/pd-2379 10.90.3.188:2379 pd 10.90.3.188 2379/2380 linux/x86_64 Up /tidb-data/pd-2379 /tidb-deploy/pd-2379 10.90.4.231:9090 prometheus 10.90.4.231 9090/12020 linux/x86_64 Up /tidb-data/prometheus-9090 /tidb-deploy/prometheus-9090 10.90.1.69:4000 tidb 10.90.1.69 4000/10080 linux/x86_64 Up - /tidb-deploy/tidb-4000 10.90.2.35:4000 tidb 10.90.2.35 4000/10080 linux/x86_64 Up - /tidb-deploy/tidb-4000 10.90.4.53:9000 tiflash 10.90.4.53 9000/8123/3930/20170/20292/8234 linux/x86_64 Up /tidb-data/tiflash-9000 /tidb-deploy/tiflash-9000 10.90.1.162:20160 tikv 10.90.1.162 20160/20180 linux/x86_64 Up /tidb-data/tikv-20160 /tidb-deploy/tikv-20160 10.90.2.108:20160 tikv 10.90.2.108 20160/20180 linux/x86_64 Up /tidb-data/tikv-20160 /tidb-deploy/tikv-20160 10.90.3.12:20160 tikv 10.90.3.12 20160/20180 linux/x86_64 Up /tidb-data/tikv-20160 /tidb-deploy/tikv-20160 Total nodes: 15 ``` ### Step 6. Check the status of TiCDC cluster ```bash tiup ctl:v7.5.1 cdc capture list --pd=http://${HOST_PD1_PRIVATE_IP}:2379 ``` ```output ... Starting component `ctl`: /home/ec2-user/.tiup/components/ctl/v7.5.1/ctl cdc capture list --pd=http://10.80.0.224:2379 [ { "id": "1c15e075-1435-464c-af66-92ba0286a7fe", "is-owner": false, "address": "10.90.1.34:8300", "cluster-id": "default" }, { "id": "4399c858-e811-4d9e-9b08-fb5690c097ec", "is-owner": true, "address": "10.90.2.38:8300", "cluster-id": "default" }, { "id": "5982fa7d-c755-409a-88d5-03527c8a0fcd", "is-owner": false, "address": "10.90.3.188:8300", "cluster-id": "default" } ] ``` ## Module 2: Creating a Replication Task ### Step 1. SSH to PD1 ```bash ./ssh-to-pd1.sh ``` ```output ... Last login: Sun Oct 15 21:44:34 2023 ... ``` ### Step 2. Start MySQL server on PD1 ```bash sudo service mysqld start ``` ### Step 3. Login to MySQL + Login MySQL server on port 3306 as `root@'localhost'` with the password `q1w2e3R4_`. ```bash mysql -u root -p -h 127.0.0.1 -P 3306 -pq1w2e3R4_ ``` ### Step 4. Create a user for the change capture task ```sql CREATE USER cdc_user@'%' IDENTIFIED BY 'q1w2e3R4_'; ``` ```output mysql> CREATE USER cdc_user@'%' IDENTIFIED BY 'q1w2e3R4_'; Query OK, 0 rows affected (0.00 sec) ``` ```sql GRANT ALL PRIVILEGES on *.* to cdc_user@'%'; ``` ```output mysql> GRANT ALL PRIVILEGES on *.* to cdc_user@'%'; Query OK, 0 rows affected (0.00 sec) ``` ```sql EXIT; ``` ```output mysql> EXIT; ``` ### Step 5. Load timezone for upstream MySQL database ```bash mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql -pq1w2e3R4_ ``` ```output mysql: [Warning] Using a password on the command line interface can be insecure. Warning: Unable to load '/usr/share/zoneinfo/iso3166.tab' as time zone. Skipping it. Warning: Unable to load '/usr/share/zoneinfo/leapseconds' as time zone. Skipping it. Warning: Unable to load '/usr/share/zoneinfo/tzdata.zi' as time zone. Skipping it. Warning: Unable to load '/usr/share/zoneinfo/zone.tab' as time zone. Skipping it. Warning: Unable to load '/usr/share/zoneinfo/zone1970.tab' as time zone. Skipping it. ``` ### Step 6. Create schema for the downstream MySQL + Connect to MySQL with port 3306 as a downstream database, and create a new database called `test`, with a table called `T1`. The `T1` table should have a primary key column called `id` and a `VARCHAR(20)` column called `name`. And then exit the mysql client. ```bash mysql -u root -h 127.0.0.1 -P 3306 -pq1w2e3R4_ ``` ```sql DROP DATABASE IF EXISTS test; CREATE DATABASE test; CREATE TABLE test.T1(id INT PRIMARY KEY, name VARCHAR(20)); SELECT * FROM test.T1; ``` ```sql EXIT; ``` ### Step 7. Open a second terminal (Terminal 2), and create schema on TiDB + Click here - [Terminal 2](ssh://monitor1-ssh#2) to open a new terminal connected to the virtual machine assigned for your hands-on lab. + The banner after you logged in: ```output , #_ ~\_ ####_ Amazon Linux 2 ~~ \_#####\ ~~ \###| ~~ \#/ ___ ~~ V~' '-> ~~~ / A newer version of Amazon Linux is available! ~~._. _/ _/ _/ Amazon Linux 2023, GA and supported until 2028-03-15. _/m/' https://aws.amazon.com/linux/amazon-linux-2023/ ``` ```bash mysql -h${HOST_DB1_PRIVATE_IP} -P4000 -uroot ``` ```sql DROP DATABASE IF EXISTS test; CREATE DATABASE test; CREATE TABLE test.T1(id INT PRIMARY KEY, name VARCHAR(20)); SELECT * FROM test.T1; EXIT; ``` ### Step 8. In Terminal 2, create a replication task + In [Terminal 2](ssh://monitor1-ssh#2) on `monitor1`, execute `cdc:v7.5.1 cli` command to create a replication task. Pay attention to the `cdc:v7.5.1` version, if you omit the version tag, the most up-to-date version might not be compatible with our TiDB cluster. You might receive a warning message, stating that some tables are not eligible to replicate, because they do not have a primary key or a not-null unique key. Those are the tables left over from previous labs. Simple choose `Y` to ignore those tables. + Here are some detail explanations of the commands + `--pd=http://${HOST_PD1_PRIVATE_IP}:2379`: IP address of one of the PD nodes. + `--sink-uri="mysql://cdc_user:q1w2e3R4_@${HOST_PD1_PRIVATE_IP}:3306/"`: The downstream address of the replication task: ${HOST_PD1_PRIVATE_IP}, and the port is: 3306 + `--changefeed-id="replication-task-1" --sort-engine="unified"`: The ID of the replication task. ```bash tiup cdc:v7.5.1 cli changefeed create --pd=http://${HOST_PD1_PRIVATE_IP}:2379 \ --sink-uri="mysql://cdc_user:q1w2e3R4_@${HOST_PD1_PRIVATE_IP}:3306/" \ --changefeed-id="replication-task-1" --sort-engine="unified" ``` ```output tiup cdc:v7.5.1 cli changefeed create --pd=http://${HOST_PD1_PRIVATE_IP}:2379 \ > --sink-uri="mysql://cdc_user:q1w2e3R4_@${HOST_PD1_PRIVATE_IP}:3306/" \ > --changefeed-id="replication-task-1" --sort-engine="unified" Starting component `cdc`: /home/ec2-user/.tiup/components/cdc/v7.5.1/cdc cli changefeed create --pd=http://10.80.0.224:2379 --sink-uri=mysql://cdc_user:q1w2e3R4_@10.80.0.224:3306/ --changefeed-id=replication-task-1 --sort-engine=unified Create changefeed successfully! ID: replication-task-1 Info: {"upstream-id":0,"sink-uri":"mysql://cdc_user:q1w2e3R4_@10.80.0.224:3306/","opts":{},"create-time":"2023-02-13T12:54:53.673149259Z","start-ts":439430124303286275,"target-ts":0,"admin-job-type":0,"sort-engine":"unified","sort-dir":"","config":{"case-sensitive":true,"enable-old-value":true,"force-replicate":false,"check-gc-safe-point":true,"filter":{"rules":["*.*"],"ignore-txn-start-ts":null},"mounter":{"worker-num":16},"sink":{"dispatchers":null,"protocol":"","column-selectors":null,"schema-registry":""},"cyclic-replication":{"enable":false,"replica-id":0,"filter-replica-ids":null,"id-buckets":0,"sync-ddl":false},"consistent":{"level":"none","max-log-size":64,"flush-interval":1000,"storage":""}},"state":"normal","error":null,"sync-point-enabled":false,"sync-point-interval":600000000000,"creator-version":"v6.1.0"} ``` ### Step 9. In Terminal 2, query the replication task list ```bash tiup cdc:v7.5.1 cli changefeed list --pd=http://${HOST_PD1_PRIVATE_IP}:2379 ``` ```output Starting component `cdc`: /home/ec2-user/.tiup/components/cdc/v7.5.1/cdc cli changefeed list --pd=http://10.80.0.224:2379 [ { "id": "replication-task-1", "summary": { "state": "normal", "tso": 439430205069852673, "checkpoint": "2023-02-13 13:00:01.713", "error": null } } ] ``` ### Step 10. In Terminal 2, query the specific replication task ```bash tiup cdc:v7.5.1 cli changefeed query --pd=http://${HOST_PD3_PRIVATE_IP}:2379 --changefeed-id=replication-task-1 ``` ```output Starting component `cdc`: /home/ec2-user/.tiup/components/cdc/v7.5.1/cdc cli changefeed query --pd=http://10.80.0.12:2379 --changefeed-id=replication-task-1 { "upstream_id": 7231813390813770262, "namespace": "default", "id": "replication-task-1", "sink_uri": "mysql://cdc_user:xxxxx@10.90.3.188:3306/", "config": { "memory_quota": 1073741824, "case_sensitive": true, "enable_old_value": true, "force_replicate": false, "ignore_ineligible_table": false, "check_gc_safe_point": true, "enable_sync_point": false, "bdr_mode": false, "sync_point_interval": 600000000000, "sync_point_retention": 86400000000000, "filter": { "rules": [ "*.*" ], "event_filters": null }, "mounter": { "worker_num": 16 }, "sink": { "protocol": "", "schema_registry": "", "csv": { "delimiter": ",", "quote": "\"", "null": "\\N", "include_commit_ts": false }, "column_selectors": null, "transaction_atomicity": "", "encoder_concurrency": 16, "terminator": "\r\n", "date_separator": "none", "enable_partition_separator": false }, "consistent": { "level": "none", "max_log_size": 64, "flush_interval": 2000, "storage": "" } }, "create_time": "2023-05-11 07:09:04.259", "start_ts": 441395168967655437, "resolved_ts": 441395195247853571, "target_ts": 0, "checkpoint_tso": 441395195247853571, "checkpoint_time": "2023-05-11 07:10:44.372", "sort_engine": "unified", "state": "normal", "error": null, "error_history": null, "creator_version": "", "task_status": [ { "capture_id": "4399c858-e811-4d9e-9b08-fb5690c097ec", "table_ids": [], "table_operations": null }, { "capture_id": "5982fa7d-c755-409a-88d5-03527c8a0fcd", "table_ids": [], "table_operations": null }, { "capture_id": "1c15e075-1435-464c-af66-92ba0286a7fe", "table_ids": [ 80 ], "table_operations": null } ] } ``` ### Step 11. In Terminal 2, insert data into the upstream TIDB ```bash mysql -h${HOST_DB1_PRIVATE_IP} -P4000 -uroot ``` ```sql SELECT * FROM test.T1; ``` ```output mysql> SELECT * FROM test.T1; Empty set (0.01 sec) ``` ```sql INSERT INTO test.T1 VALUES(1, 'Tom'); ``` ```output mysql> INSERT INTO test.T1 VALUES(1, 'Tom'); Query OK, 1 row affected (0.00 sec) ``` ```sql SELECT * FROM test.T1; ``` ```output mysql> SELECT * FROM test.T1; +----+------+ | id | name | +----+------+ | 1 | Tom | +----+------+ 1 row in set (0.00 sec) ``` ```sql EXIT; ``` ### Step 12. In Terminal 1, check the results in the downstream MySQL ```bash mysql -u cdc_user -h ${HOST_PD1_PRIVATE_IP} -P 3306 -pq1w2e3R4_ ``` ```sql SELECT * FROM test.T1; ``` ```output mysql> SELECT * FROM test.T1; +----+------+ | id | name | +----+------+ | 1 | Tom | +----+------+ 1 row in set (0.00 sec) ``` ```sql EXIT; ``` ```output mysql> EXIT; ``` ## Module 3: Removing the TiCDC Cluster ### Step 1. In Terminal 2, pause the replication task ```bash tiup cdc:v7.5.1 cli changefeed pause --pd=http://${HOST_PD1_PRIVATE_IP}:2379 --changefeed-id replication-task-1 ``` ### Step 2. In Terminal 2, remove the replication task ```bash tiup cdc:v7.5.1 cli changefeed remove --pd=http://${HOST_PD1_PRIVATE_IP}:2379 --changefeed-id replication-task-1 ``` ### Step 3. In Terminal 2, query the replication task ```bash tiup cdc:v7.5.1 cli changefeed list --pd=http://${HOST_PD3_PRIVATE_IP}:2379 ``` ```output Starting component `cdc`: /home/ec2-user/.tiup/components/cdc/v7.5.1/cdc cli changefeed list --pd=http://10.80.0.12:2379 [] ``` ### Step 4. Remove the TiCDC cluster ```bash tiup cluster scale-in tidb-test --node ${HOST_PD1_PRIVATE_IP}:8300 --node ${HOST_PD2_PRIVATE_IP}:8300 --node ${HOST_PD3_PRIVATE_IP}:8300 --yes ``` ```output ... Scaled cluster `tidb-test` in successfully ``` ### Step 5. Check the status of the TiDB cluster ```bash tiup cluster display tidb-test ``` ```output tiup is checking updates for component cluster ... Starting component `cluster`: /home/ec2-user/.tiup/components/cluster/v1.12.1/tiup-cluster display tidb-test Cluster type: tidb Cluster name: tidb-test Cluster version: v7.5.1 Deploy user: tidb SSH type: builtin Dashboard URL: http://10.90.1.34:2379/dashboard Grafana URL: http://10.90.4.231:3000 ID Role Host Ports OS/Arch Status Data Dir Deploy Dir -- ---- ---- ----- ------- ------ -------- ---------- 10.90.4.231:9093 alertmanager 10.90.4.231 9093/9094 linux/x86_64 Up /tidb-data/alertmanager-9093 /tidb-deploy/alertmanager-9093 10.90.4.231:3000 grafana 10.90.4.231 3000 linux/x86_64 Up - /tidb-deploy/grafana-3000 10.90.1.34:2379 pd 10.90.1.34 2379/2380 linux/x86_64 Up|L|UI /tidb-data/pd-2379 /tidb-deploy/pd-2379 10.90.2.38:2379 pd 10.90.2.38 2379/2380 linux/x86_64 Up /tidb-data/pd-2379 /tidb-deploy/pd-2379 10.90.3.188:2379 pd 10.90.3.188 2379/2380 linux/x86_64 Up /tidb-data/pd-2379 /tidb-deploy/pd-2379 10.90.4.231:9090 prometheus 10.90.4.231 9090/12020 linux/x86_64 Up /tidb-data/prometheus-9090 /tidb-deploy/prometheus-9090 10.90.1.69:4000 tidb 10.90.1.69 4000/10080 linux/x86_64 Up - /tidb-deploy/tidb-4000 10.90.2.35:4000 tidb 10.90.2.35 4000/10080 linux/x86_64 Up - /tidb-deploy/tidb-4000 10.90.4.53:9000 tiflash 10.90.4.53 9000/8123/3930/20170/20292/8234 linux/x86_64 Up /tidb-data/tiflash-9000 /tidb-deploy/tiflash-9000 10.90.1.162:20160 tikv 10.90.1.162 20160/20180 linux/x86_64 Up /tidb-data/tikv-20160 /tidb-deploy/tikv-20160 10.90.2.108:20160 tikv 10.90.2.108 20160/20180 linux/x86_64 Up /tidb-data/tikv-20160 /tidb-deploy/tikv-20160 10.90.3.12:20160 tikv 10.90.3.12 20160/20180 linux/x86_64 Up /tidb-data/tikv-20160 /tidb-deploy/tikv-20160 Total nodes: 12 ``` ## End of Exercises