Skip to content

Commit 8a187b2

Browse files
welsh-wenwelsh-wen
authored
[Improve][Doc] Add enable_header_write parameter in File doc (#8397)
1 parent 5032c20 commit 8a187b2

File tree

6 files changed

+26
-0
lines changed

6 files changed

+26
-0
lines changed

Diff for: ‎docs/en/connector-v2/sink/FtpFile.md

+5
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ By default, we use 2PC commit to ensure `exactly-once`
6363
| xml_use_attr_format | boolean | no | - | Only used when file_format is xml. |
6464
| parquet_avro_write_timestamp_as_int96 | boolean | no | false | Only used when file_format is parquet. |
6565
| parquet_avro_write_fixed_as_int96 | array | no | - | Only used when file_format is parquet. |
66+
| enable_header_write | boolean | no | false | Only used when file_format_type is text,csv.<br/> false:don't write header,true:write header. |
6667
| encoding | string | no | "UTF-8" | Only used when file_format_type is json,text,csv,xml. |
6768
| schema_save_mode | string | no | CREATE_SCHEMA_WHEN_NOT_EXIST | Existing dir processing method |
6869
| 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.
224225

225226
Support writing Parquet INT96 from a 12-byte field, only valid for parquet files.
226227

228+
### enable_header_write [boolean]
229+
230+
Only used when file_format_type is text,csv.false:don't write header,true:write header.
231+
227232
### encoding [string]
228233

229234
Only used when file_format_type is json,text,csv,xml.

Diff for: ‎docs/en/connector-v2/sink/HdfsFile.md

+4
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Output data to hdfs file
7070
| xml_use_attr_format | boolean | no | - | Only used when file_format is xml, specifies Whether to process data using the tag attribute format. |
7171
| parquet_avro_write_timestamp_as_int96 | boolean | no | false | Only used when file_format is parquet. |
7272
| parquet_avro_write_fixed_as_int96 | array | no | - | Only used when file_format is parquet. |
73+
| enable_header_write | boolean | no | false | Only used when file_format_type is text,csv.<br/> false:don't write header,true:write header. |
7374
| encoding | string | no | "UTF-8" | Only used when file_format_type is json,text,csv,xml. |
7475

7576
### Tips
@@ -195,6 +196,9 @@ HdfsFile {
195196
kerberos_keytab_path = "/path/to/your/keytab/file.keytab"
196197
}
197198
```
199+
### enable_header_write [boolean]
200+
201+
Only used when file_format_type is text,csv.false:don't write header,true:write header.
198202

199203
### For compress simple config
200204

Diff for: ‎docs/en/connector-v2/sink/OssFile.md

+4
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ If write to `csv`, `text` file type, All column will be string.
116116
| xml_use_attr_format | boolean | no | - | Only used when file_format is xml. |
117117
| parquet_avro_write_timestamp_as_int96 | boolean | no | false | Only used when file_format is parquet. |
118118
| parquet_avro_write_fixed_as_int96 | array | no | - | Only used when file_format is parquet. |
119+
| enable_header_write | boolean | no | false | Only used when file_format_type is text,csv.<br/> false:don't write header,true:write header. |
119120
| encoding | string | no | "UTF-8" | Only used when file_format_type is json,text,csv,xml. |
120121

121122
### path [string]
@@ -395,6 +396,9 @@ sink {
395396
}
396397
}
397398
```
399+
### enable_header_write [boolean]
400+
401+
Only used when file_format_type is text,csv.false:don't write header,true:write header.
398402

399403
### Multiple Table
400404

Diff for: ‎docs/en/connector-v2/sink/S3File.md

+4
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ If write to `csv`, `text` file type, All column will be string.
127127
| 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) |
128128
| schema_save_mode | Enum | no | CREATE_SCHEMA_WHEN_NOT_EXIST | Before turning on the synchronous task, do different treatment of the target path |
129129
| data_save_mode | Enum | no | APPEND_DATA | Before opening the synchronous task, the data file in the target path is differently processed |
130+
| enable_header_write | boolean | no | false | Only used when file_format_type is text,csv.<br/> false:don't write header,true:write header. |
130131
| encoding | string | no | "UTF-8" | Only used when file_format_type is json,text,csv,xml. |
131132

132133
### path [string]
@@ -488,6 +489,9 @@ sink {
488489
}
489490
}
490491
```
492+
### enable_header_write [boolean]
493+
494+
Only used when file_format_type is text,csv.false:don't write header,true:write header.
491495

492496
## Changelog
493497

Diff for: ‎docs/en/connector-v2/sink/SftpFile.md

+5
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ By default, we use 2PC commit to ensure `exactly-once`
6161
| xml_row_tag | string | no | RECORD | Only used when file_format is xml. |
6262
| xml_use_attr_format | boolean | no | - | Only used when file_format is xml. |
6363
| parquet_avro_write_timestamp_as_int96 | boolean | no | false | Only used when file_format is parquet. |
64+
| enable_header_write | boolean | no | false | Only used when file_format_type is text,csv.<br/> false:don't write header,true:write header. |
6465
| parquet_avro_write_fixed_as_int96 | array | no | - | Only used when file_format is parquet. |
6566
| encoding | string | no | "UTF-8" | Only used when file_format_type is json,text,csv,xml. |
6667
| 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.
217218

218219
Support writing Parquet INT96 from a 12-byte field, only valid for parquet files.
219220

221+
### enable_header_write [boolean]
222+
223+
Only used when file_format_type is text,csv.false:don't write header,true:write header.
224+
220225
### encoding [string]
221226

222227
Only used when file_format_type is json,text,csv,xml.

Diff for: ‎docs/zh/connector-v2/sink/HdfsFile.md

+4
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@
6161
| kerberos_keytab_path | string | 否 | - | kerberos 的 keytab 路径 |
6262
| compress_codec | string | 否 | none | 压缩编解码器 |
6363
| common-options | object | 否 | - | 接收器插件通用参数，请参阅 [接收器通用选项](../sink-common-options.md) 了解详情 |
64+
| enable_header_write | boolean | 否 | false | 仅在 file_format_type 为 text,csv 时使用。<br/> false:不写入表头,true:写入表头。 |
6465
| max_rows_in_memory | int | 否 | - | 仅当 file_format 为 excel 时使用。当文件格式为 Excel 时，可以缓存在内存中的最大数据项数。 |
6566
| sheet_name | string | 否 | Sheet${Random number} | 仅当 file_format 为 excel 时使用。将工作簿的表写入指定的表名 |
6667

@@ -177,6 +178,9 @@ HdfsFile {
177178
is_enable_transaction = true
178179
}
179180
```
181+
### enable_header_write [boolean]
182+
183+
仅在 file_format_type 为 text,csv 时使用。false:不写入表头,true:写入表头。
180184

181185
### kerberos 的简单配置
182186

0 commit comments

Comments
 (0)