# Ftp Reader
FtpReader 提供了读取远程 FTP/SFTP 文件系统数据存储的能力。
## 功能说明
### 配置样例
=== "job/ftp2stream.json"
`json
--8<-- "jobs/ftpreader.json"
`
### 参数说明
#### path
远程 FTP 文件系统的路径信息，注意这里可以支持填写多个路径。
当指定单个远程 FTP 文件，FtpReader 暂时只能使用单线程进行数据抽取。
当指定多个远程 FTP 文件，FtpReader 支持使用多线程进行数据抽取。线程并发数通过通道数指定
当指定通配符，FtpReader 尝试遍历出多个文件信息。例如: 指定 /* 代表读取/目录下所有的文件，指定 /bazhen/* 代表读取 bazhen 目录下游所有的文件。目前只支持 * 作为文件通配符。
特别需要注意的是，Addax 会将一个作业下同步的所有 Text File 视作同一张数据表。用户必须自己保证所有的 File 能够适配同一套 schema 信息。读取文件用户必须保证为类 CSV 格式，并且提供给 Addax 权限可读。 特别需要注意的是，如果 Path 指定的路径下没有符合匹配的文件抽取，Addax 将报错。
#### column
读取字段列表，type 指定源数据的类型，index 指定当前列来自于文本第几列(以 0 开始)，value 指定当前类型为常量，不从源头文件读取数据，而是根据 value 值自动生成对应的列。
默认情况下，用户可以全部按照 String 类型读取数据，配置如下：
"column": ["*"]
}
用户可以指定 Column 字段信息，配置如下：
- {
"type": "long", "index": 0, "description": "从远程FTP文件文本第一列获取int字段"
}, {
"type": "string", "value": "addax", "description": "从FtpReader内部生成alibaba的字符串字段作为当前字段"
}
]
对于用户指定 Column 信息，type 必须填写，index/value 必须选择其一。
#### csvReaderConfig
常见配置：
- "csvReaderConfig": {
"safetySwitch": false, "skipEmptyRecords": false, "useTextQualifier": false
}
}
所有配置项及默认值,配置时 csvReaderConfig 的 map 中请**严格按照以下字段名字进行配置**：
`ini
boolean caseSensitive = true;
char textQualifier = 34;
boolean trimWhitespace = true;
boolean useTextQualifier = true;//是否使用csv转义字符
char delimiter = 44;//分隔符
char recordDelimiter = 0;
char comment = 35;
boolean useComments = false;
int escapeMode = 1;
boolean safetySwitch = true;//单列长度是否限制100000字符
boolean skipEmptyRecords = true;//是否跳过空行
boolean captureRawRecord = true;
`
### 类型转换
远程 FTP 文件本身不提供数据类型，该类型是 Addax FtpReader 定义：
其中：
Long 是指远程 FTP 文件文本中使用整形的字符串表示形式，例如"19901219"。
Double 是指远程 FTP 文件文本中使用 Double 的字符串表示形式，例如"3.1415"。
Boolean 是指远程 FTP 文件文本中使用 Boolean 的字符串表示形式，例如"true"、"false"。不区分大小写。
Date 是指远程 FTP 文件文本中使用 Date 的字符串表示形式，例如"2014-12-31"，Date 可以指定 format 格式。
## 限制
单个 File 支持多线程并发读取，这里涉及到单个 File 内部切分算法
单个 File 在压缩情况下，从技术上无法支持多线程并发读取。