Skip to content

Commit 0d17cb4

Browse files
author
zengyi
committed
[Improve][Doc][connector-file] fix details
1 parent 7dc6c39 commit 0d17cb4

File tree

2 files changed

+31
-31
lines changed

2 files changed

+31
-31
lines changed

‎docs/zh/connector-v2/sink/HdfsFile.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ import ChangeLog from '../changelog/connector-file-hadoop.md';
4848

4949
| 名称 | 类型 | 是否必须 | 默认值 | 描述 |
5050
|----------------------------------|---------|------|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
51-
| fs.defaultFS | string | 是 | - | Hadoop 集群地址。支持以下格式：<br/>- 标准 HDFS：`hdfs://hadoopcluster` 或 `hdfs://namenode:9000`<br/>- ViewFS（联邦 HDFS）：`viewfs://mycluster`<br/>详见下方 ViewFS 配置示例。 |
51+
| fs.defaultFS | string | 是 | - | Hadoop 集群地址。支持以下格式：<br/>- 标准 HDFS：`hdfs://hadoopcluster` 或 `hdfs://namenode:9000`<br/>- ViewFS（联邦 HDFS）：`viewfs://mycluster`<br/>详见下方 ViewFS 配置示例。 |
5252
| path | string | 是 | - | 目标目录路径是必需的。 |
5353
| tmp_path | string | 是 | /tmp/seatunnel | 结果文件将首先写入临时路径，然后使用 `mv` 命令将临时目录提交到目标目录。需要一个Hdfs路径。 |
5454
| hdfs_site_path | string | 否 | - | `hdfs-site.xml` 的路径，用于加载 namenodes 的 ha 配置。 |
@@ -289,4 +289,4 @@ HdfsFile {
289289

290290
## 变更日志
291291

292-
<ChangeLog />
292+
<ChangeLog />

‎docs/zh/connector-v2/sink/LocalFile.md‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -41,36 +41,36 @@ import ChangeLog from '../changelog/connector-file-local.md';
4141

4242
## 选项
4343

44-
| 名称 | 类型 | 是否必需 | 默认值 | 描述 |
45-
|---------------------------------------|---------|------|--------------------------------------------|----------------------------------------------------------------|
46-
| path | string | 是 | - | 目标目录路径 |
47-
| tmp_path | string | 否 | /tmp/seatunnel | 结果文件将首先写入临时路径，然后使用 `mv` 将临时目录提交到目标目录。 |
48-
| custom_filename | boolean | 否 | false | 是否需要自定义文件名 |
49-
| file_name_expression | string | 否 | "${transactionId}" | 仅在 custom_filename 为 true 时使用 |
50-
| filename_time_format | string | 否 | "yyyy.MM.dd" | 仅在 custom_filename 为 true 时使用 |
51-
| file_format_type | string | 否 | "csv" | 文件格式类型 |
44+
| 名称 | 类型 | 是否必需 | 默认值 | 描述 |
45+
|---------------------------------------|---------|------|--------------------------------------------|-----------------------------------------------------------------|
46+
| path | string | 是 | - | 目标目录路径 |
47+
| tmp_path | string | 否 | /tmp/seatunnel | 结果文件将首先写入临时路径，然后使用 `mv` 将临时目录提交到目标目录。 |
48+
| custom_filename | boolean | 否 | false | 是否需要自定义文件名 |
49+
| file_name_expression | string | 否 | "${transactionId}" | 仅在 custom_filename 为 true 时使用 |
50+
| filename_time_format | string | 否 | "yyyy.MM.dd" | 仅在 custom_filename 为 true 时使用 |
51+
| file_format_type | string | 否 | "csv" | 文件格式类型 |
5252
| filename_extension | string | 否 | - | 使用自定义的文件扩展名覆盖默认的文件扩展名。 例如：`.xml`, `.json`, `dat`, `.customtype` |
53-
| field_delimiter | string | 否 | '\001' | 仅在 file_format_type 为 text 时使用 |
54-
| row_delimiter | string | 否 | "\n" | 仅在 file_format_type 为 `text`、`csv`、`json` 时使用 |
55-
| have_partition | boolean | 否 | false | 是否需要处理分区 |
56-
| partition_by | array | 否 | - | 仅在 have_partition 为 true 时使用 |
57-
| partition_dir_expression | string | 否 | "${k0}=${v0}/${k1}=${v1}/.../${kn}=${vn}/" | 仅在 have_partition 为 true 时使用 |
58-
| is_partition_field_write_in_file | boolean | 否 | false | 仅在 have_partition 为 true 时使用 |
59-
| sink_columns | array | 否 | | 当此参数为空时，所有字段都是 sink 列 |
60-
| is_enable_transaction | boolean | 否 | true | 是否启用事务 |
61-
| batch_size | int | 否 | 1000000 | 批量大小 |
62-
| single_file_mode | boolean | 否 | false | 每个并行度只会输出一个文件，当此参数开启时，batch_size就不会生效。输出的文件名没有文件块后缀。 |
63-
| create_empty_file_when_no_data | boolean | 否 | false | 当上游没有数据同步时，依然生成对应的数据文件。 |
64-
| compress_codec | string | 否 | none | 压缩编码 |
65-
| common-options | object | 否 | - | 常见选项 |
66-
| max_rows_in_memory | int | 否 | - | 仅在 file_format_type 为 excel 时使用 |
67-
| sheet_name | string | 否 | Sheet${随机数} | 仅在 file_format_type 为 excel 时使用 |
68-
| csv_string_quote_mode | enum | 否 | MINIMAL | 仅在文件格式为 CSV 时使用。 |
69-
| xml_root_tag | string | 否 | RECORDS | 仅在 file_format 为 xml 时使用 |
70-
| xml_row_tag | string | 否 | RECORD | 仅在 file_format 为 xml 时使用 |
71-
| xml_use_attr_format | boolean | 否 | - | 仅在 file_format 为 xml 时使用 |
72-
| parquet_avro_write_timestamp_as_int96 | boolean | 否 | false | 仅在 file_format 为 parquet 时使用 |
73-
| parquet_avro_write_fixed_as_int96 | array | 否 | - | 仅在 file_format 为 parquet 时使用 |
53+
| field_delimiter | string | 否 | '\001' | 仅在 file_format_type 为 text 时使用 |
54+
| row_delimiter | string | 否 | "\n" | 仅在 file_format_type 为 `text`、`csv`、`json` 时使用 |
55+
| have_partition | boolean | 否 | false | 是否需要处理分区 |
56+
| partition_by | array | 否 | - | 仅在 have_partition 为 true 时使用 |
57+
| partition_dir_expression | string | 否 | "${k0}=${v0}/${k1}=${v1}/.../${kn}=${vn}/" | 仅在 have_partition 为 true 时使用 |
58+
| is_partition_field_write_in_file | boolean | 否 | false | 仅在 have_partition 为 true 时使用 |
59+
| sink_columns | array | 否 | | 当此参数为空时，所有字段都是 sink 列 |
60+
| is_enable_transaction | boolean | 否 | true | 是否启用事务 |
61+
| batch_size | int | 否 | 1000000 | 批量大小 |
62+
| single_file_mode | boolean | 否 | false | 每个并行度只会输出一个文件，当此参数开启时，batch_size就不会生效。输出的文件名没有文件块后缀。 |
63+
| create_empty_file_when_no_data | boolean | 否 | false | 当上游没有数据同步时，依然生成对应的数据文件。 |
64+
| compress_codec | string | 否 | none | 压缩编码 |
65+
| common-options | object | 否 | - | 常见选项 |
66+
| max_rows_in_memory | int | 否 | - | 仅在 file_format_type 为 excel 时使用 |
67+
| sheet_name | string | 否 | Sheet${随机数} | 仅在 file_format_type 为 excel 时使用 |
68+
| csv_string_quote_mode | enum | 否 | MINIMAL | 仅在文件格式为 CSV 时使用。 |
69+
| xml_root_tag | string | 否 | RECORDS | 仅在 file_format 为 xml 时使用 |
70+
| xml_row_tag | string | 否 | RECORD | 仅在 file_format 为 xml 时使用 |
71+
| xml_use_attr_format | boolean | 否 | - | 仅在 file_format 为 xml 时使用 |
72+
| parquet_avro_write_timestamp_as_int96 | boolean | 否 | false | 仅在 file_format 为 parquet 时使用 |
73+
| parquet_avro_write_fixed_as_int96 | array | 否 | - | 仅在 file_format 为 parquet 时使用 |
7474
| enable_header_write | boolean | 否 | false | 仅在 file_format_type 为 text,csv 时使用。<br/> false:不写入表头,true:写入表头。 |
7575
| encoding | string | 否 | "UTF-8" | 仅在 file_format_type 为 json,text,csv,xml 时使用 |
7676
| schema_save_mode | string | 否 | CREATE_SCHEMA_WHEN_NOT_EXIST | 现有目录处理方式 |

0 commit comments

Comments
 (0)