変更フィードの管理

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

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

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

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-02-29T15: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.1"}

レプリケーションタスクリストのクエリ

次のコマンドを実行して、レプリケーション タスク リストをクエリします。

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

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 : 現在のトランザクションTSの中で最大のトランザクションchangefeed 。このTSダウンストリームに正常に書き込まれていることに注意してください。
  • admin-job-type : チェンジフィードのステータス:
    • 0 : 正常な状態です。
    • 1 : タスクは一時停止されています。タスクが一時停止されると、複製されたすべてのprocessorが終了します。タスクの構成とレプリケーションのステータスは保持されるため、タスクをcheckpiont-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 が、変更フィード ( t1 ) の現在のチェックポイント TSO より大きい場合、 t1とt2の間のデータはダウンストリームにレプリケートされません。これにより、データ損失が発生します。 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 は、レプリケーション タスクの構成の変更をサポートします (動的ではありません)。変更フィード構成を変更するには、タスクを一時停止し、構成を変更してからタスクを再開します。

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 。
• 変更フィード構成ファイルとそのファイル内のすべての構成項目。
• チェンジフィードの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 ソーター エンジンを使用し、統合ソーターを使用しなくなりました。 sort engine項目は設定しないことをお勧めします。

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

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

v4.0.13 以降cdc cli使用して作成された変更フィードの場合、統合ソーターはデフォルトで有効になっています。 v4.0.13 より前に存在していた変更フィードの場合は、以前の構成が使用されます。

統合ソーター機能が変更フィードで有効になっているかどうかを確認するには、次のコマンド例を実行できます (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」の場合、変更フィードで統合ソーターが有効になっていることを意味します。

注記：

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