HDFS Reader

HDFS Reader 提供了读取分布式文件系统 Hadoop HDFS 数据存储的能力。

目前 HdfsReader 支持的文件格式如下：

• textfile（text）
• orcfile（orc）
• rcfile（rc）
• sequence file（seq）
• Csv(csv)
• parquet

功能与限制

1. 支持 textfile, orcfile, parquet, rcfile, sequence file 和 csv 格式的文件，且要求文件内容存放的是一张逻辑意义上的二维表。
2. 支持多种类型数据读取(使用 String 表示)，支持列裁剪，支持列常量
3. 支持递归读取、支持正则表达式（*和 ?）。
4. 支持常见的压缩算法，包括 GZIP， SNAPPY， ZLIB 等。
5. 多个 File 可以支持并发读取。
6. 支持 sequence file 数据压缩，目前支持 lzo 压缩方式。
7. csv 类型支持压缩格式有：gzip、bz2、zip、lzo、lzo_deflate、snappy。
8. 目前插件中 Hive 版本为 3.1.1，Hadoop 版本为3.1.1, 在 Hadoop 2.7.x, Hadoop 3.1.x 和 Hive 2.x, hive 3.1.x 测试环境中写入正常；其它版本理论上都支持，但在生产环境使用前，请进一步测试；
9. 支持kerberos 认证

配置样例

{
  "job": {
    "setting": {
      "speed": {
        "channel": 3,
        "bytes": -1
      }
    },
    "content": {
      "reader": {
        "name": "hdfsreader",
        "parameter": {
          "path": "/user/hive/warehouse/mytable01/*",
          "defaultFS": "hdfs://xxx:port",
          "column": [
            {
              "index": 0,
              "type": "long"
            },
            {
              "index": 1,
              "type": "boolean"
            },
            {
              "type": "string",
              "value": "hello"
            },
            {
              "index": 2,
              "type": "double"
            }
          ],
          "fileType": "orc",
          "encoding": "UTF-8",
          "fieldDelimiter": ","
        }
      },
      "writer": {
        "name": "streamwriter",
        "parameter": {
          "print": true
        }
      }
    }
  }
}

配置项说明

配置项	是否必须	数据类型	默认值	说明
path	是	string	无	要读取的文件路径
defaultFS	是	string	无	HDFS NAMENODE 节点地址，如果配置了 HA 模式，则为 defaultFS 的值
fileType	是	string	无	文件的类型
column	是	list<map>	无	读取字段列表
fieldDelimiter	否	char	,	指定文本文件的字段分隔符，二进制文件不需要指定该项
encoding	否	string	utf-8	读取文件的编码配置， 目前仅支持 utf-8
nullFormat	否	string	无	可以表示为空的字符，如果用户配置: "\\N" ，那么如果源头数据是 "\N" ，视作 null 字段
haveKerberos	否	boolean	无	是否启用 Kerberos 认证，如果启用，则需要同时配置下面两项
kerberosKeytabFilePath	否	string	无	Kerberos 认证的凭证文件路径, 比如 /your/path/addax.service.keytab
kerberosPrincipal	否	string	无	Kerberos 认证的凭证主体, 比如 addax/node1@WGZHAO.COM
compress	否	string	无	指定要读取的文件的压缩格式
hadoopConfig	否	map	无	里可以配置与 Hadoop 相关的一些高级参数，比如 HA 的配置

path

要读取的文件路径，如果要读取多个文件，可以使用正则表达式 *，注意这里可以支持填写多个路径：

