This is an automated email from the ASF dual-hosted git repository. github-merge-queue[bot] pushed a commit to branch gh-readonly-queue/dev/pr-12782-42d2aab3f841821753b415d568cc5884d6f13bbd in repository https://gitbox.apache.org/repos/asf/seatunnel.git
commit 7637f3da9b4f19607335c5100b0fe4fd17ddd755 Author: corgy-w <[email protected]> AuthorDate: Thu Oct 15 06:38:23 2026 +0000 [Docs][CDC] Clarify partial update limitations (#12782) --- docs/en/connectors/formats/canal-json.md | 4 ++++ docs/en/connectors/formats/cdc-compatible-debezium-json.md | 4 ++++ docs/en/connectors/formats/debezium-json.md | 4 ++++ docs/en/connectors/formats/kafka-compatible-kafkaconnect-json.md | 4 ++++ docs/en/connectors/formats/maxwell-json.md | 4 ++++ docs/en/connectors/formats/ogg-json.md | 4 ++++ docs/zh/connectors/formats/canal-json.md | 4 ++++ docs/zh/connectors/formats/cdc-compatible-debezium-json.md | 4 ++++ docs/zh/connectors/formats/debezium-json.md | 4 ++++ docs/zh/connectors/formats/kafka-compatible-kafkaconnect-json.md | 4 ++++ docs/zh/connectors/formats/maxwell-json.md | 4 ++++ docs/zh/connectors/formats/ogg-json.md | 4 ++++ 12 files changed, 48 insertions(+) diff --git a/docs/en/connectors/formats/canal-json.md b/docs/en/connectors/formats/canal-json.md index cb8aa3d5ed..8884c17602 100644 --- a/docs/en/connectors/formats/canal-json.md +++ b/docs/en/connectors/formats/canal-json.md @@ -13,6 +13,10 @@ SeaTunnel supports to interpret Canal JSON messages as INSERT/UPDATE/DELETE mess SeaTunnel also supports to encode the INSERT/UPDATE/DELETE messages in SeaTunnel as Canal JSON messages, and emit to storage like Kafka. However, currently SeaTunnel can’t combine UPDATE_BEFORE and UPDATE_AFTER into a single UPDATE message. Therefore, SeaTunnel encodes UPDATE_BEFORE and UPDATE_AFTER as DELETE and INSERT Canal messages. +## Limitations + +UPDATE messages must contain a complete row image; partial updates containing only changed fields are not supported. + # Format Options | Option | Default | Required | Description | diff --git a/docs/en/connectors/formats/cdc-compatible-debezium-json.md b/docs/en/connectors/formats/cdc-compatible-debezium-json.md index 63479e1ae6..60f3c00fcd 100644 --- a/docs/en/connectors/formats/cdc-compatible-debezium-json.md +++ b/docs/en/connectors/formats/cdc-compatible-debezium-json.md @@ -4,6 +4,10 @@ SeaTunnel supports to interpret cdc record as Debezium-JSON messages publish to This is useful in many cases to leverage this feature, such as compatible with the debezium ecosystem. +## Limitations + +UPDATE messages must contain a complete row image; partial updates containing only changed fields are not supported. + # How To Use ## MySQL-CDC Sink Kafka diff --git a/docs/en/connectors/formats/debezium-json.md b/docs/en/connectors/formats/debezium-json.md index 4618ac3d80..18e856bc29 100644 --- a/docs/en/connectors/formats/debezium-json.md +++ b/docs/en/connectors/formats/debezium-json.md @@ -13,6 +13,10 @@ Seatunnel supports to interpret Debezium JSON messages as INSERT/UPDATE/DELETE m Seatunnel also supports to encode the INSERT/UPDATE/DELETE messages in Seatunnel asDebezium JSON messages, and emit to storage like Kafka. +## Limitations + +UPDATE messages must contain a complete row image; partial updates containing only changed fields are not supported. + # Format Options | Option | Default | Required | Description | diff --git a/docs/en/connectors/formats/kafka-compatible-kafkaconnect-json.md b/docs/en/connectors/formats/kafka-compatible-kafkaconnect-json.md index 32ad5808c1..97c4052d88 100644 --- a/docs/en/connectors/formats/kafka-compatible-kafkaconnect-json.md +++ b/docs/en/connectors/formats/kafka-compatible-kafkaconnect-json.md @@ -2,6 +2,10 @@ Seatunnel connector kafka supports parsing data extracted through kafka connect source, especially data extracted from kafka connect jdbc and kafka connect debezium +## Limitations + +UPDATE messages must contain a complete row image; partial updates containing only changed fields are not supported. + # How To Use ## Kafka Sink Mysql diff --git a/docs/en/connectors/formats/maxwell-json.md b/docs/en/connectors/formats/maxwell-json.md index d271d71624..0288712027 100644 --- a/docs/en/connectors/formats/maxwell-json.md +++ b/docs/en/connectors/formats/maxwell-json.md @@ -11,6 +11,10 @@ Seatunnel supports to interpret MaxWell JSON messages as INSERT/UPDATE/DELETE me Seatunnel also supports to encode the INSERT/UPDATE/DELETE messages in Seatunnel as MaxWell JSON messages, and emit to storage like Kafka. However, currently Seatunnel can’t combine UPDATE_BEFORE and UPDATE_AFTER into a single UPDATE message. Therefore, Seatunnel encodes UPDATE_BEFORE and UPDATE_AFTER as DELETE and INSERT MaxWell messages. +## Limitations + +UPDATE messages must contain a complete row image; partial updates containing only changed fields are not supported. + # Format Options | Option | Default | Required | Description | diff --git a/docs/en/connectors/formats/ogg-json.md b/docs/en/connectors/formats/ogg-json.md index fb14802aaa..f9e1f6d26d 100644 --- a/docs/en/connectors/formats/ogg-json.md +++ b/docs/en/connectors/formats/ogg-json.md @@ -11,6 +11,10 @@ Seatunnel supports to interpret Ogg JSON messages as INSERT/UPDATE/DELETE messag Seatunnel also supports to encode the INSERT/UPDATE/DELETE messages in Seatunnel as Ogg JSON messages, and emit to storage like Kafka. However, currently Seatunnel can’t combine UPDATE_BEFORE and UPDATE_AFTER into a single UPDATE message. Therefore, Seatunnel encodes UPDATE_BEFORE and UPDATE_AFTER as DELETE and INSERT Ogg messages. +## Limitations + +UPDATE messages must contain a complete row image; partial updates containing only changed fields are not supported. + # Format Options | Option | Default | Required | Description | diff --git a/docs/zh/connectors/formats/canal-json.md b/docs/zh/connectors/formats/canal-json.md index fc3344d963..1a01f6d9d8 100644 --- a/docs/zh/connectors/formats/canal-json.md +++ b/docs/zh/connectors/formats/canal-json.md @@ -14,6 +14,10 @@ SeaTunnel 能够解析 Canal 的 JSON 消息，并将其转化为 INSERT/UPDATE/ SeaTunnel 还支持将 SeaTunnel 中的 INSERT/UPDATE/DELETE 消息编码为 Canal JSON 消息，并将其发送到类似 Kafka 这样的存储中。然而，目前 SeaTunnel 无法将 UPDATE_BEFORE 和 UPDATE_AFTER 合并为一个单一的UPDATE消息。因此，SeaTunnel将 UPDATE_BEFORE 和 UPDATE_AFTER 编码为 Canal的 DELETE 和 INSERT 消息来进行 +## 限制 + +更新消息必须包含完整行数据；仅包含变更字段的部分更新暂不支持。 + # 格式选项 | 选项 | 默认值 | 是否需要 | 描述 | diff --git a/docs/zh/connectors/formats/cdc-compatible-debezium-json.md b/docs/zh/connectors/formats/cdc-compatible-debezium-json.md index 7aa6520dbe..db6d259885 100644 --- a/docs/zh/connectors/formats/cdc-compatible-debezium-json.md +++ b/docs/zh/connectors/formats/cdc-compatible-debezium-json.md @@ -4,6 +4,10 @@ SeaTunnel 支持将 cdc 记录解析为 Debezium-JSON 消息，并发布到 MQ ( 这个特性在很多场景下都非常实用，例如，它可以实现与 Debezium 生态系统的兼容性 +## 限制 + +更新消息必须包含完整行数据；仅包含变更字段的部分更新暂不支持。 + # 如何使用 ## MySQL-CDC 流入 Kafka diff --git a/docs/zh/connectors/formats/debezium-json.md b/docs/zh/connectors/formats/debezium-json.md index ab638d2563..a96bda1690 100644 --- a/docs/zh/connectors/formats/debezium-json.md +++ b/docs/zh/connectors/formats/debezium-json.md @@ -14,6 +14,10 @@ SeaTunnel 支持将 Debezium JSON 消息解析为 INSERT/UPDATE/DELETE 消息并 SeaTunnel 还支持将 SeaTunnel 中的 INSERT/UPDATE/DELETE 消息解析为 Debezium JSON 消息，并将其发送到类似 Kafka 这样的存储中 +## 限制 + +更新消息必须包含完整行数据；仅包含变更字段的部分更新暂不支持。 + # 格式选项 | 选项 | 默认值 | 是否需要 | 描述 | diff --git a/docs/zh/connectors/formats/kafka-compatible-kafkaconnect-json.md b/docs/zh/connectors/formats/kafka-compatible-kafkaconnect-json.md index 027d90ded0..a50f8039c3 100644 --- a/docs/zh/connectors/formats/kafka-compatible-kafkaconnect-json.md +++ b/docs/zh/connectors/formats/kafka-compatible-kafkaconnect-json.md @@ -2,6 +2,10 @@ Seatunnel 的 Kafka 连接器支持解析通过 Kafka Connect Source 抽取的数据，特别是从 Kafka Connect JDBC 和 Kafka Connect Debezium 抽取的数据 +## 限制 + +更新消息必须包含完整行数据；仅包含变更字段的部分更新暂不支持。 + # 如何使用 ## Kafka 流入 Mysql diff --git a/docs/zh/connectors/formats/maxwell-json.md b/docs/zh/connectors/formats/maxwell-json.md index b47956bbc1..66698765ca 100644 --- a/docs/zh/connectors/formats/maxwell-json.md +++ b/docs/zh/connectors/formats/maxwell-json.md @@ -11,6 +11,10 @@ SeaTunnel 能够解析 Maxwell 的 JSON 消息，并将其转化为 INSERT/UPDAT SeaTunnel 还支持将 SeaTunnel 中的 INSERT/UPDATE/DELETE 消息编码为 Maxwell JSON 消息，并将其发送到类似 Kafka 这样的存储中。然而，目前 SeaTunnel 无法将 UPDATE_BEFORE 和 UPDATE_AFTER 合并为一个单一的 UPDATE 消息。因此，SeaTunnel 将 UPDATE_BEFORE 和 UPDATE_AFTER 编码为 Maxwell 的 DELETE 和 INSERT 消息。 +## 限制 + +更新消息必须包含完整行数据；仅包含变更字段的部分更新暂不支持。 + # 格式选项 | 选项 | 默认值 | 是否需要 | 描述 | diff --git a/docs/zh/connectors/formats/ogg-json.md b/docs/zh/connectors/formats/ogg-json.md index 80c88e6ac1..7a6c4c4fe5 100644 --- a/docs/zh/connectors/formats/ogg-json.md +++ b/docs/zh/connectors/formats/ogg-json.md @@ -11,6 +11,10 @@ SeaTunnel 支持将 Ogg JSON 消息解释为 Seatunnel 系统中的 INSERT/UPDAT SeaTunnel 还支持将 SeaTunnel 中的 INSERT/UPDATE/DELETE 消息转化为 Ogg JSON 消息，并将其发送到类似 Kafka 这样的存储中。然而，目前 SeaTunnel 无法将 UPDATE_BEFORE 和 UPDATE_AFTER 组合成单个 UPDATE 消息。因此，Seatunnel 将 UPDATE_BEFORE 和 UPDATE_AFTER 转化为 DELETE 和 INSERT Ogg 消息来实现 +## 限制 + +更新消息必须包含完整行数据；仅包含变更字段的部分更新暂不支持。 + # 格式选项 | 选项 | 默认值 | 是否需要 | 描述 |
