TiCDC Canal-JSON プロトコル

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

Canal-JSONを使用する

下流のシンクとしてメッセージキュー（MQ）を使用する場合、 sink-uriで Canal-JSON を指定できます。TiCDC は、イベントを基本単位として Canal-JSON メッセージをラップして構築し、TiDB データ変更イベントを下流に送信します。

イベントには 3 つの種類があります。

• DDL イベント: DDL 変更レコードを表します。上流の DDL ステートメントが正常に実行された後に送信されます。DDL イベントは、インデックスが 0 の状態で MQ パーティションに送信されます。
• DML イベント: 行データ変更レコードを表します。このタイプのイベントは、行の変更が発生したときに送信されます。変更が発生した後の行に関する情報が含まれます。
• ウォーターマーク イベント: 特別な時点を表します。この時点より前に受信したイベントが完了していることを示します。これは 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 は Canal-JSON プロトコル形式に TiDB 拡張フィールドを追加します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 イベント、ウォーターマーク イベントの形式と、コンシューマー側でデータが解決される方法について説明します。

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": 429918007904436226  // A TiDB TSO timestamp
    }
}

各フィールドの説明は以下のとおりです。

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": 429918007904436226  // A TiDB TSO timestamp
    }
}

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

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

このタイプのイベントを受信すると、 commitTsがwatermarkTsより小さいすべてのイベントが送信されています。TiCDC は「少なくとも 1 回」セマンティクスを提供するため、データが繰り返し送信される可能性があります。5 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  // A TiDB TSO timestamp
    }
}

消費者側のデータ解決

上記の例からわかるように、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 タイプ フィールド

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

整数型

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

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

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

バイナリとBlob型

TiCDC は、次のように各バイトを文字表現に変換して、Canal-JSON 形式でバイナリタイプエンコードします。

• 印刷可能な文字は、ISO/IEC 8859-1 文字エンコーディングを使用して表されます。
• 印刷できない文字や HTML で特別な意味を持つ特定の文字は、UTF-8 エスケープ シーケンスを使用して表されます。

次の表に詳細な表現情報を示します。

エンコードの例

たとえば、 c_varbinaryというVARBINARY列に格納されている次の 16 バイト[5 7 10 15 36 50 43 99 120 60 38 255 254 45 55 70] 、Canal-JSON Updateイベントで次のようにエンコードされます。

{
    ...
    "data": [
        {
            ...
            "c_varbinary": "\u0005\u0007\n\u000f$2+cx\u003c\u0026ÿþ-7F"
        }
    ]
    ...
}

TiCDC Canal-JSONと公式Canalの比較

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

公式Canalとの互換性

v6.5.6、v7.1.3、v7.6.0 以降、 TiCDC Canal-JSON は公式 Canal のデータ形式との互換性をサポートしています。changefeed を作成するときに、 sink-uriのうちcontent-compatible=true設定すると、この機能が有効になります。このモードでは、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-JSON 形式と公式 Canal を比較すると、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"
        }
    ]
}