Project: SeaTunnel (App Definition and Development / Streaming & Messaging)
File: HdfsFile.md

HDFS File Sink Connector Spark<br/> Flink<br/> SeaTunnel Zeta<br/> By default, we use 2PC commit to ensure `exactly-once` [x] file format type [x] text [x] csv [x] parquet [x] orc [x] json [x] excel [x] xml [x] compress codec [x] lzo Output data to hdfs file | Datasource | Supported Versions | ||--| | HdfsFile | hadoop 2.x and 3.x | | 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. | | 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 hdfs path. | | hdfssitepath | 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 | | filenameexpression | string | no | "${transactionId}" | Only used when `customfilename` is `true`.`filenameexpression` describes the file expression which will be created into the `path`. We can add the variable `${now}` or `${uuid}` in the `filenameexpression`, like `test${uuid}${now}`,`${now}` represents the current time, and its format can be defined by specifying the option `filenametimeformat`.Please note that, If `isenabletransaction` is `true`, we will auto add `${transactionId}` in the head of the file. | | filenametimeformat | string | no | "yyyy.MM.dd" | Only used when `customfilename` is `true`.When the format in the `filenameexpression` parameter is `xxxx-${now}` , `filenametime_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] | | fileformattype | string | no | "csv" | We supported as the following file types:`text` `json` `csv` `orc` `parquet` `excel` `xml`.Please note that, The final file name will end with the file_format's suffix, the suffix of the text file is `txt`. | | fielddelimiter | string | no | '\001' | Only used when fileformat is text,The separator between columns in a row of data. Only needed by `text` file format. | | rowdelimiter | string | no | "\n" | Only used when fileformat is text,The separator between rows in a file. Only needed by `text` file format. | | have_partition | boolean | no | false | Whether you need processing

| | partitionby | array | no | - | Only used then havepartition is true,Partition data based on selected fields. | | partitiondirexpression | string | no | "${k0}=${v0}/${k1}=${v1}/.../${kn}=${vn}/" | Only used then havepartition is true,If the `partitionby` 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 `partitiondirexpression` is `${k0}=${v0}/${k1}=${v1}/.../${kn}=${vn}/`. `k0` is the first partition field and `v0` is the value of the first partition field. | | ispartitionfieldwriteinfile | boolean | no | false | Only used when `havepartition` is `true`. If `ispartitionfieldwritein_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. | | isenabletransaction | boolean | no | true | If `isenabletransaction` 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 `isenabletransaction` is `true`, we will auto add `${transactionId}_` in the head of the file.Only support `true` now. | | batchsize | int | no | 1000000 | The maximum number of rows in a file. For SeaTunnel Engine, the number of lines in the file is determined by `batchsize` 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. | | krb5_path | string | no |

| The krb5 path of kerberos | | kerberos_principal | string | no | - | The principal of kerberos | | kerberoskeytabpath | 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 for details | | maxrowsinmemory | int | no | - | Only used when fileformat is excel.When File Format is Excel,The maximum number of data items that can be cached in the memory. | | sheetname | string | no | Sheet${Random number} | Only used when fileformat is excel.Writer the sheet of the workbook | | xmlroottag | string | no | RECORDS | Only used when file_format is xml, specifies the tag name of the root element within the XML file. | | xmlrowtag | string | no | RECORD | Only used when file_format is xml, specifies the tag name of the data rows within the XML file | | xmluseattrformat | boolean | no | - | Only used when fileformat is xml, specifies Whether to process data using the tag attribute format. | | encoding | string | no | "UTF-8" | Only used when fileformattype is json,text,csv,xml. | 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. This example defines a SeaTunnel synchronization task that automatically generates data through FakeSource and sends it to Hdfs. ``` env { parallelism = 1 job.mode = "BATCH" } source { FakeSource { parallelism = 1 resulttablename = "fake" row.num = 16 schema = { fields { c_map = "map<string, smallint>" c_array = "array<int>" c_string = string c_boolean = boolean c_tinyint = tinyint c_smallint = smallint c_int = int c_bigint = bigint c_float = float c_double = double c_decimal = "decimal(30, 8)" c_bytes = bytes c_date = date c_timestamp = timestamp } } } } transform { } sink { HdfsFile { fs.defaultFS = "hdfs://hadoopcluster" path = "/tmp/hive/warehouse/test2" fileformattype = "orc" } } ``` ``` HdfsFile { fs.defaultFS = "hdfs://hadoopcluster" path = "/tmp/hive/warehouse/test2" fileformattype = "orc" } ``` ``` HdfsFile { fs.defaultFS = "hdfs://hadoopcluster" path = "/tmp/hive/warehouse/test2" fileformattype = "text" field_delimiter = "\t" row_delimiter = "\n" have_partition = true partition_by = ["age"] partitiondirexpression = "${k0}=${v0}" ispartitionfieldwritein_file = true custom_filename = true filenameexpression = "${transactionId}_${now}" filenametimeformat = "yyyy.MM.dd" sink_columns = ["name","age"] isenabletransaction = true } ``` ``` HdfsFile { fs.defaultFS = "hdfs://hadoopcluster" path = "/tmp/hive/warehouse/test2" have_partition = true partition_by = ["age"] partitiondirexpression = "${k0}=${v0}" ispartitionfieldwritein_file = true custom_filename = true filenameexpression = "${transactionId}_${now}" filenametimeformat = "yyyy.MM.dd" fileformattype = "parquet" sink_columns = ["name","age"] isenabletransaction = true } ``` ``` HdfsFile { fs.defaultFS = "hdfs://hadoopcluster" path = "/tmp/hive/warehouse/test2" hdfssitepath = "/path/to/your/hdfssitepath" kerberosprincipal = "yourprincipal@EXAMPLE.COM" kerberoskeytabpath = "/path/to/your/keytab/file.keytab" } ``` ``` HdfsFile { fs.defaultFS = "hdfs://hadoopcluster" path = "/tmp/hive/warehouse/test2" compress_codec = "lzo" } ```