本文为您介绍RDBMS Reader支持的数据类型、字段映射和数据源等参数及配置示例。

注意 RDBMS Reader仅支持使用独享数据集成资源组,不支持使用默认资源组和自定义资源组

背景信息

RDBMS Reader插件从RDBMS读取数据。在底层实现上,RDBMS Reader通过JDBC连接远程RDBMS数据库,并执行相应的SQL语句,从RDBMS库中读取数据。目前RDBMS Reader支持读取DM、DB2、PPAS和Sybase等数据库的数据。RDBMS Reader是一个通用的关系数据库读插件,您可以通过注册数据库驱动等方式,增加任意多样的关系数据库读支持。

RDBMS Reader通过JDBC连接器连接至远程的RDBMS数据库,并根据您配置的信息生成查询SQL语句,发送至远程RDBMS数据库,执行该SQL并返回结果。然后使用数据同步自定义的数据类型拼装为抽象的数据集,传递给下游Writer处理:
  • 对于您配置的tablecolumnwhere等信息,RDBMS Reader将其拼接为SQL语句发送至RDBMS数据库。
  • 对于您配置的querySql信息,RDBMS直接将其发送至RDBMS数据库。

RDBMS Reader支持大部分通用的关系数据库数据类型,例如数字、字符等。但也存在部分类型没有支持的情况,请注意检查您的数据类型,根据具体的数据库进行选择。

参数说明

参数 描述 是否必选 默认值
jdbcUrl 描述的是到对端数据库的JDBC连接信息,jdbcUrl按照RDBMS官方规范,并可以填写连接附件控制信息。请注意不同的数据库JDBC的格式不同,数据集成会根据具体JDBC的格式选择合适的数据库驱动读取数据:
  • DM格式:jdbc:dm://ip:port/database
  • DB2格式:jdbc:db2://ip:port/database
  • PPAS格式:jdbc:edb://ip:port/database
RDBMS Reader可以通过以下方式增加新的数据库支持:
  • 进入RDBMS Reader对应目录,${DATAX_HOME}为数据集成主目录。
  • 在RDBMS Reader插件目录下有plugin.json配置文件,在此文件中注册您具体的数据库驱动,放在drivers数组中。RDBMS Reader插件在任务执行时会动态选择合适的数据库驱动连接数据库。
{
    "name": "rdbmsreader",
    "class": "com.alibaba.datax.plugin.reader.rdbmsreader.RdbmsReader",
    "description": "useScene: prod. mechanism: Jdbc connection using the database, execute select sql, retrieve data from the ResultSet. warn: The more you know about the database, the less problems you encounter.",
    "developer": "alibaba",
    "drivers": [
        "dm.jdbc.driver.DmDriver",
        "com.ibm.db2.jcc.DB2Driver",
        "com.sybase.jdbc3.jdbc.SybDriver",
        "com.edb.Driver"
    ]
}
```
- 在RDBMS Reader插件目录下有libs子目录,您需要将您具体的数据库驱动放到libs目录下。
```
$tree
.
|-- libs
|   |-- Dm7JdbcDriver16.jar
|   |-- commons-collections-3.0.jar
|   |-- commons-io-2.4.jar
|   |-- commons-lang3-3.3.2.jar
|   |-- commons-math3-3.1.1.jar
|   |-- datax-common-0.0.1-SNAPSHOT.jar
|   |-- datax-service-face-1.0.23-20160120.024328-1.jar
|   |-- db2jcc4.jar
|   |-- druid-1.0.15.jar
|   |-- edb-jdbc16.jar
|   |-- fastjson-1.1.46.sec01.jar
|   |-- guava-r05.jar
|   |-- hamcrest-core-1.3.jar
|   |-- jconn3-1.0.0-SNAPSHOT.jar
|   |-- logback-classic-1.0.13.jar
|   |-- logback-core-1.0.13.jar
|   |-- plugin-rdbms-util-0.0.1-SNAPSHOT.jar
|   `-- slf4j-api-1.7.10.jar
|-- plugin.json
|-- plugin_job_template.json
`-- rdbmsreader-0.0.1-SNAPSHOT.jar
username 数据源的用户名。
password 数据源指定用户名的密码。
table 所选取的需要同步的表。
column 所配置的表中需要同步的列名集合,使用JSON的数组描述字段信息,默认使用所有列配置,例如[ * ]:
  • 支持列裁剪,即列可以挑选部分列进行导出。
  • 支持列换序,即列可以不按照表schema信息顺序进行导出。
  • 支持常量配置,您需要按照JSON格式["id","1", "'bazhen.csy'", "null", "to_char(a + 1)", "2.3" , "true"]
    • id为普通列名。
    • 1为整型数字常量。
    • 'bazhen.csy'为字符串常量。
    • null为空指针。
    • to_char(a + 1)为函数表达式。
    • 2.3为浮点数。
    • true为布尔值。
  • column必须显示您指定同步的列集合,不允许为空 。
