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-12833-662fbf70d001bd071f4b90e7bd305904481d95ab in repository https://gitbox.apache.org/repos/asf/seatunnel.git
commit 5d73e623a5d5e36a89e6c900e07325c11985f301 Author: Jast <[email protected]> AuthorDate: Sun Oct 18 14:02:28 2026 +0000 [Docs] Fix connector and transform doc inaccuracies verified against source code (#12833) Co-authored-by: zhangshenghang <[email protected]> --- docs/en/connectors/sink/DB2.md | 6 +++--- docs/en/connectors/sink/Databend.md | 2 +- docs/en/connectors/sink/Mysql.md | 4 ++-- docs/en/connectors/sink/OceanBase.md | 4 ++-- docs/en/connectors/sink/PostgreSql.md | 4 +++- docs/en/connectors/sink/Zendesk.md | 2 +- docs/en/connectors/source/Kingbase.md | 8 ++++---- docs/en/connectors/source/Klaviyo.md | 2 +- docs/en/connectors/source/Lemlist.md | 4 ++-- docs/en/connectors/source/Prometheus.md | 2 +- docs/en/connectors/source/Zendesk.md | 4 ++-- docs/en/transforms/copy.md | 2 +- docs/zh/connectors/sink/DB2.md | 6 +++--- docs/zh/connectors/sink/Databend.md | 2 +- docs/zh/connectors/sink/Mysql.md | 4 ++-- docs/zh/connectors/sink/OceanBase.md | 4 ++-- docs/zh/connectors/sink/Oracle.md | 4 ++-- docs/zh/connectors/sink/PostgreSql.md | 4 +++- docs/zh/connectors/sink/Zendesk.md | 2 +- docs/zh/connectors/source/Kingbase.md | 10 +++++----- docs/zh/connectors/source/Klaviyo.md | 2 +- docs/zh/connectors/source/Lemlist.md | 4 ++-- docs/zh/connectors/source/Prometheus.md | 2 +- docs/zh/connectors/source/Zendesk.md | 5 ++--- docs/zh/transforms/copy.md | 2 +- 25 files changed, 49 insertions(+), 46 deletions(-) diff --git a/docs/en/connectors/sink/DB2.md b/docs/en/connectors/sink/DB2.md index 03e4e2b231..5290fe9a92 100644 --- a/docs/en/connectors/sink/DB2.md +++ b/docs/en/connectors/sink/DB2.md @@ -47,9 +47,9 @@ Write data to DB2 through JDBC. Supports batch and streaming jobs, concurrent wr |------------------------------------------------------------------------------------------------------|---------------------| | BOOLEAN | BOOLEAN | | SMALLINT | SHORT | -| INT<br/>INTEGER<br/> | INTEGER | -| BIGINT | LONG | -| DECIMAL<br/>DEC<br/>NUMERIC<br/>NUM | DECIMAL(38,18) | +| INT<br/>INTEGER<br/> | INT | +| BIGINT | BIGINT | +| DECIMAL<br/>DEC<br/>NUMERIC<br/>NUM | DECIMAL((Get the designated column's specified column size),<br/>(Gets the designated column's number of digits to right of the decimal point.))) | | REAL | FLOAT | | FLOAT<br/>DOUBLE<br/>DOUBLE PRECISION<br/>DECFLOAT | DOUBLE | | CHAR<br/>VARCHAR<br/>LONG VARCHAR<br/>CLOB<br/>GRAPHIC<br/>VARGRAPHIC<br/>LONG VARGRAPHIC<br/>DBCLOB<br/>XML | STRING | diff --git a/docs/en/connectors/sink/Databend.md b/docs/en/connectors/sink/Databend.md index 74dd6f91d5..ea27ed9c6b 100644 --- a/docs/en/connectors/sink/Databend.md +++ b/docs/en/connectors/sink/Databend.md @@ -49,7 +49,7 @@ They can be downloaded via install-plugin.sh or from the Maven central repositor | url | String | Yes | - | Databend JDBC connection URL. It must start with `jdbc:databend://` | | username | String | Yes | - | Databend database username | | password | String | Yes | - | Databend database password | -| database | String | No | - | Databend database name used when `generate_sink_sql = true` (together with `table`) to generate the write SQL. No default is applied when unset | +| database | String | No | - | Databend database name (together with `table`) that locates the target table to write | | table | String | No | - | Databend table name | | batch_size | Integer | No | 1000 | Number of records for batch writing | | auto_commit | Boolean | No | true | Whether to auto-commit transactions | diff --git a/docs/en/connectors/sink/Mysql.md b/docs/en/connectors/sink/Mysql.md index ea7832dc92..388571c2e2 100644 --- a/docs/en/connectors/sink/Mysql.md +++ b/docs/en/connectors/sink/Mysql.md @@ -235,7 +235,7 @@ transform { } sink { - Mysql { + jdbc { url = "jdbc:mysql://localhost:3306?useUnicode=true&characterEncoding=UTF-8&rewriteBatchedStatements=true" driver = "com.mysql.cj.jdbc.Driver" username = "root" @@ -279,7 +279,7 @@ transform { } sink { - Mysql { + jdbc { url = "jdbc:mysql://localhost:3306?useUnicode=true&characterEncoding=UTF-8&rewriteBatchedStatements=true" driver = "com.mysql.cj.jdbc.Driver" username = "root" diff --git a/docs/en/connectors/sink/OceanBase.md b/docs/en/connectors/sink/OceanBase.md index f460d4ba01..3efb8cd4c0 100644 --- a/docs/en/connectors/sink/OceanBase.md +++ b/docs/en/connectors/sink/OceanBase.md @@ -53,7 +53,7 @@ Write data to OceanBase through JDBC. The sink supports batch and streaming jobs | DATE | DATE | | TIME | TIME | | DATETIME<br/>TIMESTAMP | TIMESTAMP | -| TINYBLOB<br/>MEDIUMBLOB<br/>BLOB<br/>LONGBLOB<br/>BINARY<br/>VARBINAR<br/>BIT(n) | BYTES | +| TINYBLOB<br/>MEDIUMBLOB<br/>BLOB<br/>LONGBLOB<br/>BINARY<br/>VARBINARY<br/>BIT(n) | BYTES | | GEOMETRY<br/>UNKNOWN | Not supported yet | ### Oracle Mode @@ -282,7 +282,7 @@ sink { table = "sink_table" primary_keys = ["id"] is_exactly_once = true - xa_data_source_class_name = "com.oceanbase.jdbc.OceanBaseXADataSource" + xa_data_source_class_name = "com.oceanbase.jdbc.OceanBaseDataSource" max_retries = 0 batch_size = 1000 } diff --git a/docs/en/connectors/sink/PostgreSql.md b/docs/en/connectors/sink/PostgreSql.md index 213289ddf5..1b2c456c31 100644 --- a/docs/en/connectors/sink/PostgreSql.md +++ b/docs/en/connectors/sink/PostgreSql.md @@ -33,7 +33,7 @@ semantics (using XA transaction guarantee). - [x] [timer flush](../../introduction/concepts/connector-v2-features.md) > Use `Xa transactions` to ensure `exactly-once`. So only support > `exactly-once` for the database which is -> support `Xa transactions`. You can set `is_exactly_once=true` to enable it. +> support `Xa transactions`. You can set `is_exactly_once=true` and `max_retries=0` to enable it. ## Supported DataSource Info @@ -88,6 +88,7 @@ semantics (using XA transaction guarantee). | connection_check_timeout_sec | Int | No | 30 | The time in seconds to wait for the database operation used to validate the connection to complete. [...] | max_retries | Int | No | 0 | The number of retries to submit failed (executeBatch) [...] | batch_size | Int | No | 1000 | For batch writing, when the number of buffered records reaches the number of `batch_size` or the time reaches `checkpoint.interval`<br/>, the data will be flushed into the database [...] +| batch_interval_ms | Long | No | 0 | Write-triggered flush interval in milliseconds. `0` disables time-based flushing. When greater than 0, the writer checks elapsed time on each record and flushes synchronously when the interval is reached. | | is_exactly_once | Boolean | No | false | Whether to enable exactly-once semantics, which will use Xa transactions. If on, you need to<br/>set `xa_data_source_class_name`. [...] | generate_sink_sql | Boolean | No | false | Generate sql statements based on the database table you want to write to. [...] | xa_data_source_class_name | String | No | - | The xa data source class name of the database Driver, for example, PostgreSQL is `org.postgresql.xa.PGXADataSource`, and<br/>please refer to appendix for other data sources [...] @@ -102,6 +103,7 @@ semantics (using XA transaction guarantee). | custom_sql | String | no | - | When data_save_mode selects CUSTOM_PROCESSING, you should fill in the CUSTOM_SQL parameter. This parameter usually fills in a SQL that can be executed. SQL will be executed before synchronization tasks. [...] | enable_upsert | Boolean | No | true | Enable upsert by primary_keys exist, If the task has no key duplicate data, setting this parameter to `false` can speed up data import [...] | use_copy_statement | Boolean | No | false | Use PostgreSQL `COPY <table> (...) FROM STDIN WITH CSV` for bulk import. This option takes precedence over the regular INSERT / UPSERT path, requires a JDBC driver connection that exposes `getCopyAPI()`, and does not support `MAP`, `ARRAY`, or `ROW` types. [...] +| multi_table_sink_replica | Int | No | 1 | The number of sink writer replicas used when writing multiple tables. | ### table [string] diff --git a/docs/en/connectors/sink/Zendesk.md b/docs/en/connectors/sink/Zendesk.md index 645add6afc..3202abc051 100644 --- a/docs/en/connectors/sink/Zendesk.md +++ b/docs/en/connectors/sink/Zendesk.md @@ -23,7 +23,7 @@ URL (e.g., `{"ticket": {...}}` for the tickets endpoint). - [ ] [exactly-once](../../introduction/concepts/connector-v2-features.md) - [ ] [cdc](../../introduction/concepts/connector-v2-features.md) -- [ ] [support multiple table write](../../introduction/concepts/connector-v2-features.md) +- [x] [support multiple table write](../../introduction/concepts/connector-v2-features.md) - [ ] [timer flush](../../introduction/concepts/connector-v2-features.md) ## Sink Options diff --git a/docs/en/connectors/source/Kingbase.md b/docs/en/connectors/source/Kingbase.md index 2423b2b131..c818334b6b 100644 --- a/docs/en/connectors/source/Kingbase.md +++ b/docs/en/connectors/source/Kingbase.md @@ -63,16 +63,16 @@ Read external data source data through JDBC. | driver | String | Yes | - | The jdbc class name used to connect to the remote data source, should be `com.kingbase8.Driver`. | | username | String | No | - | Connection instance user name. The old key `user` is still accepted as a fallback. | | password | String | No | - | Connection instance password | -| query | String | Yes | - | Query statement | +| query | String | No | - | Query statement | | connection_check_timeout_sec | Int | No | 30 | The time in seconds to wait for the database operation used to validate the connection to complete | | partition_column | String | No | - | The column name for parallelism's partition, only support numeric type column and string type column. | -| partition_lower_bound | BigDecimal | No | - | The partition_column min value for scan, if not set SeaTunnel will query database get min value. | -| partition_upper_bound | BigDecimal | No | - | The partition_column max value for scan, if not set SeaTunnel will query database get max value. | +| partition_lower_bound | String | No | - | The partition_column min value for scan, if not set SeaTunnel will query database get min value. | +| partition_upper_bound | String | No | - | The partition_column max value for scan, if not set SeaTunnel will query database get max value. | | partition_num | Int | No | 10 | The number of partition count, only support positive integer. Default value is 10. | | fetch_size | Int | No | 0 | For queries that return a large number of objects, you can configure <br/> the row fetch size used in the query to improve performance by <br/> reducing the number database hits required to satisfy the selection criteria.<br/> Zero means use jdbc default value. | | use_regex | Boolean | No | false | Control regular expression matching for table_path. When set to `true`, the table_path will be treated as a regular expression pattern. When set to `false` or not specified, the table_path will be treated as an exact path (no regex matching). | | table_path | String | No | - | The path to the full path of table, you can use this configuration instead of `query`. <br/>example: <br/>"test_schema.table1" [...] -| table_list | Array | No | - | The list of tables to be read, you can use this configuration instead of `table_path` example: ```[{ table_path = "testdb.table1"}, {table_path = "testdb.table2", query = "select * id, name from testdb.table2"}]``` [...] +| table_list | Array | No | - | The list of tables to be read, you can use this configuration instead of `table_path` example: ```[{ table_path = "testdb.table1"}, {table_path = "testdb.table2", query = "select id, name from testdb.table2"}]``` [...] | where_condition | String | No | - | Common row filter conditions for all tables/queries, must start with `where`. for example `where id > 100` [...] | split.size | Int | No | 8096 | The split size (number of rows) of table, captured tables are split into multiple splits when read of table. [...] | split.even-distribution.factor.lower-bound | Double | No | 0.05 | The lower 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 greater than or equal to this lower 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 less, the table will be considered a [...] diff --git a/docs/en/connectors/source/Klaviyo.md b/docs/en/connectors/source/Klaviyo.md index 0e5cee52be..74441016eb 100644 --- a/docs/en/connectors/source/Klaviyo.md +++ b/docs/en/connectors/source/Klaviyo.md @@ -13,7 +13,7 @@ Reads data from Klaviyo APIs. The connector builds Klaviyo request headers from - [x] [batch](../../introduction/concepts/connector-v2-features.md) - [x] [stream](../../introduction/concepts/connector-v2-features.md) - [ ] [exactly-once](../../introduction/concepts/connector-v2-features.md) -- [x] [column projection](../../introduction/concepts/connector-v2-features.md) +- [ ] [column projection](../../introduction/concepts/connector-v2-features.md) - [ ] [parallelism](../../introduction/concepts/connector-v2-features.md) - [ ] [support user-defined split](../../introduction/concepts/connector-v2-features.md) diff --git a/docs/en/connectors/source/Lemlist.md b/docs/en/connectors/source/Lemlist.md index fb053a6cfd..6ea60f49fa 100644 --- a/docs/en/connectors/source/Lemlist.md +++ b/docs/en/connectors/source/Lemlist.md @@ -13,7 +13,7 @@ Reads data from Lemlist APIs. The connector uses `password` as the Lemlist API k - [x] [batch](../../introduction/concepts/connector-v2-features.md) - [x] [stream](../../introduction/concepts/connector-v2-features.md) - [ ] [exactly-once](../../introduction/concepts/connector-v2-features.md) -- [x] [column projection](../../introduction/concepts/connector-v2-features.md) +- [ ] [column projection](../../introduction/concepts/connector-v2-features.md) - [ ] [parallelism](../../introduction/concepts/connector-v2-features.md) - [ ] [support user-defined split](../../introduction/concepts/connector-v2-features.md) @@ -30,7 +30,7 @@ In streaming mode, the connector repeatedly calls the configured API. Set `poll_ | url | String | Yes | - | Lemlist API URL. | | password | String | Yes | - | Lemlist API key. | | method | String | No | GET | HTTP method. Supported values are `GET` and `POST`. | -| headers | Map | No | - | Extra HTTP request headers. Do not put `Authorization` here unless you intentionally want to override the generated header. | +| headers | Map | No | - | Extra HTTP request headers. Any `Authorization` value set here is overwritten by the generated Basic auth header. | | params | Map | No | - | HTTP query parameters. | | body | String | No | - | HTTP request body, usually used with `POST`. | | format | String | No | TEXT | Response format. Use `json` when the response should be parsed by `schema`, `json_field`, or `content_field`. | diff --git a/docs/en/connectors/source/Prometheus.md b/docs/en/connectors/source/Prometheus.md index a34f23cdc5..18442901e4 100644 --- a/docs/en/connectors/source/Prometheus.md +++ b/docs/en/connectors/source/Prometheus.md @@ -22,7 +22,7 @@ SeaTunnel automatically uses the Prometheus query endpoint for `Instant` queries ## Key Features - [x] [batch](../../introduction/concepts/connector-v2-features.md) -- [ ] [stream](../../introduction/concepts/connector-v2-features.md) +- [x] [stream](../../introduction/concepts/connector-v2-features.md) - [ ] [parallelism](../../introduction/concepts/connector-v2-features.md) ## Supported DataSource Info diff --git a/docs/en/connectors/source/Zendesk.md b/docs/en/connectors/source/Zendesk.md index cefc2f158a..657a76ae7a 100644 --- a/docs/en/connectors/source/Zendesk.md +++ b/docs/en/connectors/source/Zendesk.md @@ -17,14 +17,14 @@ authenticates with a Zendesk account email and API token (sent as an HTTP Basic header) and reads a Zendesk endpoint such as tickets, users, or organizations into SeaTunnel rows. This connector is built on top of the [Http source](Http.md) connector and inherits most of its -options. The differences are the required authentication options and the `format` default. +options. The differences are the required authentication options (`email` and `api_token`). ## Key features - [x] [batch](../../introduction/concepts/connector-v2-features.md) - [ ] [stream](../../introduction/concepts/connector-v2-features.md) - [ ] [exactly-once](../../introduction/concepts/connector-v2-features.md) -- [x] [column projection](../../introduction/concepts/connector-v2-features.md) +- [ ] [column projection](../../introduction/concepts/connector-v2-features.md) - [ ] [parallelism](../../introduction/concepts/connector-v2-features.md) - [ ] [support user-defined split](../../introduction/concepts/connector-v2-features.md) diff --git a/docs/en/transforms/copy.md b/docs/en/transforms/copy.md index bae22eb634..7daccdc6fb 100644 --- a/docs/en/transforms/copy.md +++ b/docs/en/transforms/copy.md @@ -10,7 +10,7 @@ Copy a field to a new field. | name | type | required | default value | |--------|--------|----------|---------------| -| fields | Object | yes | | +| fields | Object | yes (or the deprecated `src_field`+`dest_field` pair) | | | src_field | String | no | | | dest_field | String | no | | diff --git a/docs/zh/connectors/sink/DB2.md b/docs/zh/connectors/sink/DB2.md index 8bf3660e66..b801f227a9 100644 --- a/docs/zh/connectors/sink/DB2.md +++ b/docs/zh/connectors/sink/DB2.md @@ -47,9 +47,9 @@ import ChangeLog from '../changelog/connector-jdbc.md'; |------------------------------------------------------------------------------------------------------|--------------------| | BOOLEAN | BOOLEAN | | SMALLINT | SHORT | -| INT<br/>INTEGER | INTEGER | -| BIGINT | LONG | -| DECIMAL<br/>DEC<br/>NUMERIC<br/>NUM | DECIMAL(38,18) | +| INT<br/>INTEGER | INT | +| BIGINT | BIGINT | +| DECIMAL<br/>DEC<br/>NUMERIC<br/>NUM | DECIMAL((获取指定列的指定列大小),<br/>(获取指定列小数点右边的位数。))) | | REAL | FLOAT | | FLOAT<br/>DOUBLE<br/>DOUBLE PRECISION<br/>DECFLOAT | DOUBLE | | CHAR<br/>VARCHAR<br/>LONG VARCHAR<br/>CLOB<br/>GRAPHIC<br/>VARGRAPHIC<br/>LONG VARGRAPHIC<br/>DBCLOB<br/>XML | STRING | diff --git a/docs/zh/connectors/sink/Databend.md b/docs/zh/connectors/sink/Databend.md index e2d009b7b1..fc179ffb98 100644 --- a/docs/zh/connectors/sink/Databend.md +++ b/docs/zh/connectors/sink/Databend.md @@ -48,7 +48,7 @@ Databend sink 内部通过 stage attachment 实现数据的批量导入。 | url | String | 是 | - | Databend JDBC 连接 URL，必须以 `jdbc:databend://` 开头 | | username | String | 是 | - | Databend 数据库用户名 | | password | String | 是 | - | Databend 数据库密码 | -| database | String | 否 | - | `generate_sink_sql = true` 时与 `table` 一起用于生成写入 SQL 的 Databend 数据库名称。未设置时不会自动回退 | +| database | String | 否 | - | 与 `table` 一起用于定位写入目标表的 Databend 数据库名称 | | table | String | 否 | - | Databend 表名称 | | batch_size | Integer | 否 | 1000 | 批量写入的记录数 | | auto_commit | Boolean | 否 | true | 是否自动提交事务 | diff --git a/docs/zh/connectors/sink/Mysql.md b/docs/zh/connectors/sink/Mysql.md index 26a7ec7d7d..1943ba5e18 100644 --- a/docs/zh/connectors/sink/Mysql.md +++ b/docs/zh/connectors/sink/Mysql.md @@ -235,7 +235,7 @@ transform { } sink { - Mysql { + jdbc { url = "jdbc:mysql://localhost:3306?useUnicode=true&characterEncoding=UTF-8&rewriteBatchedStatements=true" driver = "com.mysql.cj.jdbc.Driver" username = "root" @@ -279,7 +279,7 @@ transform { } sink { - Mysql { + jdbc { url = "jdbc:mysql://localhost:3306?useUnicode=true&characterEncoding=UTF-8&rewriteBatchedStatements=true" driver = "com.mysql.cj.jdbc.Driver" username = "root" diff --git a/docs/zh/connectors/sink/OceanBase.md b/docs/zh/connectors/sink/OceanBase.md index 4f45bca940..9252c746d4 100644 --- a/docs/zh/connectors/sink/OceanBase.md +++ b/docs/zh/connectors/sink/OceanBase.md @@ -53,7 +53,7 @@ import ChangeLog from '../changelog/connector-jdbc.md'; | DATE | DATE | | TIME | TIME | | DATETIME<br/>TIMESTAMP | TIMESTAMP | -| TINYBLOB<br/>MEDIUMBLOB<br/>BLOB<br/>LONGBLOB<br/>BINARY<br/>VARBINAR<br/>BIT(n) | BYTES | +| TINYBLOB<br/>MEDIUMBLOB<br/>BLOB<br/>LONGBLOB<br/>BINARY<br/>VARBINARY<br/>BIT(n) | BYTES | | GEOMETRY<br/>UNKNOWN | 暂不支持 | ### Oracle 模式 @@ -282,7 +282,7 @@ sink { table = "sink_table" primary_keys = ["id"] is_exactly_once = true - xa_data_source_class_name = "com.oceanbase.jdbc.OceanBaseXADataSource" + xa_data_source_class_name = "com.oceanbase.jdbc.OceanBaseDataSource" max_retries = 0 batch_size = 1000 } diff --git a/docs/zh/connectors/sink/Oracle.md b/docs/zh/connectors/sink/Oracle.md index d818821a12..6e8e2cecf0 100644 --- a/docs/zh/connectors/sink/Oracle.md +++ b/docs/zh/connectors/sink/Oracle.md @@ -81,7 +81,7 @@ import ChangeLog from '../changelog/connector-jdbc.md'; | batch_interval_ms | Long | 否 | 0 | 写入触发的定时刷新间隔，单位毫秒。`0` 表示关闭定时刷新；大于 0 时，写入器会在每条记录写入时检查间隔，达到间隔后同步刷新。 | | is_exactly_once | Boolean | 否 | false | 是否启用精确一次语义，这将使用Xa事务。如果启用，则需要<br/>设置`xa_data_source_class_name`。 | | generate_sink_sql | Boolean | 否 | false | 根据要写入的数据库表生成sql语句 | -| xa_data_source_class_name | String | 否 | - | 数据库Driver的xa数据源类名，例如Oracle，是`Oracle.jdbc.xa.client。OracleXADataSource和<br/>请参阅附录了解其他数据源 | +| xa_data_source_class_name | String | 否 | - | 数据库Driver的xa数据源类名，例如 Oracle 是 `oracle.jdbc.xa.client.OracleXADataSource`，<br/>请参阅附录了解其他数据源 | | max_commit_attempts | Int | 否 | 3 | 事务提交失败的重试次数 | | transaction_timeout_sec | Int | 否 | -1 | 事务打开后的超时，默认值为-1（永不超时）。请注意，设置超时可能会影响＜br/＞精确一次语义 | | auto_commit | Boolean | 否 | true | 默认情况下启用自动事务提交。Oracle Sink 即使配置为 `true`，实际写入时也会在内部使用手动提交，以保证失败批次的原子性并保留原始数据错误。 | @@ -90,7 +90,7 @@ import ChangeLog from '../changelog/connector-jdbc.md'; | schema_save_mode | Enum | 否 | CREATE_SCHEMA_WHEN_NOT_EXIST | 在启动同步任务之前，对目标侧的现有表面结构选择不同的处理方案。 | | data_save_mode | Enum | 否 | APPEND_DATA | 在启动同步任务之前，对目标端的现有数据选择不同的处理方案。 | | custom_sql | String | 否 | - | 当data_save_mode选择CUSTOM_PROCESSING时，您应该填写CUSTOM_SQL参数。此参数通常填充可以执行的SQL。SQL将在同步任务之前执行。 | -| enable_upsert | Boolean | 否 | true | 通过primary_keys存在启用upstart，如果任务只有“插入”，将此参数设置为“false”可以加快数据导入 | +| enable_upsert | Boolean | 否 | true | 通过 `primary_keys` 启用 upsert，如果任务没有重复键数据，将此参数设置为 `false` 可以加快数据导入 | | multi_table_sink_replica | Int | 否 | 1 | 多表写入时使用的 Sink Writer 副本数量。 | ### 提示 diff --git a/docs/zh/connectors/sink/PostgreSql.md b/docs/zh/connectors/sink/PostgreSql.md index 80c7681579..04c4fb8e15 100644 --- a/docs/zh/connectors/sink/PostgreSql.md +++ b/docs/zh/connectors/sink/PostgreSql.md @@ -31,7 +31,7 @@ import ChangeLog from '../changelog/connector-jdbc.md'; - [x] [支持多表写入](../../introduction/concepts/connector-v2-features.md) - [x] [定时刷新](../../introduction/concepts/connector-v2-features.md) -> 使用 `XA 事务` 来确保 `精确一次`。因此，仅对支持 `XA 事务` 的数据库支持 `精确一次`。您可以设置 `is_exactly_once=true` 来启用此功能。 +> 使用 `XA 事务` 来确保 `精确一次`。因此，仅对支持 `XA 事务` 的数据库支持 `精确一次`。您可以设置 `is_exactly_once=true` 和 `max_retries=0` 来启用此功能。 ## 支持的数据源信息 | 数据源 | 支持的版本 | 驱动 | URL | Maven | @@ -84,6 +84,7 @@ import ChangeLog from '../changelog/connector-jdbc.md'; | connection_check_timeout_sec | Int | 否 | 30 | 用于验证连接的数据库操作完成的等待时间（秒）。 [...] | max_retries | Int | 否 | 0 | 提交失败的重试次数（executeBatch）。 [...] | batch_size | Int | 否 | 1000 | 对于批量写入，当缓冲记录的数量达到 `batch_size` 或时间达到 `checkpoint.interval`<br/>时，数据将刷新到数据库。 [...] +| batch_interval_ms | Long | 否 | 0 | 写入触发的定时刷新间隔，单位毫秒。`0` 表示关闭定时刷新；大于 0 时，写入器会在每条记录写入时检查间隔，达到间隔后同步刷新。 | | is_exactly_once | Boolean | 否 | false | 是否启用精确一次语义，将使用 XA 事务。如果启用，您需要<br/>设置 `xa_data_source_class_name`。 [...] | generate_sink_sql | Boolean | 否 | false | 根据要写入的数据库表生成 SQL 语句。 [...] | xa_data_source_class_name | String | 否 | - | 数据库驱动的 XA 数据源类名，例如，PostgreSQL 是 `org.postgresql.xa.PGXADataSource`，并<br/>请参阅附录以获取其他数据源。 [...] @@ -98,6 +99,7 @@ import ChangeLog from '../changelog/connector-jdbc.md'; | custom_sql | String | 否 | - | 当 `data_save_mode` 选择 `CUSTOM_PROCESSING` 时，您应该填写 `CUSTOM_SQL` 参数。此参数通常填入可执行的 SQL。SQL 将在同步任务之前执行。 [...] | enable_upsert | Boolean | 否 | true | 通过主键存在启用 upsert，如果任务没有重复数据，设置此参数为 `false` 可以加快数据导入。 [...] | use_copy_statement | Boolean | 否 | false | 直接使用 PostgreSQL `COPY <table> (...) FROM STDIN WITH CSV` 进行批量导入。该选项优先级高于常规 INSERT / UPSERT 路径；要求 JDBC 驱动连接对象提供 `getCopyAPI()`，且当前不支持 `MAP`、`ARRAY`、`ROW` 类型。 [...] +| multi_table_sink_replica | Int | 否 | 1 | 多表写入时使用的 Sink Writer 副本数量。 | ### table [字符串] diff --git a/docs/zh/connectors/sink/Zendesk.md b/docs/zh/connectors/sink/Zendesk.md index 8124cc9842..41417f6e50 100644 --- a/docs/zh/connectors/sink/Zendesk.md +++ b/docs/zh/connectors/sink/Zendesk.md @@ -20,7 +20,7 @@ import ChangeLog from '../changelog/connector-http-zendesk.md'; - [ ] [exactly-once](../../introduction/concepts/connector-v2-features.md) - [ ] [cdc](../../introduction/concepts/connector-v2-features.md) -- [ ] [支持多表写入](../../introduction/concepts/connector-v2-features.md) +- [x] [支持多表写入](../../introduction/concepts/connector-v2-features.md) - [ ] [定时刷新](../../introduction/concepts/connector-v2-features.md) ## Sink 选项 diff --git a/docs/zh/connectors/source/Kingbase.md b/docs/zh/connectors/source/Kingbase.md index f98a6d6383..30f64c1428 100644 --- a/docs/zh/connectors/source/Kingbase.md +++ b/docs/zh/connectors/source/Kingbase.md @@ -48,7 +48,7 @@ import ChangeLog from '../changelog/connector-jdbc.md'; | INT8 <br/>BIGSERIAL | BIGINT | | FLOAT4 | FLOAT | | FLOAT8 | DOUBLE | -| NUMERIC | DECIMAL | +| NUMERIC | DECIMAL((获取指定列的指定列大小),<br/>(获取指定列小数点右边的位数。))) | | BPCHAR<br/>CHARACTER<br/>VARCHAR<br/>TEXT | STRING | | TIMESTAMP | LOCALDATETIME | | TIME | LOCALTIME | @@ -63,16 +63,16 @@ import ChangeLog from '../changelog/connector-jdbc.md'; | driver | String | 是 | - | 用于连接到远程数据源的 jdbc 类名，应为 `com.kingbase8.Driver`。 | | username | String | 否 | - | 连接实例用户名。旧配置名 `user` 仍可作为兼容写法使用。 | | password | String | 否 | - | 连接实例密码 | -| query | String | 是 | - | 查询语句 | +| query | String | 否 | - | 查询语句 | | connection_check_timeout_sec | Int | 否 | 30 | 等待用于验证连接的数据库操作完成的时间（秒） | | partition_column | String | 否 | - | 用于并行性分割的列名，仅支持数值类型列和字符串类型列。 | -| partition_lower_bound | BigDecimal | 否 | - | partition_column 的最小值用于扫描，如果未设置，SeaTunnel 将查询数据库获取最小值。 | -| partition_upper_bound | BigDecimal | 否 | - | partition_column 的最大值用于扫描，如果未设置，SeaTunnel 将查询数据库获取最大值。 | +| partition_lower_bound | String | 否 | - | partition_column 的最小值用于扫描，如果未设置，SeaTunnel 将查询数据库获取最小值。 | +| partition_upper_bound | String | 否 | - | partition_column 的最大值用于扫描，如果未设置，SeaTunnel 将查询数据库获取最大值。 | | partition_num | Int | 否 | 10 | 分割数量，仅支持正整数。默认值是 10。 | | fetch_size | Int | 否 | 0 | 对于返回大量对象的查询，您可以配置查询中使用的行提取大小，以通过减少满足选择条件所需的数据库命中次数来提高性能。零表示使用 jdbc 默认值。 | | use_regex | Boolean | 否 | false | 控制表路径的正则表达式匹配。当设置为true时，table_path 将被视为正则表达式模式。当设置为false或未指定时，table_path 将被视为精确路径（不进行正则匹配）。 | | table_path | String | 否 | - | 表的完整路径，您可以使用此配置代替 `query`。<br/>示例：<br/>"testdb.table1" | -| table_list | Array | 否 | - | 要读取的表的列表，您可以使用此配置代替 `table_path`，示例如下： ```[{ table_path = "testdb.table1"}, {table_path = "testdb.table2", query = "select * id, name from testdb.table2"}]``` | +| table_list | Array | 否 | - | 要读取的表的列表，您可以使用此配置代替 `table_path`，示例如下： ```[{ table_path = "testdb.table1"}, {table_path = "testdb.table2", query = "select id, name from testdb.table2"}]``` | | where_condition | String | 否 | - | 所有表/查询的通用行过滤条件，必须以 `where` 开头。例如 `where id > 100`。 | | split.size | Int | 否 | 8096 | 表的分割大小（行数），当读取表时，捕获的表会被分割成多个分片。 | | split.even-distribution.factor.lower-bound | Double | 否 | 0.05 | 分片键分布因子的下限。该因子用于判断表数据的分布是否均匀。如果计算得到的分布因子大于或等于该下限（即，(MAX(id) - MIN(id) + 1) / 行数），则会对表的分片进行优化，以确保数据的均匀分布。反之，如果分布因子较低，则表数据将被视为分布不均匀。如果估算的分片数量超过 `sample-sharding.threshold` 所指定的值，则会采用基于采样的分片策略。默认值为 0.05。 | diff --git a/docs/zh/connectors/source/Klaviyo.md b/docs/zh/connectors/source/Klaviyo.md index 0c15a0d265..922cf6ea9f 100644 --- a/docs/zh/connectors/source/Klaviyo.md +++ b/docs/zh/connectors/source/Klaviyo.md @@ -13,7 +13,7 @@ import ChangeLog from '../changelog/connector-http-klaviyo.md'; - [x] [批处理](../../introduction/concepts/connector-v2-features.md) - [x] [流处理](../../introduction/concepts/connector-v2-features.md) - [ ] [精确一次](../../introduction/concepts/connector-v2-features.md) -- [x] [列投影](../../introduction/concepts/connector-v2-features.md) +- [ ] [列投影](../../introduction/concepts/connector-v2-features.md) - [ ] [并行度](../../introduction/concepts/connector-v2-features.md) - [ ] [支持用户定义分片](../../introduction/concepts/connector-v2-features.md) diff --git a/docs/zh/connectors/source/Lemlist.md b/docs/zh/connectors/source/Lemlist.md index 5c0f031fe0..dd48915e5c 100644 --- a/docs/zh/connectors/source/Lemlist.md +++ b/docs/zh/connectors/source/Lemlist.md @@ -13,7 +13,7 @@ import ChangeLog from '../changelog/connector-http-lemlist.md'; - [x] [批处理](../../introduction/concepts/connector-v2-features.md) - [x] [流处理](../../introduction/concepts/connector-v2-features.md) - [ ] [精确一次](../../introduction/concepts/connector-v2-features.md) -- [x] [列投影](../../introduction/concepts/connector-v2-features.md) +- [ ] [列投影](../../introduction/concepts/connector-v2-features.md) - [ ] [并行度](../../introduction/concepts/connector-v2-features.md) - [ ] [支持用户定义分片](../../introduction/concepts/connector-v2-features.md) @@ -30,7 +30,7 @@ import ChangeLog from '../changelog/connector-http-lemlist.md'; | url | String | 是 | - | Lemlist API 地址。 | | password | String | 是 | - | Lemlist API Key。 | | method | String | 否 | GET | HTTP 请求方法，支持 `GET` 和 `POST`。 | -| headers | Map | 否 | - | 额外的 HTTP 请求头。除非需要覆盖自动生成的认证头，否则不要在这里配置 `Authorization`。 | +| headers | Map | 否 | - | 额外的 HTTP 请求头。此处配置的 `Authorization` 会被连接器自动生成的 Basic 认证头覆盖。 | | params | Map | 否 | - | HTTP 查询参数。 | | body | String | 否 | - | HTTP 请求体，通常和 `POST` 一起使用。 | | format | String | 否 | TEXT | 返回内容格式。如果要用 `schema`、`json_field` 或 `content_field` 解析 JSON，请设置为 `json`。 | diff --git a/docs/zh/connectors/source/Prometheus.md b/docs/zh/connectors/source/Prometheus.md index 8d8511f728..d119562ca8 100644 --- a/docs/zh/connectors/source/Prometheus.md +++ b/docs/zh/connectors/source/Prometheus.md @@ -20,7 +20,7 @@ Prometheus 数据源连接器通过 Prometheus 兼容 HTTP API 读取指标查 ## 主要特性 - [x] [批处理](../../introduction/concepts/connector-v2-features.md) -- [ ] [流处理](../../introduction/concepts/connector-v2-features.md) +- [x] [流处理](../../introduction/concepts/connector-v2-features.md) - [ ] [并行处理](../../introduction/concepts/connector-v2-features.md) ## 支持的数据源信息 diff --git a/docs/zh/connectors/source/Zendesk.md b/docs/zh/connectors/source/Zendesk.md index c553804016..6a63a6acbb 100644 --- a/docs/zh/connectors/source/Zendesk.md +++ b/docs/zh/connectors/source/Zendesk.md @@ -16,15 +16,14 @@ import ChangeLog from '../changelog/connector-http-zendesk.md'; 账号邮箱和 API token 进行认证（以 HTTP Basic `Authorization` 请求头发送），并将某个 Zendesk 接口 （如 tickets、users、organizations）读取为 SeaTunnel 的行数据。 -该连接器基于 [Http source](Http.md) 实现，继承了大部分选项。区别主要在于认证选项以及 `format` -的默认值。 +该连接器基于 [Http source](Http.md) 实现，继承了大部分选项。区别主要在于认证选项（`email` 和 `api_token`）。 ## 主要特性 - [x] [批处理](../../introduction/concepts/connector-v2-features.md) - [ ] [流处理](../../introduction/concepts/connector-v2-features.md) - [ ] [精确一次](../../introduction/concepts/connector-v2-features.md) -- [x] [列投影](../../introduction/concepts/connector-v2-features.md) +- [ ] [列投影](../../introduction/concepts/connector-v2-features.md) - [ ] [并行度](../../introduction/concepts/connector-v2-features.md) - [ ] [支持用户自定义分片](../../introduction/concepts/connector-v2-features.md) diff --git a/docs/zh/transforms/copy.md b/docs/zh/transforms/copy.md index 8b59a6be8b..0a9afd8d0b 100644 --- a/docs/zh/transforms/copy.md +++ b/docs/zh/transforms/copy.md @@ -10,7 +10,7 @@ | 名称 | 类型 | 是否必须 | 默认值 | |--------|--------|------|-----| -| fields | Object | yes | | +| fields | Object | yes（或使用已弃用的 `src_field`+`dest_field` 组合） | | | src_field | String | no | | | dest_field | String | no | |
