This is an automated email from the ASF dual-hosted git repository.
github-merge-queue[bot] pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/seatunnel.git
The following commit(s) were added to refs/heads/dev by this push:
new 93cd2407a3 [Docs] Fix connector option docs verified against source
code (#12570)
93cd2407a3 is described below
commit 93cd2407a32de85833f91fab88416ebce5d6a348
Author: Jast <[email protected]>
AuthorDate: Sat Oct 17 15:59:05 2026 +0000
[Docs] Fix connector option docs verified against source code (#12570)
Co-authored-by: zhangshenghang <[email protected]>
Co-authored-by: jast <[email protected]>
Co-authored-by: multica-agent <[email protected]>
---
docs/en/connectors/sink/Paimon.md | 5 +++--
docs/en/connectors/source/MongoDB-CDC.md | 2 ++
docs/en/connectors/source/Paimon.md | 32 +++++++++++++-------------
docs/en/connectors/source/Persistiq.md | 36 +++++++++++++++---------------
docs/en/connectors/source/Redis.md | 2 ++
docs/en/connectors/source/SqlServer-CDC.md | 4 ++--
docs/zh/connectors/sink/Paimon.md | 5 +++--
docs/zh/connectors/source/MongoDB-CDC.md | 2 ++
docs/zh/connectors/source/Paimon.md | 4 ++--
docs/zh/connectors/source/Redis.md | 2 ++
docs/zh/connectors/source/SqlServer-CDC.md | 4 ++--
11 files changed, 54 insertions(+), 44 deletions(-)
diff --git a/docs/en/connectors/sink/Paimon.md
b/docs/en/connectors/sink/Paimon.md
index 91721b9a82..75e9b9fa71 100644
--- a/docs/en/connectors/sink/Paimon.md
+++ b/docs/en/connectors/sink/Paimon.md
@@ -89,6 +89,7 @@ libfb303-xxx.jar
| paimon.hadoop.conf-path | String | No | -
| The specified loading path for the 'core-site.xml', 'hdfs-site.xml',
'hive-site.xml' files
|
| paimon.table.non-primary-key | Boolean | No | false
| Switch to create `table with PK` or `table without PK`. true : `table
without PK`, false : `table with PK`
|
| branch | String | No | -
| The branch name of Paimon table to write data to. If omitted, data is
written to the main branch. For non-main branches, the main table and target
branch must already exist, and `schema_save_mode=RECREATE_SCHEMA` or
`data_save_mode=DROP_DATA` is not supported. |
+| multi_table_sink_replica | int | No | 1
| The replica number of multi table sink writer. Use this when one upstream
job writes to multiple Paimon tables and each table needs more than one sink
writer. |
### table_options [Map]
@@ -140,7 +141,7 @@ All `changelog-producer` modes are currently supported. The
default is `none`.
> **Note**
>
> When you use a streaming mode to read a Paimon table, different
> `changelog-producer` modes will
-> produce [different results](../source/Paimon.md#changelog). Pick `input` for
the most faithful
+> produce [different
results](../source/Paimon.md#read-paimon-table-changelog). Pick `input` for the
most faithful
> pass-through of upstream CDC events, or `lookup` / `full-compaction` if the
> upstream does not emit
> full changelog records.
@@ -741,7 +742,7 @@ sink {
### Does Paimon sink support automatic table creation and schema evolution?
-Yes. When `paimon.auto-create-table = true` or `schema_save_mode =
"CREATE_SCHEMA_WHEN_NOT_EXIST"`, SeaTunnel automatically initializes the
destination Paimon table using upstream table schema and primary key
information.
+Yes. When `schema_save_mode = "CREATE_SCHEMA_WHEN_NOT_EXIST"`, SeaTunnel
automatically initializes the destination Paimon table using upstream table
schema and primary key information.
### How does Paimon sink achieve exactly-once writes?
diff --git a/docs/en/connectors/source/MongoDB-CDC.md
b/docs/en/connectors/source/MongoDB-CDC.md
index f22e62d7ac..7775725e7f 100644
--- a/docs/en/connectors/source/MongoDB-CDC.md
+++ b/docs/en/connectors/source/MongoDB-CDC.md
@@ -127,11 +127,13 @@ For specific types in MongoDB, we use Extended JSON
format to map them to Seatun
| poll.await.time.ms | Integer | No | 1000 | Time in
milliseconds to wait before checking for new change stream results.
|
| heartbeat.interval.ms | Integer | No | 0 | Time in
milliseconds between heartbeat messages. Use `0` to disable heartbeat messages.
|
| incremental.snapshot.chunk.size.mb | Integer | No | 64 | Chunk
size, in MB, for incremental snapshot reading.
|
+| incremental.parallelism | Integer | No | 1 | The
number of parallel readers in the incremental phase.
|
| startup.mode | Enum | No | INITIAL | Optional
startup mode for MongoDB CDC consumer. Valid values are `initial`, `latest`,
and `timestamp`. See the [Startup Mode](#startup-mode) section below.
|
| startup.timestamp | Long | No | - | Start
from the specified epoch timestamp in milliseconds. Only used when
`startup.mode` is `timestamp`.
|
| stop.mode | Enum | No | NEVER | Optional
stop mode for MongoDB CDC consumer. Valid values are `never` and `timestamp`.
See the [Stop Mode](#stop-mode) section below.
|
| stop.timestamp | Long | No | - | Stop at
the change-stream position derived from this epoch timestamp in milliseconds.
Only used when `stop.mode` is `timestamp`.
|
| exactly_once | Boolean | No | false | Enable
exactly-once semantics. Enabling this may increase memory usage during large
table snapshot recovery.
|
+| format | Enum | No | DEFAULT | The
output data format of MongoDB CDC. Valid values are `DEFAULT` and
`COMPATIBLE_DEBEZIUM_JSON`.
|
| debezium | Config | No | - |
Pass-through Debezium properties used by the embedded engine.
|
| common-options | | No | - | Source
plugin common parameters. For details, see [Source Common
Options](../common-options/source-common-options.md).
|
diff --git a/docs/en/connectors/source/Paimon.md
b/docs/en/connectors/source/Paimon.md
index beddf6ae5e..a9a7bccc35 100644
--- a/docs/en/connectors/source/Paimon.md
+++ b/docs/en/connectors/source/Paimon.md
@@ -259,7 +259,21 @@ source {
}
```
-## Changelog
+### paimon enable privilege example
+
+```hocon
+source {
+ Paimon {
+ warehouse = "/tmp/paimon"
+ database = "default"
+ table = "st_test"
+ user = "paimon"
+ password = "******"
+ }
+}
+```
+
+## Read Paimon Table Changelog
If you want to read the changelog of the Paimon table, first set the
`changelog-producer` for the Paimon source table and then use the SeaTunnel
stream task to read it.
### Note
@@ -291,20 +305,6 @@ sink {
}
```
-### paimon enable privilege example
-
-```hocon
-source {
- Paimon {
- warehouse = "/tmp/paimon"
- database = "default"
- table = "st_test"
- user = "paimon"
- password = "******"
- }
-}
-```
-
## FAQ
### Which read modes does the Paimon source support?
@@ -313,7 +313,7 @@ The SeaTunnel Paimon source supports both batch snapshot
queries and streaming c
### How do I configure storage and catalog backends for Paimon?
-Configure `warehouse` pointing to the storage root (e.g.
`hdfs:///paimon/warehouse`, `s3a://bucket/warehouse`, or local path) and set
`paimon.catalog.type` (such as `filesystem` or `hive`). Required storage or
authentication properties can be provided via `paimon.hadoop.conf`.
+Configure `warehouse` pointing to the storage root (e.g.
`hdfs:///paimon/warehouse`, `s3a://bucket/warehouse`, or local path) and set
`catalog_type` (such as `filesystem` or `hive`). Required storage or
authentication properties can be provided via `paimon.hadoop.conf`.
### Does Paimon source support column projection?
diff --git a/docs/en/connectors/source/Persistiq.md
b/docs/en/connectors/source/Persistiq.md
index ebc16545da..34d95bb2f8 100644
--- a/docs/en/connectors/source/Persistiq.md
+++ b/docs/en/connectors/source/Persistiq.md
@@ -19,24 +19,24 @@ Used to read data from Persistiq.
## Options
-| name | type | required | default value |
-|-----------------------------|---------|----------|---------------|
-| url | String | Yes | - |
-| password | String | Yes | - |
-| method | String | No | get |
-| schema | Config | No | - |
-| schema.fields | Config | No | - |
-| format | String | No | json |
-| params | Map | No | - |
-| body | String | No | - |
-| json_field | Config | No | - |
-| content_field | String | No | - |
-| poll_interval_millis | int | No | - |
-| retry | int | No | - |
-| retry_backoff_multiplier_ms | int | No | 100 |
-| retry_backoff_max_ms | int | No | 10000 |
-| enable_multi_lines | boolean | No | false |
-| common-options | config | No | - |
+| name | type | required | default value |
Description |
+|-----------------------------|---------|----------|---------------|-------------|
+| url | String | Yes | - | HTTP
request URL |
+| password | String | Yes | - | Persistiq
API key used for login |
+| method | String | No | get | HTTP
request method, only supports `GET` and `POST` |
+| schema | Config | No | - | HTTP and
SeaTunnel data structure mapping. For more details, see [Schema
Feature](../../introduction/concepts/schema-feature.md). |
+| schema.fields | Config | No | - | The
schema fields of upstream data |
+| format | String | No | json | The
format of upstream data, now supports `json` and `text`, default `json` |
+| params | Map | No | - | HTTP
request parameters |
+| body | String | No | - | HTTP
request body |
+| json_field | Config | No | - | JSON
field configuration for extracting fields from the response |
+| content_field | String | No | - | JSONPath
expression to extract part of the JSON response before schema parsing |
+| poll_interval_millis | int | No | - | Request
HTTP API interval (millis) in stream mode |
+| retry | int | No | - | The max
retry times if request HTTP returns `IOException` |
+| retry_backoff_multiplier_ms | int | No | 100 | The
retry-backoff multiplier (millis) if request HTTP failed |
+| retry_backoff_max_ms | int | No | 10000 | The
maximum retry-backoff time (millis) if request HTTP failed |
+| enable_multi_lines | boolean | No | false | Whether
to enable multi-line mode |
+| common-options | config | No | - | Source
plugin common parameters, please refer to [Source Common
Options](../common-options/source-common-options.md) for details |
### url [String]
diff --git a/docs/en/connectors/source/Redis.md
b/docs/en/connectors/source/Redis.md
index 3b38a657b6..2b1d987774 100644
--- a/docs/en/connectors/source/Redis.md
+++ b/docs/en/connectors/source/Redis.md
@@ -61,6 +61,8 @@ downloaded from Maven Central.
| db_num | int | no | 0 | Redis
database index |
| mode | string | no | single | Redis
mode: `single` or `cluster` |
| nodes | list | yes when mode=cluster | - | Redis
cluster nodes in format `["host1:port1", "host2:port2"]` |
+| keys | string | yes when tables_configs is absent | - | Redis
key pattern to scan. Supports fuzzy matching; users need to ensure the matched
keys have the same type. Mutually exclusive with `tables_configs`. |
+| data_type | string | yes when tables_configs is absent | - | Redis
data type of the matched keys: `key`, `string`, `hash`, `list`, `set`, `zset`.
Required together with `keys` for single key pattern reading. |
| tables_configs | list | no | - | List of
table configurations for multi-table reading |
| common-options | | no | - | Source
plugin common parameters, please refer to [Source Common
Options](../common-options/source-common-options.md) for details |
diff --git a/docs/en/connectors/source/SqlServer-CDC.md
b/docs/en/connectors/source/SqlServer-CDC.md
index cafa736078..e7f76b465a 100644
--- a/docs/en/connectors/source/SqlServer-CDC.md
+++ b/docs/en/connectors/source/SqlServer-CDC.md
@@ -92,8 +92,8 @@ case-sensitive databases, make sure the configured identifier
case matches the d
| incremental.parallelism | Integer | No | 1 |
The number of parallel readers in the incremental phase.
[...]
| snapshot.split.size | Integer | No | 8096 |
The split size (number of rows) of table snapshot, captured tables are split
into multiple splits when read the snapshotof table.
[...]
| snapshot.fetch.size | Integer | No | 1024 |
The maximum fetch size for per poll when read table snapshot.
[...]
-| server-time-zone | String | No | UTC |
The session time zone in database server. This value is also used when
converting `startup.timestamp` to LSN. Set it explicitly when database time
zone and JVM time zone are different.
[...]
-| connect.timeout | Duration | No | 30s |
The maximum time that the connector should wait after trying to connect to the
database server before timing out.
[...]
+| server-time-zone | String | No | - |
The session time zone in database server. If not set, the JVM system default
time zone (`ZoneId.systemDefault()`) is used. This value is also used when
converting `startup.timestamp` to LSN. Set it explicitly when database time
zone and JVM time zone are different.
[...]
+| connect.timeout.ms | Long | No | 30000 |
The maximum time in milliseconds that the connector should wait after trying to
connect to the database server before timing out.
[...]
| connect.max-retries | Integer | No | 3 |
The max retry times that the connector should retry to build database server
connection.
[...]
| connection.pool.size | Integer | No | 20 |
The connection pool size.
[...]
| chunk-key.even-distribution.factor.upper-bound | Double | No | 100
| The upper bound of the chunk key distribution factor. This factor is used
to determine whether the table data is evenly distributed. If the distribution
factor is calculated to be less than or equal to this upper bound (i.e.,
(MAX(id) - MIN(id) + 1) / row count), the table chunks would be optimized for
even distribution. Otherwise, if the distribution factor is greater, the table
will be considered as unev [...]
diff --git a/docs/zh/connectors/sink/Paimon.md
b/docs/zh/connectors/sink/Paimon.md
index ddbae6f261..902e40d7c6 100644
--- a/docs/zh/connectors/sink/Paimon.md
+++ b/docs/zh/connectors/sink/Paimon.md
@@ -89,6 +89,7 @@ libfb303-xxx.jar
| paimon.hadoop.conf-path | 字符串 | 否 | - |
Hadoop配置文件目录，用于加载'core-site.xml', 'hdfs-site.xml', 'hive-site.xml'文件配置
|
| paimon.table.non-primary-key | Boolean | 否 | false
| 控制创建主键表或者非主键表. 当为true时,创建非主键表, 为false时,创建主键表
|
| branch | 字符串 | 否 | - |
要写入数据的 Paimon 表分支名称。不配置时写入 main 分支。非 main 分支要求 main 表和目标分支已存在，且不支持
`schema_save_mode=RECREATE_SCHEMA` 或 `data_save_mode=DROP_DATA`。 |
+| multi_table_sink_replica | int | 否 | 1
| 多表写入模式下每张表的 writer 副本数。当一个上游作业写入多张 Paimon 表、且每张表需要多个 sink writer 时使用。
|
### table_options [Map]
@@ -134,7 +135,7 @@
Paimon表的changelog产生模式有[四种](https://paimon.apache.org/docs/mast
*
[`lookup`](https://paimon.apache.org/docs/master/primary-key-table/changelog-producer/#lookup)
*
[`full-compaction`](https://paimon.apache.org/docs/master/primary-key-table/changelog-producer/#full-compaction)
> 注意：
-> 当你使用流模式去读paimon表的数据时，不同模式将会产生[不同的结果](../source/Paimon.md#changelog)。
+>
当你使用流模式去读paimon表的数据时，不同模式将会产生[不同的结果](../source/Paimon.md#读取-paimon-表的-changelog)。
## 文件系统
Paimon连接器支持向多文件系统写入数据。目前支持的文件系统有hdfs和s3。
@@ -666,7 +667,7 @@ sink {
### Paimon Sink 连接器是否支持自动建表？
-支持。当配置 `paimon.auto-create-table = true` 或 `schema_save_mode =
"CREATE_SCHEMA_WHEN_NOT_EXIST"` 时，SeaTunnel 会自动根据上游传递的元数据信息初始化目标 Paimon
表（包含主键与分区配置）。
+支持。当配置 `schema_save_mode = "CREATE_SCHEMA_WHEN_NOT_EXIST"` 时，SeaTunnel
会自动根据上游传递的元数据信息初始化目标 Paimon 表（包含主键与分区配置）。
### Paimon Sink 如何保证精确一次（Exactly-Once）写入？
diff --git a/docs/zh/connectors/source/MongoDB-CDC.md
b/docs/zh/connectors/source/MongoDB-CDC.md
index 7b60d22742..b2b651ba59 100644
--- a/docs/zh/connectors/source/MongoDB-CDC.md
+++ b/docs/zh/connectors/source/MongoDB-CDC.md
@@ -127,11 +127,13 @@ db.grantRolesToUser("<USER_NAME>", ["<ROLE_NAME>"])
| poll.await.time.ms | Integer | 否 | 1000 |
检查变更流新结果前等待的时间，单位为毫秒。
|
| heartbeat.interval.ms | Integer | 否 | 0 |
发送心跳消息的间隔，单位为毫秒。设置为 `0` 表示禁用心跳。
|
| incremental.snapshot.chunk.size.mb | Integer | 否 | 64 |
增量快照读取时的分片大小，单位为 MB。
|
+| incremental.parallelism | Integer | 否 | 1 |
增量阶段中并行读取器的数量。
|
| startup.mode | Enum | 否 | INITIAL | MongoDB CDC
的启动模式，可选值为 `initial`、`latest` 和 `timestamp`。详见下方[启动模式](#启动模式)。
|
| startup.timestamp | Long | 否 | - |
从指定的毫秒级时间戳开始消费。仅在 `startup.mode` 为 `timestamp` 时使用。
|
| stop.mode | Enum | 否 | NEVER | MongoDB CDC
的停止模式，可选值为 `never` 和 `timestamp`。详见下方[停止模式](#停止模式)。
|
| stop.timestamp | Long | 否 | - |
在该毫秒级时间戳对应的变更流位置停止。仅在 `stop.mode` 为 `timestamp` 时使用。
|
| exactly_once | Boolean | 否 | false |
启用精确一次语义。开启后，大表快照阶段恢复时可能增加内存使用。
|
+| format | Enum | 否 | DEFAULT | MongoDB CDC
的输出数据格式，可选值为 `DEFAULT` 和 `COMPATIBLE_DEBEZIUM_JSON`。
|
| debezium | Config | 否 | - | 透传给内嵌
Debezium 引擎的配置。
|
| common-options | | 否 | - | 源插件通用参数，请参考
[源通用选项](../common-options/source-common-options.md)。
|
diff --git a/docs/zh/connectors/source/Paimon.md
b/docs/zh/connectors/source/Paimon.md
index e753440962..5d2c512e67 100644
--- a/docs/zh/connectors/source/Paimon.md
+++ b/docs/zh/connectors/source/Paimon.md
@@ -278,7 +278,7 @@ source {
}
```
-## Changelog
+## 读取 Paimon 表的 changelog
如果要读取 paimon 表的 changelog，首先要为 Paimon 源表设置 `changelog-producer`，然后使用 SeaTunnel
流任务读取。
@@ -319,7 +319,7 @@ SeaTunnel Paimon 源连接器支持批处理快照读取与流式 changelog 消
### 如何配置 Paimon 的存储路径与 Catalog？
-通过 `warehouse` 配置底层存储根路径（如 `hdfs:///paimon/warehouse`、`s3a://bucket/warehouse`
或本地路径），并通过 `paimon.catalog.type` 指定 Catalog 类型（如 `filesystem`、`hive`
等）。相关的存储认证参数可统一在 `paimon.hadoop.conf` 中声明。
+通过 `warehouse` 配置底层存储根路径（如 `hdfs:///paimon/warehouse`、`s3a://bucket/warehouse`
或本地路径），并通过 `catalog_type` 指定 Catalog 类型（如 `filesystem`、`hive` 等）。相关的存储认证参数可统一在
`paimon.hadoop.conf` 中声明。
### Paimon 源连接器是否支持列投影？
diff --git a/docs/zh/connectors/source/Redis.md
b/docs/zh/connectors/source/Redis.md
index 042868ab08..ff9064280b 100644
--- a/docs/zh/connectors/source/Redis.md
+++ b/docs/zh/connectors/source/Redis.md
@@ -57,6 +57,8 @@ Redis 值。校验成功**不代表**匹配的 key 存在、已存储的值与 `
| db_num | int | 否 | 0 | Redis 数据库索引 |
| mode | string | 否 | single | Redis 模式：`single` 或
`cluster` |
| nodes | list | `mode=cluster` 时必须 | - | Redis 集群节点，格式为
`["host1:port1", "host2:port2"]` |
+| keys | string | 未配置 `tables_configs` 时必须 | - | 要扫描的 Redis key
pattern，支持模糊匹配；用户需保证匹配到的 key 类型相同。与 `tables_configs` 互斥。 |
+| data_type | string | 未配置 `tables_configs` 时必须 | - | 匹配到的 key 的
Redis 数据类型：`key`、`string`、`hash`、`list`、`set`、`zset`。单 key pattern 读取时需与 `keys`
一起配置。 |
| tables_configs | list | 否 | - | 多表读取时的表配置列表 |
| common-options | | 否 | - | 源连接器插件通用参数，详情请参见
[Source Common Options](../common-options/source-common-options.md) |
diff --git a/docs/zh/connectors/source/SqlServer-CDC.md
b/docs/zh/connectors/source/SqlServer-CDC.md
index ec9c4c0cfe..9e4579286b 100644
--- a/docs/zh/connectors/source/SqlServer-CDC.md
+++ b/docs/zh/connectors/source/SqlServer-CDC.md
@@ -86,8 +86,8 @@ Sql Server CDC 连接器允许从 SqlServer 数据库读取快照数据和增量
| incremental.parallelism | Integer | 否 | 1
| 增量阶段中并行读取器的数量。
|
| snapshot.split.size | Integer | 否 | 8096
| 表快照的分割大小（行数），读取表快照时，捕获的表会被分割为多个分割。
|
| snapshot.fetch.size | Integer | 否 | 1024
| 读取表快照时每次轮询的最大获取大小。
|
-| server-time-zone | String | 否 | UTC
| 数据库服务器中的会话时区。该参数也用于将 `startup.timestamp` 转换为 LSN。若数据库时区与 JVM 时区不同，建议显式配置。
|
-| connect.timeout | Duration | 否 | 30s
| 连接器尝试连接到数据库服务器后在超时之前应该等待的最长时间。
|
+| server-time-zone | String | 否 | -
| 数据库服务器中的会话时区。未设置时，默认使用 JVM 系统时区（`ZoneId.systemDefault()`）。该参数也用于将
`startup.timestamp` 转换为 LSN。若数据库时区与 JVM 时区不同，建议显式配置。
|
+| connect.timeout.ms | Long | 否 | 30000
| 连接器尝试连接到数据库服务器后在超时之前应该等待的最长时间，单位为毫秒。
|
| connect.max-retries | Integer | 否 | 3
| 连接器应该重试建立数据库服务器连接的最大重试次数。
|
| connection.pool.size | Integer | 否 | 20
| 连接池大小。
|
| chunk-key.even-distribution.factor.upper-bound | Double | 否 | 100
| 分块键分布因子的上界。此因子用于确定表数据是否均匀分布。如果计算的分布因子小于或等于此上界（即，(MAX(id) - MIN(id) + 1) /
行数），表分块将被优化以实现均匀分布。否则，如果分布因子较大，如果估计的分片数超过 `sample-sharding.threshold`
指定的值，表将被视为不均匀分布并使用基于采样的分片策略。默认值为 100.0。 |
