This is an automated email from the ASF dual-hosted git repository.
fanjia 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 96b610eb7e [Fix][Connector-V2]Fix Descriptions for CUSTOM_SQL in
Connector (#8778)
96b610eb7e is described below
commit 96b610eb7ec7ac0834e34ce3e693c04047a4bc18
Author: xiaochen <598457...@qq.com>
AuthorDate: Fri Feb 21 10:04:29 2025 +0800
[Fix][Connector-V2]Fix Descriptions for CUSTOM_SQL in Connector (#8778)
---
docs/en/connector-v2/sink/Clickhouse.md | 1 +
docs/zh/connector-v2/sink/Clickhouse.md | 1 +
.../connectors/seatunnel/clickhouse/config/ClickhouseSinkOptions.java | 2 +-
.../connectors/seatunnel/starrocks/config/StarRocksSinkOptions.java | 2 +-
4 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/docs/en/connector-v2/sink/Clickhouse.md
b/docs/en/connector-v2/sink/Clickhouse.md
index 0837f76203..e01f6b6ee9 100644
--- a/docs/en/connector-v2/sink/Clickhouse.md
+++ b/docs/en/connector-v2/sink/Clickhouse.md
@@ -61,6 +61,7 @@ They can be downloaded via install-plugin.sh or from the
Maven central repositor
| allow_experimental_lightweight_delete | Boolean | No | false | Allow
experimental lightweight delete based on `*MergeTree` table engine.
|
| schema_save_mode | Enum | no |
CREATE_SCHEMA_WHEN_NOT_EXIST | Schema save mode. Please refer to the
`schema_save_mode` section below.
|
| data_save_mode | Enum | no | APPEND_DATA
| Data save mode. Please refer to the `data_save_mode` section below.
|
+| 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. |
| save_mode_create_template | string | no | see below
| See below.
|
| common-options | | No | - | Sink
plugin common parameters, please refer to [Sink Common
Options](../sink-common-options.md) for details.
|
diff --git a/docs/zh/connector-v2/sink/Clickhouse.md
b/docs/zh/connector-v2/sink/Clickhouse.md
index 3dc04ce962..48190c8b55 100644
--- a/docs/zh/connector-v2/sink/Clickhouse.md
+++ b/docs/zh/connector-v2/sink/Clickhouse.md
@@ -60,6 +60,7 @@
| allow_experimental_lightweight_delete | Boolean | No | false |
允许基于`MergeTree`表引擎实验性轻量级删除.
|
| schema_save_mode | Enum | no |
CREATE_SCHEMA_WHEN_NOT_EXIST | schema保存模式，请参考下面的`schema_save_mode`
|
| data_save_mode | Enum | no | APPEND_DATA
| 数据保存模式，请参考下面的`data_save_mode`。
|
+| custom_sql | String | no | -
|
当data_save_mode设置为CUSTOM_PROCESSING时，必须同时设置CUSTOM_SQL参数。CUSTOM_SQL的值为可执行的SQL语句，在同步任务开启前SQL将会被执行
|
| save_mode_create_template | string | no | see below
| 见下文。
|
| common-options | | No | - |
Sink插件查用参数,详见[Sink常用选项](../sink-common-options.md).
|
diff --git
a/seatunnel-connectors-v2/connector-clickhouse/src/main/java/org/apache/seatunnel/connectors/seatunnel/clickhouse/config/ClickhouseSinkOptions.java
b/seatunnel-connectors-v2/connector-clickhouse/src/main/java/org/apache/seatunnel/connectors/seatunnel/clickhouse/config/ClickhouseSinkOptions.java
index 9ad599e4ac..288e3463a7 100644
---
a/seatunnel-connectors-v2/connector-clickhouse/src/main/java/org/apache/seatunnel/connectors/seatunnel/clickhouse/config/ClickhouseSinkOptions.java
+++
b/seatunnel-connectors-v2/connector-clickhouse/src/main/java/org/apache/seatunnel/connectors/seatunnel/clickhouse/config/ClickhouseSinkOptions.java
@@ -91,7 +91,7 @@ public class ClickhouseSinkOptions {
Options.key("custom_sql")
.stringType()
.noDefaultValue()
- .withDescription("when schema_save_mode selects
CUSTOM_PROCESSING custom SQL");
+ .withDescription("when data_save_mode selects
CUSTOM_PROCESSING custom SQL");
public static final Option<String> SAVE_MODE_CREATE_TEMPLATE =
Options.key("save_mode_create_template")
diff --git
a/seatunnel-connectors-v2/connector-starrocks/src/main/java/org/apache/seatunnel/connectors/seatunnel/starrocks/config/StarRocksSinkOptions.java
b/seatunnel-connectors-v2/connector-starrocks/src/main/java/org/apache/seatunnel/connectors/seatunnel/starrocks/config/StarRocksSinkOptions.java
index d30aa6f9ef..5c20abd444 100644
---
a/seatunnel-connectors-v2/connector-starrocks/src/main/java/org/apache/seatunnel/connectors/seatunnel/starrocks/config/StarRocksSinkOptions.java
+++
b/seatunnel-connectors-v2/connector-starrocks/src/main/java/org/apache/seatunnel/connectors/seatunnel/starrocks/config/StarRocksSinkOptions.java
@@ -154,5 +154,5 @@ public class StarRocksSinkOptions extends
StarRocksBaseOptions {
Options.key("custom_sql")
.stringType()
.noDefaultValue()
- .withDescription("when schema_save_mode selects
CUSTOM_PROCESSING custom SQL");
+ .withDescription("when data_save_mode selects
CUSTOM_PROCESSING custom SQL");
}
