DataX OSSReader 说明

  • 2021-02-02
  • 浏览 (30)

DataX OSSReader 说明


1 快速介绍

OSSReader提供了读取OSS数据存储的能力。在底层实现上,OSSReader使用OSS官方Java SDK获取OSS数据,并转换为DataX传输协议传递给Writer。

2 功能与限制

OSSReader实现了从OSS读取数据并转为DataX协议的功能,OSS本身是无结构化数据存储,对于DataX而言,OSSReader实现上类比TxtFileReader,有诸多相似之处。目前OSSReader支持功能如下:

  1. 支持且仅支持读取TXT的文件,且要求TXT中shema为一张二维表。

  2. 支持类CSV格式文件,自定义分隔符。

  3. 支持多种类型数据读取(使用String表示),支持列裁剪,支持列常量

  4. 支持递归读取、支持文件名过滤。

  5. 支持文本压缩,现有压缩格式为zip、gzip、bzip2。注意,一个压缩包不允许多文件打包压缩。

  6. 多个object可以支持并发读取。

我们暂时不能做到:

  1. 单个Object(File)支持多线程并发读取,这里涉及到单个Object内部切分算法。二期考虑支持。

  2. 单个Object在压缩情况下,从技术上无法支持多线程并发读取。

3 功能说明

3.1 配置样例

{
    "job": {
        "setting": {},
        "content": [
            {
                "reader": {
                    "name": "ossreader",
                    "parameter": {
                        "endpoint": "http://oss.aliyuncs.com",
                        "accessId": "",
                        "accessKey": "",
                        "bucket": "myBucket",
                        "object": [
                            "bazhen/*"
                        ],
                        "column": [
                            {
                                "type": "long",
                                "index": 0
                            },
                            {
                                "type": "string",
                                "value": "alibaba"
                            },
                            {
                                "type": "date",
                                "index": 1,
                                "format": "yyyy-MM-dd"
                            }
                        ],
                        "encoding": "UTF-8",
                        "fieldDelimiter": "\t",
                        "compress": "gzip"
                    }
                },
                "writer": {}
            }
        ]
    }
}

3.2 参数说明

  • endpoint

  • accessId

    • 描述:OSS的accessId

    • 必选:是

    • 默认值:无

  • accessKey

    • 描述:OSS的accessKey

    • 必选:是

    • 默认值:无

  • bucket

    • 描述:OSS的bucket

    • 必选:是

    • 默认值:无

  • object

    • 描述:OSS的object信息,注意这里可以支持填写多个Object。

      当指定单个OSS Object,OSSReader暂时只能使用单线程进行数据抽取。二期考虑在非压缩文件情况下针对单个Object可以进行多线程并发读取。

      当指定多个OSS Object,OSSReader支持使用多线程进行数据抽取。线程并发数通过通道数指定。

      当指定通配符,OSSReader尝试遍历出多个Object信息。例如: 指定/*代表读取bucket下游所有的Object,指定/bazhen/*代表读取bazhen目录下游所有的Object。

      特别需要注意的是,DataX会将一个作业下同步的所有Object视作同一张数据表。用户必须自己保证所有的Object能够适配同一套schema信息。

    • 必选:是

    • 默认值:无

  • column

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

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

      	"column": ["*"]
      

      用户可以指定Column字段信息,配置如下:

      {
         "type": "long",
         "index": 0    //从OSS文本第一列获取int字段
      },
      {
         "type": "string",
         "value": "alibaba"  //从OSSReader内部生成alibaba的字符串字段作为当前字段
      }
      

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

    • 必选:是

    • 默认值:全部按照string类型读取

  • fieldDelimiter

    • 描述:读取的字段分隔符

    • 必选:是

    • 默认值:,

  • compress

    • 描述:文本压缩类型,默认不填写意味着没有压缩。支持压缩类型为zip、gzip、bzip2。

    • 必选:否

    • 默认值:不压缩

  • encoding

    • 描述:读取文件的编码配置,目前只支持utf-8/gbk。

* 必选:否

* 默认值:utf-8

  • nullFormat

    • 描述:文本文件中无法使用标准字符串定义null(空指针),DataX提供nullFormat定义哪些字符串可以表示为null。

      例如如果用户配置: nullFormat=“\N”,那么如果源头数据是”\N”,DataX视作null字段。

* 必选:否

* 默认值:\N

  • skipHeader

    • 描述:类CSV格式文件可能存在表头为标题情况,需要跳过。默认不跳过。

* 必选:否

* 默认值:false

  • 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;

3.3 类型转换

OSS本身不提供数据类型,该类型是DataX OSSReader定义:

DataX 内部类型 OSS 数据类型
Long Long
Double Double
String String
Boolean Boolean
Date Date

其中:

  • OSS Long是指OSS文本中使用整形的字符串表示形式,例如”19901219”。
  • OSS Double是指OSS文本中使用Double的字符串表示形式,例如”3.1415”。
  • OSS Boolean是指OSS文本中使用Boolean的字符串表示形式,例如”true”、”false”。不区分大小写。
  • OSS Date是指OSS文本中使用Date的字符串表示形式,例如”2014-12-31”,Date可以指定format格式。

4 性能报告

并发数 DataX 流量 Datax 记录数
1 971.40KB/s 10047rec/s
2 1.81MB/s 19181rec/s
4 3.46MB/s 36695rec/s
8 6.57MB/s 69289 records/s
16 7.92MB/s 83920 records/s
32 7.87MB/s 83350 records/s

5 约束限制

6 FAQ