Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
cc.cai committed Dec 21, 2024
1 parent a105ee4 commit 5609c21
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 20 deletions.
41 changes: 23 additions & 18 deletions docs/en/connector-v2/sink/ClickhouseFile.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,26 @@ Write data to Clickhouse can also be done using JDBC

## Options

| Name | Type | Required | Default |
|------------------------|---------|----------|----------------------------------------|
| host | string | yes | - |
| database | string | yes | - |
| table | string | yes | - |
| username | string | yes | - |
| password | string | yes | - |
| clickhouse_local_path | string | yes | - |
| sharding_key | string | no | - |
| copy_method | string | no | scp |
| node_free_password | boolean | no | false |
| node_pass | list | no | - |
| Name | Type | Required | Default |
|----------|---------|----------|----------------------------------------|
| host | string | yes | - |
| database | string | yes | - |
| table | string | yes | - |
| username | string | yes | - |
| password | string | yes | - |
| clickhouse_local_path | string | yes | - |
| sharding_key | string | no | - |
| copy_method | string | no | scp |
| node_free_password | boolean | no | false |
| node_pass | list | no | - |
| node_pass.node_address | string | no | - |
| node_pass.username | string | no | "root" |
| node_pass.password | string | no | - |
| compatible_mode | boolean | no | false |
| file_fields_delimiter | string | no | "\t" |
| file_temp_path | string | no | "/tmp/seatunnel/clickhouse-local/file" |
| common-options | | no | - |
| node_pass.username | string | no | "root" |
| node_pass.password | string | no | - |
| compatible_mode | boolean | no | false |
| file_fields_delimiter | string | no | "\t" |
| file_temp_path | string | no | "/tmp/seatunnel/clickhouse-local/file" |
| key_path | string | no | "/tmp/id_rsa" |
| common-options | | no | - |

### host [string]

Expand Down Expand Up @@ -111,6 +112,10 @@ Avoid this with this configuration. Value string has to be an exactly one charac

The directory where ClickhouseFile stores temporary files locally.

### rsync_key_path [string]

The path of the private key file used by rsync or scp to connect to the ClickHouse server

### common options

Sink plugin common parameters, please refer to [Sink Common Options](../sink-common-options.md) for details
Expand Down
7 changes: 6 additions & 1 deletion docs/zh/connector-v2/sink/ClickhouseFile.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

## 接收器选项

| 名称 | 类型 | 是否必须 | 默认值 |
| 名称 | 类型 | 是否必须 | 默认值 |
|------------------------|---------|------|----------------------------------------|
| host | string | yes | - |
| database | string | yes | - |
Expand All @@ -36,6 +36,7 @@
| compatible_mode | boolean | no | false |
| file_fields_delimiter | string | no | "\t" |
| file_temp_path | string | no | "/tmp/seatunnel/clickhouse-local/file" |
| key_path | string | no | "/tmp/id_rsa" |
| common-options | | no | - |

### host [string]
Expand Down Expand Up @@ -102,6 +103,10 @@ ClickHouseFile使用CSV格式来临时保存数据。但如果数据中包含CSV

ClickhouseFile本地存储临时文件的目录。

### key_path [string]

用于scp或rsync传输文件的私钥路径。

### common options

Sink插件常用参数，请参考[Sink常用选项](../sink-common-options.md)获取更多细节信息。
Expand Down
2 changes: 1 addition & 1 deletion ...in/java/org/apache/seatunnel/connectors/seatunnel/clickhouse/config/ClickhouseConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ public class ClickhouseConfig {
.withDescription("Clickhouse custom config");

public static final Option<String> KEY_PATH =
Options.key("rsync_key_path")
Options.key("key_path")
.stringType()
.noDefaultValue()
.withDescription("The path of rsync/ssh key file");
Expand Down

0 comments on commit 5609c21

Please sign in to comment.