zhilinli123 commented on code in PR #4871:
URL: https://github.com/apache/seatunnel/pull/4871#discussion_r1284153975
##########
docs/en/connector-v2/sink/HdfsFile.md:
##########
@@ -30,183 +24,108 @@ By default, we use 2PC commit to ensure `exactly-once`
- [x] compress codec
- [x] lzo
-## Options
-
-| name | type | required |
default value | remarks
|
-|----------------------------------|---------|----------|--------------------------------------------|-----------------------------------------------------------|
-| fs.defaultFS | string | yes | -
|
|
-| path | string | yes | -
|
|
-| hdfs_site_path | string | no | -
|
|
-| 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 is text
|
-| row_delimiter | string | no | "\n"
| Only used when file_format 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
|
|
-| kerberos_principal | string | no | -
|
-| kerberos_keytab_path | string | no | -
|
|
-| compress_codec | string | no | none
|
|
-| common-options | object | no | -
|
|
-| max_rows_in_memory | int | no | -
| Only used when file_format is excel.
|
-| sheet_name | string | no | Sheet${Random
number} | Only used when file_format is excel.
|
-
-### fs.defaultFS [string]
-
-The hadoop cluster address that start with `hdfs://`, for example:
`hdfs://hadoopcluster`
-
-### path [string]
-
-The target dir path is required.
-
-### hdfs_site_path [string]
-
-The path of `hdfs-site.xml`, used to load ha configuration of namenodes
-
-### custom_filename [boolean]
-
-Whether custom the filename
-
-### file_name_expression [string]
-
-Only used when `custom_filename` is `true`
-
-`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.
-
-### filename_time_format [string]
-
-Only used when `custom_filename` is `true`
-
-When the format in the `file_name_expression` parameter is `xxxx-${now}` ,
`filename_time_format` can specify the time format of the path, and the default
value is `yyyy.MM.dd` . The commonly used time formats are listed as follows:
-
-| Symbol | Description |
-|--------|--------------------|
-| y | Year |
-| M | Month |
-| d | Day of month |
-| H | Hour in day (0-23) |
-| m | Minute in hour |
-| s | Second in minute |
-
-### file_format_type [string]
-
-We supported as the following file types:
-
-`text` `json` `csv` `orc` `parquet` `excel`
-
-Please note that, The final file name will end with the file_format's suffix,
the suffix of the text file is `txt`.
-
-### field_delimiter [string]
-
-The separator between columns in a row of data. Only needed by `text` file
format.
-
-### row_delimiter [string]
-
-The separator between rows in a file. Only needed by `text` file format.
-
-### have_partition [boolean]
-
-Whether you need processing partitions.
-
-### partition_by [array]
-
-Only used when `have_partition` is `true`.
-
-Partition data based on selected fields.
-
-### partition_dir_expression [string]
-
-Only used when `have_partition` is `true`.
-
-If the `partition_by` is specified, we will generate the corresponding
partition directory based on the partition information, and the final file will
be placed in the partition directory.
-
-Default `partition_dir_expression` is
`${k0}=${v0}/${k1}=${v1}/.../${kn}=${vn}/`. `k0` is the first partition field
and `v0` is the value of the first partition field.
-
-### is_partition_field_write_in_file [boolean]
-
-Only used when `have_partition` is `true`.
-
-If `is_partition_field_write_in_file` is `true`, the partition field and the
value of it will be write into data file.
-
-For example, if you want to write a Hive Data File, Its value should be
`false`.
-
-### sink_columns [array]
-
-Which columns need be write to file, default value is all of the columns get
from `Transform` or `Source`.
-The order of the fields determines the order in which the file is actually
written.
-
-### is_enable_transaction [boolean]
-
-If `is_enable_transaction` is true, we will ensure that data will not be lost
or duplicated when it is written to the target directory.
-
-Please note that, If `is_enable_transaction` is `true`, we will auto add
`${transactionId}_` in the head of the file.
-
-Only support `true` now.
-
-### batch_size [int]
-
-The maximum number of rows in a file. For SeaTunnel Engine, the number of
lines in the file is determined by `batch_size` and `checkpoint.interval`
jointly decide. If the value of `checkpoint.interval` is large enough, sink
writer will write rows in a file until the rows in the file larger than
`batch_size`. If `checkpoint.interval` is small, the sink writer will create a
new file when a new checkpoint trigger.
-
-### compress_codec [string]
-
-The compress codec of files and the details that supported as the following
shown:
-
-- txt: `lzo` `none`
-- json: `lzo` `none`
-- csv: `lzo` `none`
-- orc: `lzo` `snappy` `lz4` `zlib` `none`
-- parquet: `lzo` `snappy` `lz4` `gzip` `brotli` `zstd` `none`
-
-Tips: excel type does not support any compression format
-
-### kerberos_principal [string]
-
-The principal of kerberos
-
-### kerberos_keytab_path [string]
-
-The keytab path of kerberos
-
-### common options
-
-Sink plugin common parameters, please refer to [Sink Common
Options](common-options.md) for details
+## Description
-### max_rows_in_memory [int]
+Output data to hdfs file
-When File Format is Excel,The maximum number of data items that can be cached
in the memory.
+## Supported DataSource Info
+
+| Datasource | Supported Versions |
+|------------|--------------------|
+| HdfsFile | hadoop 2.x and 3.x |
+
+## Sink Options
+
+| Name | Type | Required |
Default |
Description
|
+|----------------------------------|---------|----------|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| fs.defaultFS | string | yes | -
| The hadoop cluster address that start with `hdfs://`,
for example: `hdfs://hadoopcluster`
|
+| path | string | yes | -
| The target dir path is required.
|
+| hdfs_site_path | string | no | -
| The path of `hdfs-site.xml`, used to load ha
configuration of namenodes
|
+| custom_filename | boolean | no | false
| Whether you need custom the filename
|
+| file_name_expression | string | no | "${transactionId}"
| Only used when `custom_filename` is
`true`.`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. |
+| filename_time_format | string | no | "yyyy.MM.dd"
| Only used when `custom_filename` is `true`.When the
format in the `file_name_expression` parameter is `xxxx-${now}` ,
`filename_time_format` can specify the time format of the path, and the default
value is `yyyy.MM.dd` . The commonly used time formats are listed as
follows:[y:Year,M:Month,d:Day of month,H:Hour in day (0-23),m:Minute in
hour,s:Second in minute]
|
+| file_format_type | string | no | "csv"
| We supported as the following file types:`text` `json`
`csv` `orc` `parquet` `excel`.Please note that, The final file name will end
with the file_format's suffix, the suffix of the text file is `txt`.
|
+| field_delimiter | string | no | '\001'
| Only used when file_format is text,The separator
between columns in a row of data. Only needed by `text` file format.
|
+| row_delimiter | string | no | "\n"
| Only used when file_format is text,The separator
between rows in a file. Only needed by `text` file format.
|
+| have_partition | boolean | no | false
| Whether you need processing partitions.
|
+| partition_by | array | no | -
| Only used then have_partition is true,Partition data
based on selected fields.
|
+| partition_dir_expression | string | no |
"${k0}=${v0}/${k1}=${v1}/.../${kn}=${vn}/" | Only used then have_partition is
true,If the `partition_by` is specified, we will generate the corresponding
partition directory based on the partition information, and the final file will
be placed in the partition directory. Default `partition_dir_expression` is
`${k0}=${v0}/${k1}=${v1}/.../${kn}=${vn}/`. `k0` is the first partition field
and `v0` is the value of the first partition field.
|
+| is_partition_field_write_in_file | boolean | no | false
| Only used when `have_partition` is `true`. If
`is_partition_field_write_in_file` is `true`, the partition field and the value
of it will be write into data file.For example, if you want to write a Hive
Data File, Its value should be `false`.
|
+| sink_columns | array | no |
| When this parameter is empty, all fields are sink
columns.Which columns need be write to file, default value is all of the
columns get from `Transform` or `Source`. The order of the fields determines
the order in which the file is actually written.
|
+| is_enable_transaction | boolean | no | true
| If `is_enable_transaction` is true, we will ensure that
data will not be lost or duplicated when it is written to the target
directory.Please note that, If `is_enable_transaction` is `true`, we will auto
add `${transactionId}_` in the head of the file.Only support `true` now.
|
+| batch_size | int | no | 1000000
| The maximum number of rows in a file. For SeaTunnel
Engine, the number of lines in the file is determined by `batch_size` and
`checkpoint.interval` jointly decide. If the value of `checkpoint.interval` is
large enough, sink writer will write rows in a file until the rows in the file
larger than `batch_size`. If `checkpoint.interval` is small, the sink writer
will create a new file when a new checkpoint trigger.
|
+| compress_codec | string | no | none
| The compress codec of files and the details that
supported as the following shown:[txt: `lzo` `none`,json: `lzo` `none`,csv:
`lzo` `none`,orc: `lzo` `snappy` `lz4` `zlib` `none`,parquet: `lzo` `snappy`
`lz4` `gzip` `brotli` `zstd` `none`].Tips: excel type does not support any
compression format.
|
+| kerberos_principal | string | no | -
| The principal of kerberos
|
+| kerberos_keytab_path | string | no | -
| The keytab path of kerberos
|
+| compress_codec | string | no | none
| compress codec
|
+| common-options | object | no | -
| Sink plugin common parameters, please refer to [Sink
Common Options](common-options.md) for details
|
+| max_rows_in_memory | int | no | -
| Only used when file_format is excel.When File Format is
Excel,The maximum number of data items that can be cached in the memory.
|
+| sheet_name | string | no | Sheet${Random
number} | Only used when file_format is excel.Writer the
sheet of the workbook
|
+
+### Tips
+
+> If you use spark/flink, In order to use this connector, You must ensure your
spark/flink cluster already integrated hadoop. The tested hadoop version is
2.x. If you use SeaTunnel Engine, It automatically integrated the hadoop jar
when you download and install SeaTunnel Engine. You can check the jar package
under ${SEATUNNEL_HOME}/lib to confirm this.
+
+## Task Example
+
+### Simple:
+
+> This example defines a SeaTunnel synchronization task that automatically
generates data through FakeSource and sends it to Hdfs.
-### sheet_name [string]
+```
+# Defining the runtime environment
+env {
+ # You can set flink configuration here
+ execution.parallelism = 1
+ job.mode = "BATCH"
+}
-Writer the sheet of the workbook
+source {
+ # This is a example source plugin **only for test and demonstrate the
feature source plugin**
+ FakeSource {
+ parallelism = 1
+ result_table_name = "fake"
+ row.num = 16
+ schema = {
+ fields {
Review Comment:
Add all types of tests
--
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]
