davidzollo commented on code in PR #8661: URL: https://github.com/apache/seatunnel/pull/8661#discussion_r1953665158
##########
docs/zh/connector-v2/sink/FtpFile.md:
##########
@@ -0,0 +1,361 @@
+# FtpFile
+
+> Ftp文件接收器连接器
+
+## 描述
+
+将数据输出到Ftp。
+
+:::提示
+
+如果你使用spark/flink，为了使用这个连接器，你必须确保你的spark/flilk集群已经集成了hadoop。测试的hadoop版本是2.x。
+
+如果你使用SeaTunnel Engine，当你下载并安装SeaTunnel引擎时，它会自动集成hadoop
jar。您可以在${SEATUNNEL_HOME}/lib下检查jar包以确认这一点。
+
+:::
+
+## 主要特性
+
+- [x] [exactly-once](../../concept/connector-v2-features.md)
+
+默认情况下，我们使用2PC commit来确保 `exactly-once`
+
+- [x] file format
+ - [x] text
+ - [x] csv
+ - [x] parquet
+ - [x] orc
+ - [x] json
+ - [x] excel
+ - [x] xml
+ - [x] binary
+
+## 选项
+
+| Name | Type | Required | Default
| Description
|
+|---------------------------------------|---------|----------|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| host | string | yes | -
|
|
+| port | int | yes | -
|
|
+| user | string | yes | -
|
|
+| password | string | yes | -
|
|
+| path | string | yes | -
|
|
+| tmp_path | string | yes | /tmp/seatunnel
| The result file will write to a tmp path first and
then use `mv` to submit tmp dir to target dir. Need a FTP dir.
|
+| connection_mode | string | no | active_local
| The target ftp connection mode
|
+| custom_filename | boolean | no | false
| Whether you need custom the filename
|
+| file_name_expression | string | no |
"${transactionId}" | Only used when custom_filename is
true
|
+| filename_time_format | string | no | "yyyy.MM.dd"
| Only used when custom_filename is true
|
+| file_format_type | string | no | "csv"
|
|
+| field_delimiter | string | no | '\001'
| Only used when file_format_type is text
|
+| row_delimiter | string | no | "\n"
| Only used when file_format_type is text
|
+| have_partition | boolean | no | false
| Whether you need processing partitions.
|
+| partition_by | array | no | -
| Only used then have_partition is true
|
+| partition_dir_expression | string | no |
"${k0}=${v0}/${k1}=${v1}/.../${kn}=${vn}/" | Only used then have_partition is
true
|
+| is_partition_field_write_in_file | boolean | no | false
| Only used then have_partition is true
|
+| sink_columns | array | no |
| When this parameter is empty, all fields are sink
columns
|
+| is_enable_transaction | boolean | no | true
|
|
+| batch_size | int | no | 1000000
|
|
+| compress_codec | string | no | none
|
|
+| common-options | object | no | -
|
|
+| max_rows_in_memory | int | no | -
| Only used when file_format_type is excel.
|
+| sheet_name | string | no | Sheet${Random
number} | Only used when file_format_type is excel.
|
+| csv_string_quote_mode | enum | no | MINIMAL
| Only used when file_format is csv.
|
+| xml_root_tag | string | no | RECORDS
| Only used when file_format is xml.
|
+| 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.
|
+| single_file_mode | boolean | no | false
| Each parallelism will only output one file. When
this parameter is turned on, batch_size will not take effect. The output file
name does not have a file block suffix. |
+| create_empty_file_when_no_data | boolean | no | false
| When there is no data synchronization upstream,
the corresponding data files are still generated.
|
+| 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
|
+
Review Comment:
Good job.
Please translate the word `yes` or `no` into Chinese `是` or `否` in this
table.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
