同步操作将从 Apache SeaTunnel/SeaTunnel 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
Sftp file source connector
Spark
Flink
SeaTunnel Zeta
Read data from sftp file server.
:::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.
:::
name | type | required | default value |
---|---|---|---|
host | string | yes | - |
port | int | yes | - |
user | string | yes | - |
password | string | yes | - |
path | string | yes | - |
file_format_type | string | yes | - |
delimiter/field_delimiter | string | no | \001 |
parse_partition_from_path | boolean | no | true |
date_format | string | no | yyyy-MM-dd |
skip_header_row_number | long | no | 0 |
datetime_format | string | no | yyyy-MM-dd HH:mm:ss |
time_format | string | no | HH:mm:ss |
schema | config | no | - |
sheet_name | string | no | - |
skip_header_row_number | long | no | 0 |
read_columns | list | no | - |
file_filter_pattern | string | no | - |
compress_codec | string | no | none |
common-options | no | - |
The target sftp host is required
The target sftp port is required
The target sftp username is required
The target sftp password is required
The source file path.
File type, supported as the following file types:
text
csv
parquet
orc
json
If you assign file type to json
, you should also assign schema option to tell connector how to parse data to the row you want.
For example:
upstream data is the following:
{"code": 200, "data": "get success", "success": true}
you should assign schema as the following:
schema {
fields {
code = int
data = string
success = boolean
}
}
connector will generate data as the following:
code | data | success |
---|---|---|
200 | get success | true |
If you assign file type to text
csv
, you can choose to specify the schema information or not.
For example, upstream data is the following:
tyrantlucifer#26#male
If you do not assign data schema connector will treat the upstream data as the following:
content |
---|
tyrantlucifer#26#male |
If you assign data schema, you should also assign the option field_delimiter
too except CSV file type
you should assign schema and delimiter as the following:
field_delimiter = "#"
schema {
fields {
name = string
age = int
gender = string
}
}
connector will generate data as the following:
name | age | gender |
---|---|---|
tyrantlucifer | 26 | male |
delimiter parameter will deprecate after version 2.3.5, please use field_delimiter instead.
Only need to be configured when file_format is text.
Field delimiter, used to tell connector how to slice and dice fields.
default \001
, the same as hive's default delimiter
Control whether parse the partition keys and values from file path
For example if you read a file from path sftp://hadoop-cluster/tmp/seatunnel/parquet/name=tyrantlucifer/age=26
Every record data from file will be added these two fields:
name | age |
---|---|
tyrantlucifer | 26 |
Tips: Do not define partition fields in schema option
Date type format, used to tell connector how to convert string to date, supported as the following formats:
yyyy-MM-dd
yyyy.MM.dd
yyyy/MM/dd
default yyyy-MM-dd
Datetime type format, used to tell connector how to convert string to datetime, supported as the following formats:
yyyy-MM-dd HH:mm:ss
yyyy.MM.dd HH:mm:ss
yyyy/MM/dd HH:mm:ss
yyyyMMddHHmmss
default yyyy-MM-dd HH:mm:ss
Time type format, used to tell connector how to convert string to time, supported as the following formats:
HH:mm:ss
HH:mm:ss.SSS
default HH:mm:ss
Only need to be configured when the file_format_type are text, json, excel or csv ( Or other format we can't read the schema from metadata).
The schema information of upstream data.
Only need to be configured when file_format is excel.
Reader the sheet of the workbook.
Skip the first few lines, but only for the txt and csv.
For example, set like following:
skip_header_row_number = 2
then SeaTunnel will skip the first 2 lines from source files
The read column list of the data source, user can use it to implement field projection.
Filter pattern, which used for filtering files.
The compress codec of files and the details that supported as the following shown:
lzo
none
lzo
none
lzo
none
Source plugin common parameters, please refer to Source Common Options for details.
SftpFile {
path = "/tmp/seatunnel/sink/text"
host = "192.168.31.48"
port = 21
user = tyrantlucifer
password = tianchao
file_format_type = "text"
schema = {
name = string
age = int
}
delimiter = "#"
}
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。