チェンジフィードを管理する

このドキュメントでは、TiCDC コマンドライン ツールcdc cliを使用して TiCDC 変更フィードを作成および管理する方法について説明します。TiCDC の HTTP インターフェイス経由で変更フィードを管理することもできます。詳細については、 TiCDC オープンAPIを参照してください。

レプリケーションタスクを作成する

レプリケーション タスクを作成するには、次のコマンドを実行します。

cdc cli changefeed create --server=http://10.0.10.25:8300 --sink-uri="mysql://root:123456@127.0.0.1:3306/" --changefeed-id="simple-replication-task"

Create changefeed successfully!
ID: simple-replication-task
Info: {"upstream_id":7178706266519722477,"namespace":"default","id":"simple-replication-task","sink_uri":"mysql://root:xxxxx@127.0.0.1:4000/?time-zone=","create_time":"2024-08-05T15:05:46.679218+08:00","start_ts":438156275634929669,"engine":"unified","config":{"case_sensitive":false,"enable_old_value":true,"force_replicate":false,"ignore_ineligible_table":false,"check_gc_safe_point":true,"enable_sync_point":true,"bdr_mode":false,"sync_point_interval":30000000000,"sync_point_retention":3600000000000,"filter":{"rules":["test.*"],"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":"none","encoder_concurrency":16,"terminator":"\r\n","date_separator":"none","enable_partition_separator":false},"consistent":{"level":"none","max_log_size":64,"flush_interval":2000,"storage":""}},"state":"normal","creator_version":"v7.5.3"}

レプリケーションタスクリストをクエリする

レプリケーション タスク リストを照会するには、次のコマンドを実行します。

cdc cli changefeed list --server=http://10.0.10.25:8300

[{
    "id": "simple-replication-task",
    "summary": {
      "state": "normal",
      "tso": 417886179132964865,
      "checkpoint": "2020-07-07 16:07:44.881",
      "error": null
    }
}]

• checkpoint 、TiCDC がこの時点より前にデータをダウンストリームにすでに複製していることを示します。
• stateレプリケーション タスクの状態を示します。
  • normal : レプリケーション タスクは正常に実行されます。
  • stopped : レプリケーション タスクが停止されています (手動で一時停止されています)。
  • error : レプリケーション タスクが停止しました (エラーにより)。
  • removed : レプリケーション タスクは削除されています。この状態のタスクは、 --allオプションを指定した場合にのみ表示されます。このオプションを指定していない場合にこれらのタスクを表示するには、 changefeed queryコマンドを実行します。
  • finished : レプリケーション タスクは終了しました (データはtarget-tsにレプリケートされています)。この状態のタスクは、 --allオプションを指定した場合にのみ表示されます。このオプションを指定していない場合にこれらのタスクを表示するには、 changefeed queryコマンドを実行します。

特定のレプリケーションタスクをクエリする

特定のレプリケーション タスクをクエリするには、 changefeed queryコマンドを実行します。クエリ結果には-s --simpleを指定すると、基本的なレプリケーション状態とチェックポイント情報のみを含むクエリ結果が簡略化されます。この引数を指定しない場合は、詳細なタスク構成、レプリケーション状態、およびレプリケーション テーブル情報が出力されます。

cdc cli changefeed query -s --server=http://10.0.10.25:8300 --changefeed-id=simple-replication-task

{
 "state": "normal",
 "tso": 419035700154597378,
 "checkpoint": "2020-08-27 10:12:19.579",
 "error": null
}

上記のコマンドと結果:

• stateは、現在の変更フィードのレプリケーション状態です。各状態は、 changefeed listの状態と一致している必要があります。
• tso 、ダウンストリームに正常に複製された現在の変更フィード内の最大のトランザクション TSO を表します。
• checkpoint 、ダウンストリームに正常に複製された現在の変更フィード内の最大トランザクション TSO に対応する時間を表します。
• error 、現在の変更フィードでエラーが発生したかどうかを記録します。

cdc cli changefeed query --server=http://10.0.10.25:8300 --changefeed-id=simple-replication-task

