TiCDC Canal-JSON プロトコル

Canal-JSON は、 アリババ運河によって定義されたデータ交換形式のプロトコルです。このドキュメントでは、TiDB 拡張フィールド、Canal-JSON データ形式の定義、公式 Canal との比較など、Canal-JSON データ形式が TiCDC でどのように実装されているかを学ぶことができます。

Canal-JSON を使用する

Message Queue (MQ) をダウンストリーム シンクとして使用する場合、 sink-uriで Canal-JSON を指定できます。 TiCDC は、Event を基本単位として Canal-JSON メッセージをラップして構築し、TiDB データ変更イベントをダウンストリームに送信します。

イベントには 3 つのタイプがあります。

• DDL イベント: DDL 変更レコードを表します。これは、上流の DDL ステートメントが正常に実行された後に送信されます。 DDL イベントは、インデックスが 0 の MQ パーティションに送信されます。
• DML イベント: 行データ変更レコードを表します。このタイプのイベントは、行の変更が発生したときに送信されます。これには、変更が発生した後の行に関する情報が含まれます。
• WATERMARK イベント: 特別な時点を表します。これは、この時点より前に受信したイベントが完了したことを示します。 TiDB 拡張フィールドにのみ適用され、 sink-uriにenable-tidb-extension ～ trueを設定すると有効になります。

以下はCanal-JSONの使用例です。

cdc cli changefeed create --server=http://127.0.0.1:8300 --changefeed-id="kafka-canal-json" --sink-uri="kafka://127.0.0.1:9092/topic-name?kafka-version=2.4.0&protocol=canal-json"

TiDB 拡張フィールド

Canal-JSON プロトコルは、もともと MySQL 用に設計されました。これには、CommitTS トランザクションの TiDB 固有の一意識別子などの重要なフィールドは含まれません。この問題を解決するために、TiCDC は TiDB 拡張フィールドを Canal-JSON プロトコル形式に追加します。 sink-uriでenable-tidb-extension ～ true (デフォルトではfalse ) を設定すると、TiCDC は Canal-JSON メッセージを生成するときに次のように動作します。

• TiCDC は、 _tidbという名前のフィールドを含む DML イベント メッセージと DDL イベント メッセージを送信します。
• TiCDC は WATERMARK イベント メッセージを送信します。

以下は例です。

cdc cli changefeed create --server=http://127.0.0.1:8300 --changefeed-id="kafka-canal-json-enable-tidb-extension" --sink-uri="kafka://127.0.0.1:9092/topic-name?kafka-version=2.4.0&protocol=canal-json&enable-tidb-extension=true"

メッセージフォーマットの定義

このセクションでは、DDL イベント、DML イベント、WATERMARK イベントの形式と、コンシューマー側でデータがどのように解決されるかについて説明します。

DDLイベント

TiCDC は、DDL イベントを次の Canal-JSON 形式にエンコードします。

{
    "id": 0,
    "database": "test",
    "table": "",
    "pkNames": null,
    "isDdl": true,
    "type": "QUERY",
    "es": 1639633094670,
    "ts": 1639633095489,
    "sql": "drop database if exists test",
    "sqlType": null,
    "mysqlType": null,
    "data": null,
    "old": null,
    "_tidb": {     // TiDB extension field
        "commitTs": 163963309467037594
    }
}

フィールドについては次のように説明します。

DMLイベント

TiCDC は、DML データ変更イベントの行を次のようにエンコードします。

{
    "id": 0,
    "database": "test",
    "table": "tp_int",
    "pkNames": [
        "id"
    ],
    "isDdl": false,
    "type": "INSERT",
    "es": 1639633141221,
    "ts": 1639633142960,
    "sql": "",
    "sqlType": {
        "c_bigint": -5,
        "c_int": 4,
        "c_mediumint": 4,
        "c_smallint": 5,
        "c_tinyint": -6,
        "id": 4
    },
    "mysqlType": {
        "c_bigint": "bigint",
        "c_int": "int",
        "c_mediumint": "mediumint",
        "c_smallint": "smallint",
        "c_tinyint": "tinyint",
        "id": "int"
    },
    "data": [
        {
            "c_bigint": "9223372036854775807",
            "c_int": "2147483647",
            "c_mediumint": "8388607",
            "c_smallint": "32767",
            "c_tinyint": "127",
            "id": "2"
        }
    ],
    "old": null,
    "_tidb": {     // TiDB extension field
        "commitTs": 163963314122145239
    }
}

ウォーターマークイベント

TiCDC は、 enable-tidb-extension ～ trueに設定した場合にのみ WATERMARK イベントを送信します。 typeフィールドの値はTIDB_WATERMARKです。イベントには_tidbフィールドが含まれており、このフィールドにはパラメータwatermarkTsが 1 つだけ含まれています。値watermarkTsは、イベントの送信時に記録される TSO です。

