SftpFile

Sftp file sink connector

Description

Output data to Sftp .

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.

Key features

• exactly-once

By default, we use 2PC commit to ensure exactly-once

• file format type
  • text
  • csv
  • parquet
  • orc
  • json
  • excel
  • xml
  • binary

Options

name	type	required	default value	remarks
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.
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.
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.
parquet_avro_write_timestamp_as_int96	boolean	no	false	Only used when file_format is parquet.
enable_header_write	boolean	no	false	Only used when file_format_type is text,csv. false:don't write header,true:write header.
parquet_avro_write_fixed_as_int96	array	no	-	Only used when file_format is parquet.
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

host [string]

The target sftp host is required

port [int]

The target sftp port is required

user [string]

The target sftp user is required

password [string]

The target sftp password is required

path [string]

The target dir path is required.

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 csv parquet orc json excel xml binary

Please note that, The final file name will end with the file_format_type'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 wrote to file, default value is all 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

common options

Sink plugin common parameters, please refer to Sink Common Options for details.

max_rows_in_memory

When File Format is Excel,The maximum number of data items that can be cached in the memory.

sheet_name

Writer the sheet of the workbook

xml_root_tag [string]

Specifies the tag name of the root element within the XML file.

xml_row_tag [string]

Specifies the tag name of the data rows within the XML file.

xml_use_attr_format [boolean]

Specifies Whether to process data using the tag attribute format.

parquet_avro_write_timestamp_as_int96 [boolean]

Support writing Parquet INT96 from a timestamp, only valid for parquet files.

parquet_avro_write_fixed_as_int96 [array]

Support writing Parquet INT96 from a 12-byte field, only valid for parquet files.

enable_header_write [boolean]

Only used when file_format_type is text,csv.false:don't write header,true:write header.

encoding [string]

Only used when file_format_type is json,text,csv,xml. The encoding of the file to write. This param will be parsed by Charset.forName(encoding).

schema_save_mode [string]

Existing dir processing method.

• RECREATE_SCHEMA: will create when the dir does not exist, delete and recreate when the dir is exist
• CREATE_SCHEMA_WHEN_NOT_EXIST: will create when the dir does not exist, skipped when the dir is exist
• ERROR_WHEN_SCHEMA_NOT_EXIST: error will be reported when the dir does not exist
• IGNORE ：Ignore the treatment of the table

data_save_mode [string]

Existing data processing method.

• DROP_DATA: preserve dir and delete data files
• APPEND_DATA: preserve dir, preserve data files
• ERROR_WHEN_DATA_EXISTS: when there is data files, an error is reported

Example

For text file format with have_partition and custom_filename and sink_columns

SftpFile {
    host = "xxx.xxx.xxx.xxx"
    port = 22
    user = "username"
    password = "password"
    path = "/data/sftp/seatunnel/job1"
    tmp_path = "/data/sftp/seatunnel/tmp"
    file_format_type = "text"
    field_delimiter = "\t"
    row_delimiter = "\n"
    have_partition = true
    partition_by = ["age"]
    partition_dir_expression = "${k0}=${v0}"
    is_partition_field_write_in_file = true
    custom_filename = true
    file_name_expression = "${transactionId}_${now}"
    filename_time_format = "yyyy.MM.dd"
    sink_columns = ["name","age"]
    is_enable_transaction = true
}

When our source end is multiple tables, and wants different expressions to different directory, we can configure this way

SftpFile {
    host = "xxx.xxx.xxx.xxx"
    port = 22
    user = "username"
    password = "password"
    path = "/data/sftp/seatunnel/job1/${table_name}"
    tmp_path = "/data/sftp/seatunnel/tmp"
    file_format_type = "text"
    field_delimiter = "\t"
    row_delimiter = "\n"
    have_partition = true
    partition_by = ["age"]
    partition_dir_expression = "${k0}=${v0}"
    is_partition_field_write_in_file = true
    custom_filename = true
    file_name_expression = "${transactionId}_${now}"
    filename_time_format = "yyyy.MM.dd"
    sink_columns = ["name","age"]
    is_enable_transaction = true
    schema_save_mode=RECREATE_SCHEMA
    data_save_mode=DROP_DATA
}

Changelog

2.3.0 2022-12-30

• Add SftpFile Sink Connector
• [BugFix] Fixed the following bugs that failed to write data to files (3258)
  • When field from upstream is null it will throw NullPointerException
  • Sink columns mapping failed
  • When restore writer from states getting transaction directly failed
• [Improve] Support setting batch size for every file (3625)

Next version

• [Improve] Support file compress (3899)