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

Local file sink connector Output data to local file. :::tip 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. ::: 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 | Name | Type | Required | Default | Description | |-||-|--|| | path | string | yes | - | | | tmp_path | string | no | /tmp/seatunnel | The result file will write to a tmp path first and then use `mv` to submit tmp dir to target dir. | | custom_filename | boolean | no | false | Whether you need custom the filename | | filenameexpression | string | no | "${transactionId}" | Only used when custom_filename is true | | filenametimeformat | string | no | "yyyy.MM.dd" | Only used when custom_filename is true | | fileformattype | string | no | "csv" | | | fielddelimiter | string | no | '\001' | Only used when fileformat_type is text | | rowdelimiter | string | no | "\n" | Only used when fileformat_type is text | | have_partition | boolean | no | false | Whether you need processing partitions. | | partitionby | array | no | - | Only used then havepartition is true | | partitiondirexpression | string | no | "${k0}=${v0}/${k1}=${v1}/.../${kn}=${vn}/" | Only used then have_partition is true | | ispartitionfieldwriteinfile | boolean | no | false | Only used then havepartition is true | | sink_columns | array | no | | When this parameter is empty, all fields are sink columns | | isenabletransaction | boolean | no | true | | | batch_size | int | no | 1000000 | | | compress_codec | string | no | none | | | common-options | object | no | - | | | maxrowsinmemory | int | no | - | Only used when fileformat_type is excel. | | sheetname | string | no | Sheet${Random number} | Only used when fileformat_type is excel. | | xmlroottag | string | no | RECORDS | Only used when file_format is xml. | | xmlrowtag | string | no | RECORD | Only used when file_format is xml. | | xmluseattrformat | boolean | no | - | Only used when fileformat is

| | enableheaderwrite | boolean | no | false | Only used when fileformattype is text,csv.<br/> false:don't write header,true:write header. | | encoding | string | no | "UTF-8" | Only used when fileformattype is json,text,csv,xml. | The target dir path is required, you can inject the upstream CatalogTable into the path by using: `${databasename}`, `${tablename}` and `${schema_name}`. Whether custom the filename Only used when `custom_filename` 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. Only used when `custom_filename` is `true` When the format in the `filenameexpression` parameter is `xxxx-${now}` , `filenametimeformat` 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 | 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 fileformattype's suffix, the suffix of the text file is `txt`. The separator between columns in a row of data. Only needed by `text` file format. The separator between rows in a file. Only needed by `text` file format. Whether you need processing partitions. Only used when `have_partition` is `true`. Partition data based on selected fields. 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 `partitiondirexpression` is `${k0}=${v0}/${k1}=${v1}/.../${kn}=${vn}/`. `k0` is the first partition field and `v0` is the value of the first partition field. Only used when `have_partition` 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`. 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

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. 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 `batchsize`. If `checkpoint.interval` is small, the sink writer will create a new file when a new checkpoint trigger. 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 Sink plugin common parameters, please refer to for details. When File Format is Excel,The maximum number of data items that can be cached in the memory. Writer the sheet of the workbook Specifies the tag name of the root element within the XML file. Specifies the tag name of the data rows within the XML file. Specifies Whether to process data using the tag attribute format. Only used when fileformattype is text,csv.false:don't write header,true:write header. Only used when fileformattype is json,text,csv,xml. The encoding of the file to write. This param will be parsed by `Charset.forName(encoding)`. For orc file format simple config ```bash LocalFile { path = "/tmp/hive/warehouse/test2" fileformattype = "orc" } ``` For json, text, csv or xml file format with `encoding` ```hocon LocalFile { path = "/tmp/hive/warehouse/test2" fileformattype = "text" encoding = "gbk" } ``` For parquet file format with `sink_columns` ```bash LocalFile { path = "/tmp/hive/warehouse/test2" fileformattype = "parquet" sink_columns = ["name","age"] } ``` For text file format with `havepartition` and `customfilename` and `sink_columns` ```bash LocalFile { 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 } ``` For excel file format with `sheetname` and `maxrowsinmemory` ```bash LocalFile { path="/tmp/seatunnel/excel" sheet_name = "Sheet1" maxrowsin_memory = 1024 partitiondirexpression="${k0}=${v0}" ispartitionfieldwritein_file=true filenameexpression="${transactionId}_${now}" fileformattype="excel" filenametimeformat="yyyy.MM.dd" isenabletransaction=true } ``` For extract source metadata from upstream, you can use `${databasename}`, `${tablename}` and `${schema_name}` in the path. ```bash LocalFile { path = "/tmp/hive/warehouse/${table_name}" fileformattype = "parquet" sink_columns = ["name","age"] } ``` Add Local File Sink Connector ) ) ) ) When field from upstream is null it will throw NullPointerException Sink columns mapping failed When restore writer from states getting transaction directly failed ) )