Skip to content

Commit 96b610e

Browse files
[Fix][Connector-V2]Fix Descriptions for CUSTOM_SQL in Connector (#8778)
1 parent 7763326 commit 96b610e

File tree

4 files changed

+4
-2
lines changed

4 files changed

+4
-2
lines changed

docs/en/connector-v2/sink/Clickhouse.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ They can be downloaded via install-plugin.sh or from the Maven central repositor
6161
| allow_experimental_lightweight_delete | Boolean | No | false | Allow experimental lightweight delete based on `*MergeTree` table engine. |
6262
| schema_save_mode | Enum | no | CREATE_SCHEMA_WHEN_NOT_EXIST | Schema save mode. Please refer to the `schema_save_mode` section below. |
6363
| data_save_mode | Enum | no | APPEND_DATA | Data save mode. Please refer to the `data_save_mode` section below. |
64+
| 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. |
6465
| save_mode_create_template | string | no | see below | See below. |
6566
| common-options | | No | - | Sink plugin common parameters, please refer to [Sink Common Options](../sink-common-options.md) for details. |
6667

docs/zh/connector-v2/sink/Clickhouse.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
| allow_experimental_lightweight_delete | Boolean | No | false | 允许基于`MergeTree`表引擎实验性轻量级删除. |
6161
| schema_save_mode | Enum | no | CREATE_SCHEMA_WHEN_NOT_EXIST | schema保存模式,请参考下面的`schema_save_mode` |
6262
| data_save_mode | Enum | no | APPEND_DATA | 数据保存模式,请参考下面的`data_save_mode`|
63+
| custom_sql | String | no | - | 当data_save_mode设置为CUSTOM_PROCESSING时,必须同时设置CUSTOM_SQL参数。CUSTOM_SQL的值为可执行的SQL语句,在同步任务开启前SQL将会被执行 |
6364
| save_mode_create_template | string | no | see below | 见下文。 |
6465
| common-options | | No | - | Sink插件查用参数,详见[Sink常用选项](../sink-common-options.md). |
6566

seatunnel-connectors-v2/connector-clickhouse/src/main/java/org/apache/seatunnel/connectors/seatunnel/clickhouse/config/ClickhouseSinkOptions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ public class ClickhouseSinkOptions {
9191
Options.key("custom_sql")
9292
.stringType()
9393
.noDefaultValue()
94-
.withDescription("when schema_save_mode selects CUSTOM_PROCESSING custom SQL");
94+
.withDescription("when data_save_mode selects CUSTOM_PROCESSING custom SQL");
9595

9696
public static final Option<String> SAVE_MODE_CREATE_TEMPLATE =
9797
Options.key("save_mode_create_template")

seatunnel-connectors-v2/connector-starrocks/src/main/java/org/apache/seatunnel/connectors/seatunnel/starrocks/config/StarRocksSinkOptions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,5 +154,5 @@ public class StarRocksSinkOptions extends StarRocksBaseOptions {
154154
Options.key("custom_sql")
155155
.stringType()
156156
.noDefaultValue()
157-
.withDescription("when schema_save_mode selects CUSTOM_PROCESSING custom SQL");
157+
.withDescription("when data_save_mode selects CUSTOM_PROCESSING custom SQL");
158158
}

0 commit comments

Comments
 (0)