Hisoka-X commented on code in PR #2120:
URL:
https://github.com/apache/incubator-seatunnel/pull/2120#discussion_r913616423
##########
docs/en/connector-v2/sink/File.mdx:
##########
@@ -0,0 +1,269 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# File
+
+## Description
+
+Output data to local or hdfs or s3 file.
+
+:::tip
+
+Used to write data to file. Supports Batch and Streaming mode.
+
+* [x] Batch
+* [x] Streaming
+
+:::
+
+## Options
+
+<Tabs
+ groupId="engine-type"
+ defaultValue="LocalFile"
+ values={[
+ {label: 'LocalFile', value: 'LocalFile'},
+ {label: 'HdfsFile', value: 'HdfsFile'},
+ ]}>
+ <TabItem value="LocalFile">
+
+| name | type | required | default value
|
+| --------------------------------- | ------ | -------- |
------------------------------------------------------------- |
+| path | string | yes | -
|
+| file_name_expression | string | no | "${transactionId}"
|
+| file_format | string | no | "text"
|
+| filename_time_format | string | no | "yyyy.MM.dd"
|
+| field_delimiter | string | no | '\001'
|
+| row_delimiter | string | no | "\n"
|
+| partition_by | array | no | -
|
+| partition_dir_expression | string | no |
"${k0}=${v0}/${k1}=${v1}/.../${kn}=${vn}/" |
+| is_partition_field_write_in_file | boolean| no | false
|
+| sink_columns | array | no | When this parameter
is empty, all fields are sink columns |
+| is_enable_transaction | boolean| no | true
|
+| save_mode | string | no | "error"
|
+
+### path [string]
+
+The target dir path is required. The `hdfs file` starts with `hdfs://` , and
the `local file` starts with `file://`,
+
+### file_name_expression [string]
+
+`file_name_expression` describes the file expression which will be created
into the `path`. We can add the variable `${now}` or `${uuid}` in the
`file_name_expression`, like `test_${uuid}_${now}`,
+`${now}` represents the current time, and its format can be defined by
specifying the option `filename_time_format`.
+
+Please note that, If `is_enable_transaction` is `true`, we will auto add
`${transactionId}_` in the head of the file.
+
+### file_format [string]
+
+We supported `file_format` is `text`.
+
+Please note that, The final file name will ends with the file_format`s suffix,
the suffix of the text file is `txt`.
Review Comment:
```suggestion
Please note that, The final file name will ends with the file_format's
suffix, the suffix of the text file is `txt`.
```
--
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]