このタイプのイベントを受信すると、 watermarkTs未満のcommitTsを持つすべてのイベントが送信されています。 TiCDC は「At Least Once」セマンティクスを提供するため、データは繰り返し送信される可能性があります。 watermarkTs未満のcommitTsを含む後続のイベントを受信した場合は、このイベントを無視しても問題ありません。

以下は WATERMARK イベントの例です。

{
    "id": 0,
    "database": "",
    "table": "",
    "pkNames": null,
    "isDdl": false,
    "type": "TIDB_WATERMARK",
    "es": 1640007049196,
    "ts": 1640007050284,
    "sql": "",
    "sqlType": null,
    "mysqlType": null,
    "data": null,
    "old": null,
    "_tidb": {     // TiDB extension field
        "watermarkTs": 429918007904436226
    }
}

消費者側のデータ解決

上の例からわかるように、Canal-JSON には統一されたデータ形式があり、イベント タイプごとにフィールド入力ルールが異なります。統一された方法を使用してこの JSON 形式のデータを解決し、フィールド値を確認してイベント タイプを決定できます。

• isDdlがtrueの場合、メッセージには DDL イベントが含まれます。
• isDdlがfalse場合、さらにtypeフィールドを確認する必要があります。 typeがTIDB_WATERMARKの場合、それは WATERMARK イベントです。それ以外の場合は、DML イベントです。

フィールドの説明

Canal-JSON 形式では、 mysqlTypeフィールドとsqlTypeフィールドに対応するデータ型が記録されます。

「MySQL タイプ」フィールド

mysqlTypeフィールドには、Canal-JSON 形式で各列に MySQL Type の文字列が記録されます。詳細については、 TiDB データ型を参照してください。

「SQL タイプ」フィールド

sqlTypeフィールドには、Canal-JSON 形式で各列のJava SQL Type が記録されます。これは、JDBC のデータに対応するデータ型です。その値は、MySQL タイプと特定のデータ値によって計算できます。マッピングは次のとおりです。

整数型

次の表に示すように、 整数型にUnsigned制約があるかどうかと、さまざまなJava SQL タイプ コードにそれぞれ対応する値のサイズを考慮する必要があります。

次の表は、TiCDC のJava SQL タイプとそのコード間のマッピング関係を示しています。

Java SQL タイプの詳細については、 Java SQL クラスの型を参照してください。

TiCDC Canal-JSON と公式 Canal の比較

TiCDC がUpdateイベントとmysqlTypeフィールドを含む Canal-JSON データ形式を実装する方法は、公式の Canal とは異なります。次の表に主な違いを示します。

公式Canalとの互換性

v6.5.6 および v7.1.3 以降、 TiCDC Canal-JSON は公式 Canal のデータ形式との互換性をサポートします。チェンジフィードを作成するときに、 content-compatible=true / sink-uriを設定してこの機能を有効にすることができます。このモードでは、TiCDC は公式の Canal と互換性のある Canal-JSON 形式のデータを出力します。具体的な変更点は以下の通りです。

• mysqlTypeフィールドには、各タイプのタイプ パラメータの完全な情報が含まれます。
• Updateタイプのイベントは、変更された列のデータのみを出力します。

Updateタイプのイベント

Update種類のイベントの場合:

• TiCDC では、 oldフィールドにすべての列データが含まれます
• 公式 Canal では、 oldフィールドには変更された列データのみが含まれます

次の SQL ステートメントが上流の TiDB で順次実行されると仮定します。

create table tp_int
(
    id          int auto_increment,
    c_tinyint   tinyint   null,
    c_smallint  smallint  null,
    c_mediumint mediumint null,
    c_int       int       null,
    c_bigint    bigint    null,
    constraint pk
        primary key (id)
);

insert into tp_int(c_tinyint, c_smallint, c_mediumint, c_int, c_bigint)
values (127, 32767, 8388607, 2147483647, 9223372036854775807);

update tp_int set c_int = 0, c_tinyint = 0 where c_smallint = 32767;

updateステートメントの場合、TiCDC は、以下に示すように、 typeをUPDATEとして持つイベント メッセージを出力します。 updateステートメントはc_intとc_tinyint列のみを変更します。出力イベント メッセージのoldフィールドには、すべての列データが含まれます。

{
    "id": 0,
    ...
    "type": "UPDATE",
    ...
    "sqlType": {
        ...
    },
    "mysqlType": {
        ...
    },
    "data": [
        {
            "c_bigint": "9223372036854775807",
            "c_int": "0",
            "c_mediumint": "8388607",
            "c_smallint": "32767",
            "c_tinyint": "0",
            "id": "2"
        }
    ],
    "old": [                              // In TiCDC, this field contains all the column data.
        {
            "c_bigint": "9223372036854775807",
            "c_int": "2147483647",        // Modified column
            "c_mediumint": "8388607",
            "c_smallint": "32767",
            "c_tinyint": "127",           // Modified column
            "id": "2"
        }
    ]
}