splitPk RDBMS Reader进行数据抽取时,如果指定splitPk,表示您希望使用splitPk代表的字段进行数据分片。数据同步系统会启动并发任务进行数据同步,以提高数据同步的效能:
  • 推荐splitPk用户使用表主键,因为表主键通常情况下比较均匀,切分出来的分片也不容易出现数据热点。
  • 目前splitPk仅支持整型数据切分,不支持浮点、字符串和日期等其他类型。如果您指定其他非支持类型,RDBMS Reader将报错。
  • 如果不填写splitPk,将视作您不对单表进行切分,RDBMS Reader使用单通道同步全量数据。
where 筛选条件,RDBMS Reader根据指定的columntablewhere条件拼接SQL,并根据该SQL进行数据抽取。例如在做测试时,可以将where条件指定为limit 10。
在实际业务场景中,通常会选择当天的数据进行同步,可以将where条件指定为gmt_create>$bizdate
  • where条件可以有效地进行业务增量同步。
  • where条件不配置或为空时,则视作全表同步数据。
querySql 在部分业务场景中,where配置项不足以描述所筛选的条件,您可以通过该配置型来自定义筛选SQL。当您配置该项后,数据同步系统会忽略columntable等配置,直接使用该配置项的内容对数据进行筛选。

例如,需要进行多表join后同步数据,使用select a,b from table_a join table_b on table_a.id = table_b.id 。当您配置querySql时,RDBMS Reader直接忽略columntablewhere条件的配置。

fetchSize 该配置项定义了插件和数据库服务器端每次批量数据获取条数,该值决定了数据同步系统和服务器端的网络交互次数,能够提升数据抽取性能。
说明 fetchSize值过大(>2048)可能造成数据同步进程OOM。
1,024

向导开发介绍

暂不支持向导开发模式。

脚本开发介绍

配置一个从RDBMS数据库同步抽取数据作业,使用脚本模式开发的详情请参见通过脚本模式配置任务
{
    "order": {
        "hops": [
            {
                "from": "Reader",
                "to": "Writer"
            }
        ]
    },
    "setting": {
        "errorLimit": {
            "record": "0"
        },
        "speed": {
            "concurrent": 1,
            "throttle": false
        }
    },
    "steps": [
        {
            "category": "reader",
            "name": "Reader",
            "parameter": {
                "connection": [
                    {
                        "jdbcUrl": [
                            "jdbc:dm://ip:port/database"
                        ],
                        "table": [
                            "table"
                        ]
                    }
                ],
                "username": "username",
                "password": "password",
                "table": "table",
                "column": [
                    "*"
                ],
                "preSql": [
                    "delete from XXX;"
                ]
            },
            "stepType": "rdbms"
        },
        {
            "category": "writer",
            "name": "Writer",
            "parameter": {},
            "stepType": "stream"
        }
    ],
    "type": "job",
    "version": "2.0"
}