{
  "info": {
    "sink-uri": "mysql://127.0.0.1:3306/?max-txn-row=20\u0026worker-count=4",
    "opts": {},
    "create-time": "2020-08-27T10:33:41.687983832+08:00",
    "start-ts": 419036036249681921,
    "target-ts": 0,
    "admin-job-type": 0,
    "sort-engine": "unified",
    "sort-dir": ".",
    "config": {
      "case-sensitive": false,
      "filter": {
        "rules": [
          "*.*"
        ],
        "ignore-txn-start-ts": null,
        "ddl-allow-list": null
      },
      "mounter": {
        "worker-num": 16
      },
      "sink": {
        "dispatchers": null,
      },
      "scheduler": {
        "type": "table-number",
        "polling-time": -1
      }
    },
    "state": "normal",
    "history": null,
    "error": null
  },
  "status": {
    "resolved-ts": 419036036249681921,
    "checkpoint-ts": 419036036249681921,
    "admin-job-type": 0
  },
  "count": 0,
  "task-status": [
    {
      "capture-id": "97173367-75dc-490c-ae2d-4e990f90da0f",
      "status": {
        "tables": {
          "47": {
            "start-ts": 419036036249681921
          }
        },
        "operation": null,
        "admin-job-type": 0
      }
    }
  ]
}

上記のコマンドと結果:

• infoは、クエリされた変更フィードのレプリケーション構成です。
• statusは、クエリされた変更フィードのレプリケーション状態です。
  • resolved-ts : 現在の変更フィードにおける最大のトランザクションTSこのTS TiKV から TiCDC に正常に送信されたことに注意してください。
  • checkpoint-ts : 現在のchangefeedにおける最大のトランザクションTS 。このTSダウンストリームに正常に書き込まれたことに注意してください。
  • admin-job-type : 変更フィードのステータス:
    • 0 : 状態は正常です。
    • 1 : タスクは一時停止されています。タスクが一時停止されると、複製されたprocessor秒がすべて終了します。タスクの構成とレプリケーション ステータスは保持されるため、 checkpoint-tsからタスクを再開できます。
    • 2 : タスクが再開されます。レプリケーション タスクはcheckpoint-tsから再開されます。
    • 3 : タスクが削除されます。タスクが削除されると、すべてのprocessorが終了し、レプリケーション タスクの構成情報がクリアされます。レプリケーション ステータスのみが、後のクエリのために保持されます。
• task-status 、クエリされた変更フィード内の各レプリケーション サブタスクの状態を示します。

レプリケーションタスクを一時停止する

レプリケーション タスクを一時停止するには、次のコマンドを実行します。

cdc cli changefeed pause --server=http://10.0.10.25:8300 --changefeed-id simple-replication-task

上記のコマンドでは、

• --changefeed-id=uuid 、一時停止するレプリケーション タスクに対応する変更フィードの ID を表します。

レプリケーションタスクを再開する

一時停止したレプリケーション タスクを再開するには、次のコマンドを実行します。

cdc cli changefeed resume --server=http://10.0.10.25:8300 --changefeed-id simple-replication-task

• --changefeed-id=uuid 、再開するレプリケーション タスクに対応する変更フィードの ID を表します。
• --overwrite-checkpoint-ts : v6.2.0 以降では、レプリケーション タスクを再開する開始 TSO を指定できます。TiCDC は、指定された TSO からデータのプルを開始します。引数はnowまたは特定の TSO (434873584621453313 など) を受け入れます。指定された TSO は、(GC セーフ ポイント、CurrentTSO] の範囲内である必要があります。この引数が指定されていない場合、TiCDC はデフォルトで現在のcheckpoint-tsからデータを複製します。
• --no-confirm : レプリケーションが再開されたときに、関連情報を確認する必要はありません。デフォルトはfalseです。

注記：

• --overwrite-checkpoint-ts （ t2 ）で指定されたTSOがchangefeed（ t1 ）の現在のチェックポイントTSOよりも大きい場合、 t1とt2の間のデータは下流に複製されません。これによりデータ損失が発生します。13 cdc cli changefeed query実行するとt1取得できます。
• --overwrite-checkpoint-ts （ t2 ）で指定されたTSOがチェンジフィード（ t1 ）の現在のチェックポイントTSOよりも小さい場合、TiCDCは古い時点（ t2 ）からデータをプルし、データの重複が発生する可能性があります（たとえば、ダウンストリームがMQシンクの場合）。

レプリケーションタスクを削除する

レプリケーション タスクを削除するには、次のコマンドを実行します。

cdc cli changefeed remove --server=http://10.0.10.25:8300 --changefeed-id simple-replication-task

上記のコマンドでは、

• --changefeed-id=uuid 、削除するレプリケーション タスクに対応する変更フィードの ID を表します。

タスク構成の更新

TiCDC は、レプリケーション タスクの構成の変更をサポートしています (動的ではありません)。changefeed 構成を変更するには、タスクを一時停止し、構成を変更してから、タスクを再開します。