公式 Canal の場合、以下に示すように、出力イベント メッセージのoldフィールドには、変更された列データのみが含まれます。

{
    "id": 0,
    ...
    "type": "UPDATE",
    ...
    "sqlType": {
        ...
    },
    "mysqlType": {
        ...
    },
    "data": [
        {
            "c_bigint": "9223372036854775807",
            "c_int": "0",
            "c_mediumint": "8388607",
            "c_smallint": "32767",
            "c_tinyint": "0",
            "id": "2"
        }
    ],
    "old": [                              // In Canal, this field contains only the modified column data.
        {
            "c_int": "2147483647",        // Modified column
            "c_tinyint": "127",           // Modified column
        }
    ]
}

mysqlTypeフィールド

mysqlTypeフィールドの場合、型にパラメータが含まれる場合、公式の Canal には型パラメータの完全な情報が含まれます。 TiCDC にはそのような情報は含まれていません。

次の例では、テーブル定義 SQL ステートメントに、 decimal 、 char 、 varchar 、 enumなどの各列のパラメーターが含まれています。 TiCDC と公式 Canal によって生成された Canal-JSON 形式を比較すると、TiCDC のmysqlTypeフィールドには基本的な MySQL 情報のみが含まれていることがわかります。 type パラメータの完全な情報が必要な場合は、他の方法で実装する必要があります。

次の SQL ステートメントが上流の TiDB で順次実行されると仮定します。

create table t (
    id     int auto_increment,
    c_decimal    decimal(10, 4) null,
    c_char       char(16)      null,
    c_varchar    varchar(16)   null,
    c_binary     binary(16)    null,
    c_varbinary  varbinary(16) null,
    c_enum enum('a','b','c') null,
    c_set  set('a','b','c')  null,
    c_bit  bit(64)            null,
    constraint pk
        primary key (id)
);

insert into t (c_decimal, c_char, c_varchar, c_binary, c_varbinary, c_enum, c_set, c_bit)
values (123.456, "abc", "abc", "abc", "abc", 'a', 'a,b', b'1000001');

TiCDC の出力は次のとおりです。

{
    "id": 0,
    ...
    "isDdl": false,
    "sqlType": {
        ...
    },
    "mysqlType": {
        "c_binary": "binary",
        "c_bit": "bit",
        "c_char": "char",
        "c_decimal": "decimal",
        "c_enum": "enum",
        "c_set": "set",
        "c_varbinary": "varbinary",
        "c_varchar": "varchar",
        "id": "int"
    },
    "data": [
        {
            ...
        }
    ],
    "old": null,
}

公式運河の出力は次のとおりです。

{
    "id": 0,
    ...
    "isDdl": false,
    "sqlType": {
        ...
    },
    "mysqlType": {
        "c_binary": "binary(16)",
        "c_bit": "bit(64)",
        "c_char": "char(16)",
        "c_decimal": "decimal(10, 4)",
        "c_enum": "enum('a','b','c')",
        "c_set": "set('a','b','c')",
        "c_varbinary": "varbinary(16)",
        "c_varchar": "varchar(16)",
        "id": "int"
    },
    "data": [
        {
            ...
        }
    ],
    "old": null,
}

TiCDC Canal-JSON の変更点

DeleteイベントのOldフィールドの変更

v5.4.0より、 Deleteイベントのうちのoldフィールドが変更されました。

以下はDeleteイベント メッセージです。 v5.4.0 より前では、 oldフィールドには「データ」フィールドと同じ内容が含まれています。 v5.4.0 以降のバージョンでは、 oldフィールドは null に設定されます。 「データ」フィールドを使用して、削除されたデータを取得できます。

{
    "id": 0,
    "database": "test",
    ...
    "type": "DELETE",
    ...
    "sqlType": {
        ...
    },
    "mysqlType": {
        ...
    },
    "data": [
        {
            "c_bigint": "9223372036854775807",
            "c_int": "0",
            "c_mediumint": "8388607",
            "c_smallint": "32767",
            "c_tinyint": "0",
            "id": "2"
        }
    ],
    "old": null,
    // The following is an example before v5.4.0. The `old` field contains the same content as the "data" field.
    "old": [
        {
            "c_bigint": "9223372036854775807",
            "c_int": "0",
            "c_mediumint": "8388607",
            "c_smallint": "32767",
            "c_tinyint": "0",
            "id": "2"
        }
    ]
}