1. 当指定单个 Hdfs 文件，HdfsReader 暂时只能使用单线程进行数据抽取。二期考虑在非压缩文件情况下针对单个 File 可以进行多线程并发读取。
2. 当指定多个 Hdfs 文件，HdfsReader 支持使用多线程进行数据抽取。线程并发数通过通道数指定。
3. 当指定通配符，HdfsReader 尝试遍历出多个文件信息。例如: 指定 /* 代表读取 / 目录下所有的文件，指定 /bazhen/* 代表读取 bazhen 目录下游所有的文件。HdfsReader 目前只支持 *和 ? 作为文件通配符。

特别需要注意的是，Addax 会将一个作业下同步的所有的文件视作同一张数据表。用户必须自己保证所有的 File 能够适配同一套 schema 信息。并且提供给 Addax 权限可读。

fileType

描述：文件的类型，目前只支持用户配置为

• text 表示 textfile 文件格式
• orc 表示 orcfile 文件格式
• rc 表示 rcfile 文件格式
• seq 表示 sequence file 文件格式
• csv 表示普通 hdfs 文件格式（逻辑二维表）
• parquet 表示 parquet 文件格式

特别需要注意的是，HdfsReader 能够自动识别文件是 orcfile、textfile 或者还是其它类型的文件，但该项是必填项，HdfsReader 则会只读取用户配置的类型的文件，忽略路径下其他格式的文件

另外需要注意的是，由于 textfile 和 orcfile 是两种完全不同的文件格式，所以 HdfsReader 对这两种文件的解析方式也存在差异，这种差异导致 hive 支持的复杂复合类型(比如 map,array,struct,union)在转换为支持的 String 类型时，转换的结果格式略有差异，比如以 map 类型为例：

• orcfile: map 类型转换成 string 类型后，结果为 {job=80, team=60, person=70}

• textfile: map 类型转换成 string 类型后，结果为 job:80,team:60,person:70

从上面的转换结果可以看出，数据本身没有变化，但是表示的格式略有差异，所以如果用户配置的文件路径中要同步的字段在 Hive 中是复合类型的话，建议配置统一的文件格式。

如果需要统一复合类型解析出来的格式，我们建议用户在 hive 客户端将 textfile 格式的表导成 orcfile 格式的表

column

读取字段列表，type 指定源数据的类型，index 指定当前列来自于文本第几列(以 0 开始)，value 指定当前类型为常量，不从源头文件读取数据，而是根据 value 值自动生成对应的列。

默认情况下，用户可以全部按照 String 类型读取数据，配置如下：

{
  "column": ["*"]
}

用户可以指定 Column 字段信息，配置如下：

[
  {
    "type": "long",
    "index": 0,
    "description": "从本地文件文本第一列获取int字段"
  },
  {
    "type": "string",
    "value": "addax",
    "description": "HdfsReader内部生成alibaba的字符串字段作为当前字段"
  }
]

对于用户指定 Column 信息，type 必须填写，index/value 必须选择其一。

compress

当 fileType（文件类型）为 csv 下的文件压缩方式，目前仅支持 gzip、bz2、zip、lzo、lzo_deflate、hadoop-snappy、framing-snappy 压缩； 值得注意的是，lzo 存在两种压缩格式：lzo 和 lzo_deflate，用户在配置的时候需要留心，不要配错了；

另外，由于 snappy 目前没有统一的 stream format，addax 目前只支持最主流的两种：hadoop-snappy（hadoop 上的 snappy stream format） 和 framing-snappy（google 建议的 snappy stream format）;

hadoopConfig

hadoopConfig 里可以配置与 Hadoop 相关的一些高级参数，比如 HA 的配置

{
  "hadoopConfig": {
    "dfs.nameservices": "cluster",
    "dfs.ha.namenodes.cluster": "nn1,nn2",
    "dfs.namenode.rpc-address.cluster.nn1": "node1.example.com:8020",
    "dfs.namenode.rpc-address.cluster.nn2": "node2.example.com:8020",
    "dfs.client.failover.proxy.provider.cluster": "org.apache.hadoop.hdfs.server.namenode.ha.ConfiguredFailoverProxyProvider"
  }
}

这里的 cluster 表示 HDFS 配置成 HA 时的名字，也是 defaultFS 配置项中的名字 如果实际环境中的名字不是 cluster ，则上述配置中所有写有 cluster 都需要替换

csvReaderConfig

读取 CSV 类型文件参数配置，Map 类型。读取 CSV 类型文件使用的 CsvReader 进行读取，会有很多配置，不配置则使用默认值。

常见配置：

{
  "csvReaderConfig": {
    "safetySwitch": false,
    "skipEmptyRecords": false,
    "useTextQualifier": false
  }
}

所有配置项及默认值,配置时 csvReaderConfig 的 map 中请 严格按照以下字段名字进行配置：

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;

类型转换

Addax 内部类型	Hive 表 数据类型
Long	TINYINT, SMALLINT, INT, BIGINT
Double	FLOAT, DOUBLE
String	String, CHAR, VARCHAR, STRUCT, MAP, ARRAY, UNION, BINARY
Boolean	BOOLEAN
Date	Date, TIMESTAMP
Bytes	BINARY

其中：

• Long 是指 Hdfs 文件文本中使用整形的字符串表示形式，例如 123456789
• Double 是指 Hdfs 文件文本中使用 Double 的字符串表示形式，例如 3.1415
• Boolean 是指 Hdfs 文件文本中使用 Boolean 的字符串表示形式，例如 true、false。不区分大小写。
• Date 是指 Hdfs 文件文本中使用 Date 的字符串表示形式，例如 2014-12-31
• Bytes 是指 HDFS 文件中使用二进制存储的内容，比如一张图片的数据

特别提醒：

• Hive 支持的数据类型 TIMESTAMP 可以精确到纳秒级别，所以 textfile、orcfile 中 TIMESTAMP 存放的数据类似于 2015-08-21 22:40:47.397898389， 如果转换的类型配置为 Addax 的 Date，转换之后会导致纳秒部分丢失，所以如果需要保留纳秒部分的数据，请配置转换类型为 String 类型。

FAQ

Q: 如果报 java.io.IOException: Maximum column length of 100,000 exceeded in column...异常信息，说明数据源 column 字段长度超过了 100000 字符。

A: 需要在 json 的 reader 里增加如下配置

{
  "csvReaderConfig": {
    "safetySwitch": false,
    "skipEmptyRecords": false,
    "useTextQualifier": false
  }
}

safetySwitch = false 表示单列长度不限制 100000 字符