cdc cli changefeed pause -c test-cf --server=http://10.0.10.25:8300
cdc cli changefeed update -c test-cf --server=http://10.0.10.25:8300 --sink-uri="mysql://127.0.0.1:3306/?max-txn-row=20&worker-count=8" --config=changefeed.toml
cdc cli changefeed resume -c test-cf --server=http://10.0.10.25:8300

現在、次の構成項目を変更できます。

• 変更フィードのsink-uri 。
• changefeed 構成ファイルとファイル内のすべての構成項目。
• チェンジフィードのtarget-ts 。

レプリケーションサブタスクの処理単位を管理する（ processor ）

• processorリストをクエリします:

  cdc cli processor list --server=http://10.0.10.25:8300
  

  [
          {
                  "id": "9f84ff74-abf9-407f-a6e2-56aa35b33888",
                  "capture-id": "b293999a-4168-4988-a4f4-35d9589b226b",
                  "changefeed-id": "simple-replication-task"
          }
  ]
  

• 特定のレプリケーション タスクのステータスに対応する特定の変更フィードに対してクエリを実行します。

  cdc cli processor query --server=http://10.0.10.25:8300 --changefeed-id=simple-replication-task --capture-id=b293999a-4168-4988-a4f4-35d9589b226b
  

  {
    "status": {
      "tables": {
        "56": {    # 56 ID of the replication table, corresponding to tidb_table_id of a table in TiDB
          "start-ts": 417474117955485702
        }
      },
      "operation": null,
      "admin-job-type": 0
    },
    "position": {
      "checkpoint-ts": 417474143881789441,
      "resolved-ts": 417474143881789441,
      "count": 0
    }
  }
  

  上記のコマンドでは、

  • status.tables : 各キー番号はレプリケーション テーブルの ID を表し、TiDB のテーブルのtidb_table_idに対応します。
  • resolved-ts : 現在のプロセッサ内のソートされたデータの中で最大の TSO。
  • checkpoint-ts : 現在のプロセッサでダウンストリームに正常に書き込まれた最大の TSO。

照合の新しいフレームワークを有効にしてテーブルを複製する

v4.0.15、v5.0.4、v5.1.1、v5.2.0 以降、TiCDC は照合のための新しいフレームワークが有効になっているテーブルをサポートします。

有効なインデックスのないテーブルを複製する

v4.0.8 以降、TiCDC はタスク構成を変更することで、有効なインデックスを持たないテーブルのレプリケーションをサポートしています。この機能を有効にするには、changefeed 構成ファイルで次のように構成します。

force-replicate = true

統合ソーター

注記：

v6.0.0 以降、TiCDC はデフォルトで DB Sorter エンジンを使用し、 sort engine Sorter を使用しなくなりました。1 項目を構成しないことをお勧めします。

統合ソーターは TiCDC のソート エンジンです。次のシナリオによって発生する OOM の問題を軽減できます。

• TiCDC のデータ複製タスクは長時間一時停止され、その間に大量の増分データが蓄積され、複製が必要になります。
• データ複製タスクは早いタイムスタンプから開始されるため、大量の増分データを複製する必要が生じます。

v4.0.13 以降にcdc cli使用して作成された changefeed では、Unified Sorter がデフォルトで有効になっています。v4.0.13 より前に存在していた changefeed では、以前の構成が使用されます。

変更フィードで Unified Sorter 機能が有効になっているかどうかを確認するには、次のサンプル コマンドを実行します (PD インスタンスの IP アドレスがhttp://10.0.10.25:2379であると想定)。

cdc cli --server="http://10.0.10.25:8300" changefeed query --changefeed-id=simple-replication-task | grep 'sort-engine'

上記のコマンドの出力で、値sort-engineが「unified」の場合、変更フィードで Unified Sorter が有効になっていることを意味します。

注記：

• サーバーで、レイテンシーが長く、帯域幅が制限されている機械式ハード ドライブやその他のstorageデバイスが使用されている場合、Unified Sorter のパフォーマンスは大幅に低下します。
• デフォルトでは、Unified Sorter はdata_dir使用して一時ファイルを保存します。空きディスク容量が 500 GiB 以上であることを確認することをお勧めします。本番環境では、各ノードの空きディスク容量が (業務で許容される最大checkpoint-ts ) * (業務ピーク時のアップストリーム書き込みトラフィック) より大きいことを確認することをお勧めします。また、 changefeed作成後に大量の履歴データを複製する予定がある場合は、各ノードの空き容量が複製されたデータの量より大きいことを確認してください。