# SftpFile
> Sftp file source connector
### Key Features[](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/SftpFile#key-features)
* [x] batch
* [ ] stream
* [ ] exactly-once
* [x] column projection
* [x] parallelism
* [ ] support user-defined split
* [x] file format type
* [x] text
* [x] csv
* [x] json
* [x] excel
* [x] xml
* [x] binary
### Description[](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/SftpFile#description)
Read data from sftp file server.
**tip**
We made some trade-offs in order to support more file types, so we used the HDFS protocol for internal access to Sftp and this connector need some hadoop dependencies. It only supports hadoop version **2.9.X+**.
### Data Type Mapping[](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/SftpFile#data-type-mapping)
The File does not have a specific type list, and we can indicate which Nexus data type the corresponding data needs to be converted to by specifying the Schema in the config.
| Nexus Data type |
| --------------- |
| STRING |
| SHORT |
| INT |
| BIGINT |
| BOOLEAN |
| DOUBLE |
| DECIMAL |
| FLOAT |
| DATE |
| TIME |
| TIMESTAMP |
| BYTES |
| ARRAY |
| MAP |
### Source Options[](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/SftpFile#source-options)
| Name | Type | Required | default value | Description |
| ---------------------------- | ------- | -------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| host | String | Yes | - | The target sftp host is required |
| port | Int | Yes | - | The target sftp port is required |
| user | String | Yes | - | The target sftp username is required |
| password | String | Yes | - | The target sftp password is required |
| path | String | Yes | - | The source file path. |
| file\_format\_type | String | Yes | - | Please check #file\_format\_type below |
| file\_filter\_pattern | String | No | - | Filter pattern, which used for filtering files. |
| delimiter/field\_delimiter | String | No | \001 | delimiter parameter will deprecate after version 2.3.5, please use field\_delimiter instead.
Field delimiter, used to tell connector how to slice and dice fields when reading text files.
Default \001, the same as hive's default delimiter
|
| parse\_partition\_from\_path | Boolean | No | true | Control whether parse the partition keys and values from file path
For example if you read a file from path oss\://hadoop-cluster/tmp/nexus/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\_format | String | No | yyyy-MM-dd | 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\_format | String | No | yyyy-MM-dd HH:mm:ss | 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\_format | String | No | 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
|
| skip\_header\_row\_number | Long | No | 0 | Skip the first few lines, but only for the txt and csv.
For example, set like following:
skip\_header\_row\_number = 2
then Nexus will skip the first 2 lines from source files
|
| read\_columns | list | no | - | The read column list of the data source, user can use it to implement field projection. |
| sheet\_name | String | No | - | Reader the sheet of the workbook,Only used when file\_format is excel. |
| xml\_row\_tag | string | no | - | Specifies the tag name of the data rows within the XML file, only used when file\_format is xml. |
| xml\_use\_attr\_format | boolean | no | - | Specifies whether to process data using the tag attribute format, only used when file\_format is xml. |
| schema | Config | No | - | Please check #schema below |
| 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
|
| encoding | string | no | UTF-8 | |
| common-options | | No | - | Source plugin common parameters, please refer to [Source Common Options](/data-integration-with-nexus/nexus-elements/connectors/source/source-common-options.md)[on Options](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/common-options) for details. |
#### file\_format\_type \[string][](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/SftpFile#file_format_type-string)
File type, supported as the following file types: `text` `csv` `parquet` `orc` `json` `excel` `xml` `binary` 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 can also save multiple pieces of data in one file and split them by newline:
```
{"code": 200, "data": "get success", "success": true}
{"code": 300, "data": "get failed", "success": false}
```
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 `parquet` `orc`, schema option not required, connector can find the schema of upstream data automatically. 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 |
If you assign file type to `binary`, Nexus can synchronize files in any format, such as compressed packages, pictures, etc. In short, any files can be synchronized to the target place. Under this requirement, you need to ensure that the source and sink use `binary` format for file synchronization at the same time.
#### compress\_codec \[string][](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/SftpFile#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/parquet:\
automatically recognizes the compression type, no additional settings required.
#### encoding \[string][](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/SftpFile#encoding-string)
Only used when file\_format\_type is json,text,csv,xml. The encoding of the file to read. This param will be parsed by `Charset.forName(encoding)`.
#### schema \[config][](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/SftpFile#schema-config)
**fields \[Config]**[****](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/SftpFile#fields-config)
The schema of upstream data.
### How to Create a Sftp Data Synchronization Jobs[](https://seatunnel.apache.org/docs/2.3.7/connector-v2/source/SftpFile#how-to-create-a-sftp-data-synchronization-jobs)
The following example demonstrates how to create a data synchronization job that reads data from sftp and prints it on the local client:
```
# Set the basic configuration of the task to be performed
env {
parallelism = 1
job.mode = "BATCH"
}
# Create a source to connect to sftp
source {
SftpFile {
host = "sftp"
port = 22
user = "nexus"
password = "pass"
path = "tmp/nexus/read/json"
file_format_type = "json"
result_table_name = "sftp"
schema = {
fields {
c_map = "map"
c_array = "array"
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_bytes = bytes
c_date = date
c_decimal = "decimal(38, 18)"
c_timestamp = timestamp
c_row = {
C_MAP = "map"
C_ARRAY = "array"
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_BYTES = bytes
C_DATE = date
C_DECIMAL = "decimal(38, 18)"
C_TIMESTAMP = timestamp
}
}
}
}
}
# Console printing of the read sftp data
sink {
Console {
parallelism = 1
}
}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.selfuel.digital/data-integration-with-nexus/nexus-elements/connectors/source/sftpfile.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.