This is an automated email from the ASF dual-hosted git repository. wuchunfu 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 ad0a04de81 [Fix][doc] fix dead link (#7508)
ad0a04de81 is described below
commit ad0a04de814a8b6790d44f5cb21a7618c6252866
Author: corgy-w <[email protected]>
AuthorDate: Wed Aug 28 09:27:26 2024 +0800
[Fix][doc] fix dead link (#7508)
---
docs/en/connector-v2/source/Opengauss-CDC.md | 48 ++++++++++++++--------------
docs/zh/connector-v2/source/Opengauss-CDC.md | 4 +--
2 files changed, 26 insertions(+), 26 deletions(-)
diff --git a/docs/en/connector-v2/source/Opengauss-CDC.md
b/docs/en/connector-v2/source/Opengauss-CDC.md
index 00886050a6..81691ea1ff 100644
--- a/docs/en/connector-v2/source/Opengauss-CDC.md
+++ b/docs/en/connector-v2/source/Opengauss-CDC.md
@@ -64,31 +64,31 @@ select 'ALTER TABLE ' || schemaname || '.' || tablename ||
' REPLICA IDENTITY FU
## Source Options
-| Name | Type | Required |
Default |
Description
[...]
-|------------------------------------------------|----------|----------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| base-url | String | Yes | -
| The URL of the JDBC connection. Refer to a case:
`jdbc:postgresql://localhost:5432/postgres_cdc?loggerLevel=OFF`.
[...]
-| username | String | Yes | -
| Username of the database to use when connecting to the database server.
[...]
-| password | String | Yes | -
| Password to use when connecting to the database server.
[...]
-| database-names | List | No | -
| Database name of the database to monitor.
[...]
-| table-names | List | Yes | -
| Table name of the database to monitor. The table name needs to include the
database name, for example: `database_name.table_name`
[...]
-| table-names-config | List | No | -
| Table config list. for example: [{"table":
"db1.schema1.table1","primaryKeys":["key1"]}]
[...]
-| startup.mode | Enum | No |
INITIAL | Optional startup mode for Opengauss CDC consumer, valid enumerations
are `initial`, `earliest`, `latest` and `specific`. <br/> `initial`:
Synchronize historical data at startup, and then synchronize incremental
data.<br/> `earliest`: Startup from the earliest offset possible.<br/>
`latest`: Startup from the latest offset.<br/> `specific`: Startup from
user-supplied specific offsets. [...]
-| 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 snapshot of table.
[...]
-| snapshot.fetch.size | Integer | No | 1024
| The maximum fetch size for per poll when read table snapshot.
[...]
-| slot.name | String | No | -
| The name of the Opengauss logical decoding slot that was created for
streaming changes from a particular plug-in for a particular database/schema.
The server uses this slot to stream events to the connector that you are
configuring. Default is seatunnel.
[...]
-| decoding.plugin.name | String | No |
pgoutput | The name of the Postgres logical decoding plug-in installed on the
server,Supported values are decoderbufs, wal2json, wal2json_rds,
wal2json_streaming,wal2json_rds_streaming and pgoutput.
[...]
-| server-time-zone | String | No | UTC
| The session time zone in database server. If not set, then
ZoneId.systemDefault() is used to determine the server time zone.
[...]
-| connect.timeout.ms | Duration | No | 30000
| The maximum time 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 jdbc connection pool size.
[...]
+| Name | Type | Required |
Default | Description
[...]
+|------------------------------------------------|----------|----------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
+| base-url | String | Yes | -
| The URL of the JDBC connection. Refer to a case:
`jdbc:postgresql://localhost:5432/postgres_cdc?loggerLevel=OFF`.
[...]
+| username | String | Yes | -
| Username of the database to use when connecting to the database server.
[...]
+| password | String | Yes | -
| Password to use when connecting to the database server.
[...]
+| database-names | List | No | -
| Database name of the database to monitor.
[...]
+| table-names | List | Yes | -
| Table name of the database to monitor. The table name needs to include the
database name, for example: `database_name.table_name`
[...]
+| table-names-config | List | No | -
| Table config list. for example: [{"table":
"db1.schema1.table1","primaryKeys":["key1"]}]
[...]
+| startup.mode | Enum | No |
INITIAL | Optional startup mode for Opengauss CDC consumer, valid enumerations
are `initial`, `earliest`, `latest` and `specific`. <br/> `initial`:
Synchronize historical data at startup, and then synchronize incremental
data.<br/> `earliest`: Startup from the earliest offset possible.<br/>
`latest`: Startup from the latest offset.<br/> `specific`: Startup from
user-supplied specific offsets. [...]
+| 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 snapshot of table.
[...]
+| snapshot.fetch.size | Integer | No | 1024
| The maximum fetch size for per poll when read table snapshot.
[...]
+| slot.name | String | No | -
| The name of the Opengauss logical decoding slot that was created for
streaming changes from a particular plug-in for a particular database/schema.
The server uses this slot to stream events to the connector that you are
configuring. Default is seatunnel.
[...]
+| decoding.plugin.name | String | No |
pgoutput | The name of the Postgres logical decoding plug-in installed on the
server,Supported values are decoderbufs, wal2json, wal2json_rds,
wal2json_streaming,wal2json_rds_streaming and pgoutput.
[...]
+| server-time-zone | String | No | UTC
| The session time zone in database server. If not set, then
ZoneId.systemDefault() is used to determine the server time zone.
[...]
+| connect.timeout.ms | Duration | No | 30000
| The maximum time 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 jdbc 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 une [...]
-| chunk-key.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 as une [...]
-| sample-sharding.threshold | Integer | No | 1000
| This configuration specifies the threshold of estimated shard count to
trigger the sample sharding strategy. When the distribution factor is outside
the bounds specified by `chunk-key.even-distribution.factor.upper-bound` and
`chunk-key.even-distribution.factor.lower-bound`, and the estimated shard count
(calculated as approximate row count / chunk size) exceeds this threshold, the
sample sharding strateg [...]
-| inverse-sampling.rate | Integer | No | 1000
| The inverse of the sampling rate used in the sample sharding strategy. For
example, if this value is set to 1000, it means a 1/1000 sampling rate is
applied during the sampling process. This option provides flexibility in
controlling the granularity of the sampling, thus affecting the final number of
shards. It's especially useful when dealing with very large datasets where a
lower sampling rate is prefer [...]
-| exactly_once | Boolean | No | false
| Enable exactly once semantic.
[...]
-| format | Enum | No |
DEFAULT | Optional output format for Opengauss CDC, valid enumerations are
`DEFAULT`, `COMPATIBLE_DEBEZIUM_JSON`.
[...]
-| debezium | Config | No | -
| Pass-through [Debezium's
properties](https://github.com/debezium/debezium/blob/v1.9.8.Final/documentation/modules/ROOT/pages/connectors/postgresql.adoc#connector-configuration-properties)
to Debezium Embedded Engine which is used to capture data changes from
Opengauss server.
[...]
-| common-options | | no | -
| Source plugin common parameters, please refer to [Source Common
Options](common-options.md) for details
[...]
+| chunk-key.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 as une [...]
+| sample-sharding.threshold | Integer | No | 1000
| This configuration specifies the threshold of estimated shard count to
trigger the sample sharding strategy. When the distribution factor is outside
the bounds specified by `chunk-key.even-distribution.factor.upper-bound` and
`chunk-key.even-distribution.factor.lower-bound`, and the estimated shard count
(calculated as approximate row count / chunk size) exceeds this threshold, the
sample sharding strateg [...]
+| inverse-sampling.rate | Integer | No | 1000
| The inverse of the sampling rate used in the sample sharding strategy. For
example, if this value is set to 1000, it means a 1/1000 sampling rate is
applied during the sampling process. This option provides flexibility in
controlling the granularity of the sampling, thus affecting the final number of
shards. It's especially useful when dealing with very large datasets where a
lower sampling rate is prefer [...]
+| exactly_once | Boolean | No | false
| Enable exactly once semantic.
[...]
+| format | Enum | No |
DEFAULT | Optional output format for Opengauss CDC, valid enumerations are
`DEFAULT`, `COMPATIBLE_DEBEZIUM_JSON`.
[...]
+| debezium | Config | No | -
| Pass-through [Debezium's
properties](https://github.com/debezium/debezium/blob/v1.9.8.Final/documentation/modules/ROOT/pages/connectors/postgresql.adoc#connector-configuration-properties)
to Debezium Embedded Engine which is used to capture data changes from
Opengauss server.
[...]
+| common-options | | no | -
| Source plugin common parameters, please refer to [Source Common
Options](../source-common-options.md) for details
[...]
## Task Example
diff --git a/docs/zh/connector-v2/source/Opengauss-CDC.md
b/docs/zh/connector-v2/source/Opengauss-CDC.md
index 092249bb63..83da40b363 100644
--- a/docs/zh/connector-v2/source/Opengauss-CDC.md
+++ b/docs/zh/connector-v2/source/Opengauss-CDC.md
@@ -63,7 +63,7 @@ select 'ALTER TABLE ' || schemaname || '.' || tablename || '
REPLICA IDENTITY FU
## 源端可选项
-| Name | Type | Required | Default
|
Description
|
+| Name | Type | Required | Default
| Description
|
|------------------------------------------------|------|----------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| base-url | 字符串 | 是 | -
| JDBC连接的URL. 参考:
`jdbc:postgresql://localhost:5432/postgres_cdc?loggerLevel=OFF`.
|
| username | 字符串 | 是 | -
| 连接数据库的用户名
|
@@ -87,7 +87,7 @@ select 'ALTER TABLE ' || schemaname || '.' || tablename || '
REPLICA IDENTITY FU
| exactly_once | 布尔 | 否 | false
| 启用exactly once语义
|
| format | 枚举 | 否 | DEFAULT
| Opengauss CDC可选的输出格式, 有效的枚举是`DEFAULT`, `COMPATIBLE_DEBEZIUM_JSON`.
|
| debezium | 配置 | 否 | -
| 将
[Debezium的属性](https://github.com/debezium/debezium/blob/v1.9.8.Final/documentation/modules/ROOT/pages/connectors/postgresql.adoc#connector-configuration-properties)
传递到Debezium嵌入式引擎,该引擎用于捕获来自Opengauss服务的数据更改 |
-| common-options | | 否 | -
| 源码插件通用参数, 请参考[Source Common Options](common-options.md)获取详情
|
+| common-options | | 否 | -
| 源码插件通用参数, 请参考[Source Common Options](../source-common-options.md)获取详情
|
## 任务示例
