diff --git a/ticdc/ticdc-open-api-v2.md b/ticdc/ticdc-open-api-v2.md index 8614399163820..edbf050dc6afc 100644 --- a/ticdc/ticdc-open-api-v2.md +++ b/ticdc/ticdc-open-api-v2.md @@ -357,11 +357,11 @@ The `sink.csv` parameters are described as follows: | `quote` | `STRING` type. The quotation character used to surround fields in the CSV file. If the value is empty, no quotation is used. The default value is `"`. | | `binary_encoding_method` | `STRING` type. The encoding method of binary data, which can be `"base64"` or `"hex"`. The default value is `"base64"`. | -`sink.dispatchers`: for the sink of MQ type, you can use this parameter to configure the event dispatcher. The following dispatchers are supported: `default`, `ts`, `rowid`, and `table`. The dispatcher rules are as follows: +`sink.dispatchers`: for the sink of MQ type, you can use this parameter to configure the event dispatcher. The following dispatchers are supported: `default`, `ts`, `index-value`, and `table`. The dispatcher rules are as follows: - `default`: when multiple unique indexes (including the primary key) exist, events are dispatched in the table mode. When only one unique index (or the primary key) exists, events are dispatched in the rowid mode. If the Old Value feature is enabled, events are dispatched in the table mode. - `ts`: uses the commitTs of the row change to create the hash value and dispatch events. -- `rowid`: uses the name and value of the selected HandleKey column to create the hash value and dispatch events. +- `index-value`: uses the name and value of the selected HandleKey column to create the hash value and dispatch events. - `table`: uses the schema name of the table and the table name to create the hash value and dispatch events. `sink.dispatchers` is an array. The parameters are described as follows: diff --git a/ticdc/ticdc-open-api.md b/ticdc/ticdc-open-api.md index f0c8e783b3bd4..331528f7d31e9 100644 --- a/ticdc/ticdc-open-api.md +++ b/ticdc/ticdc-open-api.md @@ -148,18 +148,18 @@ The configuration parameters of sink are as follows: { "dispatchers":[ {"matcher":["test1.*", "test2.*"], "dispatcher":"ts"}, - {"matcher":["test3.*", "test4.*"], "dispatcher":"rowid"} + {"matcher":["test3.*", "test4.*"], "dispatcher":"index-value"} ], "protocal":"canal-json" } ``` -`dispatchers`: For the sink of MQ type, you can use dispatchers to configure the event dispatcher. Four dispatchers are supported: `default`, `ts`, `rowid`, and `table`. The dispatcher rules are as follows: +`dispatchers`: For the sink of MQ type, you can use dispatchers to configure the event dispatcher. Four dispatchers are supported: `default`, `ts`, `index-value`, and `table`. The dispatcher rules are as follows: -- `default`: When multiple unique indexes (including the primary key) exist or the Old Value feature is enabled, events are dispatched in the `table` mode. When only one unique index (or the primary key) exists, events are dispatched in the `rowid` mode. -- `ts`: Uses the commitTs of the row change to create the hash value and dispatch events. -- `rowid`: Uses the name and value of the selected HandleKey column to create the hash value and dispatch events. -- `table`: Uses the schema name of the table and the table name to create the hash value and dispatch events. +- `default`: dispatches events in the `table` mode. +- `ts`: uses the commitTs of the row change to create the hash value and dispatch events. +- `index-value`: uses the name and value of the selected HandleKey column to create the hash value and dispatch events. +- `table`: uses the schema name of the table and the table name to create the hash value and dispatch events. `matcher`: The matching syntax of matcher is the same as the filter rule syntax.