# TxtFile Reader
TxtFileReader 提供了读取本地文件系统数据存储的能力。
## 配置样例
=== "job/txtfile2stream.json"
`json --8<-- "jobs/txtreader.json" `
## 参数说明
### path
本地文件系统的路径信息，注意这里可以支持填写多个路径。
当指定单个本地文件，TxtFileReader暂时只能使用单线程进行数据抽取。二期考虑在非压缩文件情况下针对单个File可以进行多线程并发读取
当指定多个本地文件，TxtFileReader支持使用多线程进行数据抽取。线程并发数通过通道数指定
当指定通配符，TxtFileReader尝试遍历出多个文件信息。例如: 指定 /*`代表读取 `/ 目录下所有的文件，指定 /bazhen/* 代表读取 bazhen 目录下游所有的文件。目前只支持 * 作为文件通配符。
特别需要注意的是，Addax会将一个作业下同步的所有Text File视作同一张数据表。用户必须自己保证所有的File能够适配同一套schema信息。读取文件用户必须保证为类CSV格式，并且提供给Addax权限可读。
特别需要注意的是，如果Path指定的路径下没有符合匹配的文件抽取，Addax将报错。
从 3.2.3 版本起， path 下允许混合不同压缩格式的文件，插件会尝试自动猜测压缩格式并自动解压，目前支持的压缩格式有：
zip
bzip2
gzip
LZ4
PACK200
XZ
Compress
### column
读取字段列表，type指定源数据的类型，index指定当前列来自于文本第几列(以0开始)，value指定当前类型为常量，不从源头文件读取数据，而是根据value值自动生成对应的列。
默认情况下，用户可以全部按照String类型读取数据，配置如下：
- "column": [
"*"
]
}
用户可以指定Column字段信息，配置如下：
- {
"type": "long", "index": 0
}, {
"type": "string", "value": "alibaba"
}
]
对于用户指定Column信息，type必须填写，index/value必须选择其一。
从 4.0.1 开始，表示字段除了使用 index 来指定字段的顺序外，还支持 name 方式，这需要所读取的文件的都包含了文件头，插件会尝试将指定的 name 去匹配从文件读取的文件头， 然后得到对应的 index 值，并回写到 配置文件中。同时，index 和 name 可以在不同的列上进行混合使用，比如下面这样：
- {
"type": "long", "index": 0
}, {
"name": "region", "type": "string"
}, {
"type": "string", "value": "alibaba"
}
]
注： 这种方式以为这在准备阶段就要尝试读取文件，因为会有一定的性能损失，如非必要，不建议配置 name 方式。
### csvReaderConfig
读取CSV类型文件参数配置，Map类型。读取CSV类型文件使用的CsvReader进行读取，会有很多配置，不配置则使用默认值。
常见配置：
- "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;
`
## 类型转换