This is an automated email from the ASF dual-hosted git repository.
wanghailin 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 8a187b2d09 [Improve][Doc] Add enable_header_write parameter in File
doc (#8397)
8a187b2d09 is described below
commit 8a187b2d09cf5e5631cd1b3e6f661c38c233a8e7
Author: welsh-wen <[email protected]>
AuthorDate: Mon Dec 30 18:40:58 2024 +0800
[Improve][Doc] Add enable_header_write parameter in File doc (#8397)
---
docs/en/connector-v2/sink/FtpFile.md | 5 +++++
docs/en/connector-v2/sink/HdfsFile.md | 4 ++++
docs/en/connector-v2/sink/OssFile.md | 4 ++++
docs/en/connector-v2/sink/S3File.md | 4 ++++
docs/en/connector-v2/sink/SftpFile.md | 5 +++++
docs/zh/connector-v2/sink/HdfsFile.md | 4 ++++
6 files changed, 26 insertions(+)
diff --git a/docs/en/connector-v2/sink/FtpFile.md
b/docs/en/connector-v2/sink/FtpFile.md
index 5b927bda12..caa15d1a6b 100644
--- a/docs/en/connector-v2/sink/FtpFile.md
+++ b/docs/en/connector-v2/sink/FtpFile.md
@@ -63,6 +63,7 @@ By default, we use 2PC commit to ensure `exactly-once`
| xml_use_attr_format | boolean | no | -
| Only used when file_format is xml.
|
| parquet_avro_write_timestamp_as_int96 | boolean | no | false
| Only used when file_format is parquet.
|
| parquet_avro_write_fixed_as_int96 | array | no | -
| Only used when file_format is parquet.
|
+| enable_header_write | boolean | no | false
| Only used when file_format_type is text,csv.<br/>
false:don't write header,true:write header. |
| encoding | string | no | "UTF-8"
| Only used when file_format_type is
json,text,csv,xml. |
| schema_save_mode | string | no |
CREATE_SCHEMA_WHEN_NOT_EXIST | Existing dir processing method
|
| data_save_mode | string | no | APPEND_DATA
| Existing data processing method
|
@@ -224,6 +225,10 @@ Support writing Parquet INT96 from a timestamp, only valid
for parquet files.
Support writing Parquet INT96 from a 12-byte field, only valid for parquet
files.
+### enable_header_write [boolean]
+
+Only used when file_format_type is text,csv.false:don't write
header,true:write header.
+
### encoding [string]
Only used when file_format_type is json,text,csv,xml.
diff --git a/docs/en/connector-v2/sink/HdfsFile.md
b/docs/en/connector-v2/sink/HdfsFile.md
index 3060e8ac8b..2842047af1 100644
--- a/docs/en/connector-v2/sink/HdfsFile.md
+++ b/docs/en/connector-v2/sink/HdfsFile.md
@@ -70,6 +70,7 @@ Output data to hdfs file
| xml_use_attr_format | boolean | no | -
| Only used when file_format is xml, specifies
Whether to process data using the tag attribute format.
[...]
| parquet_avro_write_timestamp_as_int96 | boolean | no | false
| Only used when file_format is parquet.
[...]
| parquet_avro_write_fixed_as_int96 | array | no | -
| Only used when file_format is parquet.
[...]
+| enable_header_write | boolean | no | false
| Only used when file_format_type is text,csv.<br/>
false:don't write header,true:write header. |
| encoding | string | no | "UTF-8"
| Only used when file_format_type is
json,text,csv,xml.
[...]
### Tips
@@ -195,6 +196,9 @@ HdfsFile {
kerberos_keytab_path = "/path/to/your/keytab/file.keytab"
}
```
+### enable_header_write [boolean]
+
+Only used when file_format_type is text,csv.false:don't write
header,true:write header.
### For compress simple config
diff --git a/docs/en/connector-v2/sink/OssFile.md
b/docs/en/connector-v2/sink/OssFile.md
index 9cab2b8e56..cc3cf51299 100644
--- a/docs/en/connector-v2/sink/OssFile.md
+++ b/docs/en/connector-v2/sink/OssFile.md
@@ -116,6 +116,7 @@ If write to `csv`, `text` file type, All column will be
string.
| xml_use_attr_format | boolean | no | -
| Only used when file_format is xml.
|
| parquet_avro_write_timestamp_as_int96 | boolean | no | false
| Only used when file_format is parquet.
|
| parquet_avro_write_fixed_as_int96 | array | no | -
| Only used when file_format is parquet.
|
+| enable_header_write | boolean | no | false
| Only used when file_format_type is text,csv.<br/>
false:don't write header,true:write header. |
| encoding | string | no | "UTF-8"
| Only used when file_format_type is
json,text,csv,xml. |
### path [string]
@@ -395,6 +396,9 @@ sink {
}
}
```
+### enable_header_write [boolean]
+
+Only used when file_format_type is text,csv.false:don't write
header,true:write header.
### Multiple Table
diff --git a/docs/en/connector-v2/sink/S3File.md
b/docs/en/connector-v2/sink/S3File.md
index 4251fe7f53..8ed708b1f9 100644
--- a/docs/en/connector-v2/sink/S3File.md
+++ b/docs/en/connector-v2/sink/S3File.md
@@ -127,6 +127,7 @@ If write to `csv`, `text` file type, All column will be
string.
| hadoop_s3_properties | map | no |
| If you need to add a other option, you
could add it here and refer to this
[link](https://hadoop.apache.org/docs/stable/hadoop-aws/tools/hadoop-aws/index.html)
|
| schema_save_mode | Enum | no |
CREATE_SCHEMA_WHEN_NOT_EXIST | Before turning on the
synchronous task, do different treatment of the target path
|
| data_save_mode | Enum | no | APPEND_DATA
| Before opening the synchronous task,
the data file in the target path is differently processed
|
+| enable_header_write | boolean | no | false
| Only used when file_format_type is text,csv.<br/>
false:don't write header,true:write header. |
| encoding | string | no | "UTF-8"
| Only used when file_format_type is
json,text,csv,xml.
|
### path [string]
@@ -488,6 +489,9 @@ sink {
}
}
```
+### enable_header_write [boolean]
+
+Only used when file_format_type is text,csv.false:don't write
header,true:write header.
## Changelog
diff --git a/docs/en/connector-v2/sink/SftpFile.md
b/docs/en/connector-v2/sink/SftpFile.md
index 4509baa7cf..7d40f5fb4b 100644
--- a/docs/en/connector-v2/sink/SftpFile.md
+++ b/docs/en/connector-v2/sink/SftpFile.md
@@ -61,6 +61,7 @@ By default, we use 2PC commit to ensure `exactly-once`
| xml_row_tag | string | no | RECORD
| Only used when file_format is xml.
|
| xml_use_attr_format | boolean | no | -
| Only used when file_format is xml.
|
| parquet_avro_write_timestamp_as_int96 | boolean | no | false
| Only used when file_format is parquet.
|
+| enable_header_write | boolean | no | false
| Only used when file_format_type is text,csv.<br/>
false:don't write header,true:write header. |
| parquet_avro_write_fixed_as_int96 | array | no | -
| Only used when file_format is parquet.
|
| encoding | string | no | "UTF-8"
| Only used when file_format_type is
json,text,csv,xml. |
| schema_save_mode | string | no |
CREATE_SCHEMA_WHEN_NOT_EXIST | Existing dir processing method
|
@@ -217,6 +218,10 @@ Support writing Parquet INT96 from a timestamp, only valid
for parquet files.
Support writing Parquet INT96 from a 12-byte field, only valid for parquet
files.
+### enable_header_write [boolean]
+
+Only used when file_format_type is text,csv.false:don't write
header,true:write header.
+
### encoding [string]
Only used when file_format_type is json,text,csv,xml.
diff --git a/docs/zh/connector-v2/sink/HdfsFile.md
b/docs/zh/connector-v2/sink/HdfsFile.md
index 81081bad94..a30405898a 100644
--- a/docs/zh/connector-v2/sink/HdfsFile.md
+++ b/docs/zh/connector-v2/sink/HdfsFile.md
@@ -61,6 +61,7 @@
| kerberos_keytab_path | string | 否 | -
| kerberos 的 keytab 路径
|
| compress_codec | string | 否 | none
| 压缩编解码器
|
| common-options | object | 否 | -
| 接收器插件通用参数，请参阅 [接收器通用选项](../sink-common-options.md) 了解详情
|
+| enable_header_write | boolean | 否 | false
| 仅在 file_format_type 为 text,csv 时使用。<br/>
false:不写入表头,true:写入表头。 |
| max_rows_in_memory | int | 否 | -
| 仅当 file_format 为 excel 时使用。当文件格式为 Excel 时，可以缓存在内存中的最大数据项数。
|
| sheet_name | string | 否 | Sheet${Random number}
| 仅当 file_format 为 excel 时使用。将工作簿的表写入指定的表名
|
@@ -177,6 +178,9 @@ HdfsFile {
is_enable_transaction = true
}
```
+### enable_header_write [boolean]
+
+仅在 file_format_type 为 text,csv 时使用。false:不写入表头,true:写入表头。
### kerberos 的简单配置
