Skip to content

Commit

Permalink
This is an automated cherry-pick of #16903
Browse files Browse the repository at this point in the history
Signed-off-by: ti-chi-bot <[email protected]>
  • Loading branch information
hfxsd authored and ti-chi-bot committed Apr 1, 2024
1 parent 78e60f1 commit 9afe3ae
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
4 changes: 2 additions & 2 deletions ticdc/ticdc-open-api-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
11 changes: 9 additions & 2 deletions ticdc/ticdc-open-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,18 +148,25 @@ 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:

<<<<<<< HEAD
- `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.
>>>>>>> 010f6c2ad8 (ticdc: fix incompatiable config description (#16903))
`matcher`: The matching syntax of matcher is the same as the filter rule syntax.

Expand Down

0 comments on commit 9afe3ae

Please sign in to comment.