db2

package
v0.1.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 20, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

README

DB2Reader插件文档

快速介绍

DB2Reader插件实现了从DB2 LUW数据库读取数据。在底层实现上,DB2Reader通过github.com/ibmdb/go_ibm_db以及database/sql连接远程DB2 LUW数据库,并执行相应的sql语句将数据从DB2库中查询出来,这里和其他数据库不同的是由于db2未公开交互协议,db2的golang驱动利用db2的odbc库来连接数据库。

实现原理

DB2Reader通过github.com/ibmdb/go_ibm_db使用db2的odbc库连接远程DB2 LUW数据库,并根据用户配置的信息生成查询SQL语句,然后发送到远程DB2 LUW数据库,并将该SQL执行返回结果使用go-etl自定义的数据类型拼装为抽象的数据集,并传递给下游Writer处理。

DB2Reader通过使用dbmsreader中定义的查询流程调用go-etl自定义的storage/database的DBWrapper来实现具体的查询。DBWrapper封装了database/sql的众多接口,并且抽象出了数据库方言Dialect。其中DB2采取了storage/database/db2实现的Dialect。

功能说明

配置样例

配置一个从DB2数据库同步抽取数据到本地的作业:

{
    "job":{
        "content":[
            {
                "reader":{
                    "name": "db2reader",
                    "parameter": {
                        "connection":  {
                            "url": "HOSTNAME=127.0.0.1;PORT=50000;DATABASE=db",
                            "table": {
                                "schema":"SOURCE",
                                "name":"TEST"
                            }
                        },
                        "username": "user",
                        "password": "passwd",
                        "column": ["*"],
                        "split" : {
                            "key":"id"
                        },
                        "where": "",
                        "querySql":["select a,b from table_a join table_b on table_a.id = table_b.id"]
                    }
                }
            }
        ]
    }
}
参数说明
url
  • 描述 主要用于配置对端连接信息。基本配置格式:HOSTNAME=ip;PORT=port;DATABASE=db,ip代表db2数据库的IP地址和port端口,db表示要默认连接的数据库,和ibm db2的连接配置信息基本相同,只是将用户名和密码从连接配置信息提出,方便之后对这些信息加密。
  • 必选:是
  • 默认值: 无
username
  • 描述 主要用于配置db2数据库的用户
  • 必选:是
  • 默认值: 无
password
  • 描述 主要用于配置db2数据库的密码
  • 必选:是
  • 默认值: 无
table

描述db2表信息

schema
  • 描述 主要用于配置db2表的模式名
  • 必选:是
  • 默认值: 无
name
  • 描述 主要用于配置db2表的表名
  • 必选:是
  • 默认值: 无
split
key
  • 描述 主要用于配置db2表的切分键,切分键必须为bigInt/string/time类型,假设数据按切分键分布是均匀的
  • 必选:否
  • 默认值: 无
timeAccuracy
  • 描述 主要用于配置db2表的时间切分键,主要用于描述时间最小单位,day(日),min(分钟),s(秒),ms(毫秒),us(微秒),ns(纳秒),在range设置默认值是必须有值
  • 必选:否
  • 默认值: 无
range
type
  • 描述 主要用于配置db2表的切分键默认值类型,值为bigInt/string/time,这里会检查表切分键中的类型,请务必确保类型正确。
  • 必选:否
  • 默认值: 无
left
  • 描述 主要用于配置db2表的切分键默认最大值
  • 必选:否
  • 默认值: 无
right
  • 描述 主要用于配置db2表的切分键默认最小值
  • 必选:否
  • 默认值: 无
column
  • 描述:所配置的表中需要同步的列名集合,使用JSON的数组描述字段信息。用户使用*代表默认使用所有列配置,例如["*"]。

    支持列裁剪,即列可以挑选部分列进行导出。

    支持列换序,即列可以不按照表schema信息进行导出。

    支持常量配置,用户需要按照DB2 SQL语法格式: ["id", "table", "1", "'bazhen.csy'", "null", "left(a,10)", "2.3" , "true"] id为普通列名,table为包含保留在的列名,1为整形数字常量,'bazhen.csy'为字符串常量,null为空指针,left(a,10)为表达式,2.3为浮点数,true为布尔值。

  • 必选:是

  • 默认值: 无

where
  • 描述 主要用于配置select的where条件
  • 必选:否
  • 默认值: 无
querySql
  • 描述:在有些业务场景下,where这一配置项不足以描述所筛选的条件,用户可以通过该配置型来自定义筛选SQL。当用户配置了这一项之后,DataX系统就会忽略table,column这些配置型,直接使用这个配置项的内容对数据进行筛选,例如需要进行多表join后同步数据,使用select a,b from table_a join table_b on table_a.id = table_b.id 当用户配置querySql时,MysqlReader直接忽略table、column、where条件的配置,querySql优先级大于table、column、where选项。
  • 必选:否
  • 默认值:无
类型转换

目前 DB2Reader支持大部分 DB2类型,但也存在部分个别类型没有支持的情况,请注意检查你的类型。 下面列出DB2Reader针对 DB2类型转换列表:

go-etl的类型 DB2数据类型
bool BOOLEAN
bigInt BIGINT, INTEGER, SMALLINT
decimal DOUBLE, REAL, DECIMAL
string VARCHAR,CHAR
time DATE,TIME,TIMESTAMP
bytes BLOB,CLOB

性能报告

待测试

约束限制

数据库编码问题

目前仅支持utf8字符集

FAQ

1.如何配置db2的odbc库

  • 注意在linux下如Makefile所示export LD_LIBRARY_PATH=${DB2HOME}/lib
  • 注意在windows下如release.bat所示set path=%path%;%GOPATH%\src\github.com\ibmdb\go_ibm_db\clidriver\bin

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Job

type Job struct {
	*dbms.Job
}

Job 工作

type Reader

type Reader struct {
	// contains filtered or unexported fields
}

Reader 读取器

func (*Reader) Job

func (r *Reader) Job() spireader.Job

Job 工作

func (*Reader) ResourcesConfig

func (r *Reader) ResourcesConfig() *config.JSON

ResourcesConfig 插件资源配置

func (*Reader) Task

func (r *Reader) Task() spireader.Task

Task 任务

type Task

type Task struct {
	*dbms.Task
}

Task 任务

func (*Task) StartRead

func (t *Task) StartRead(ctx context.Context, sender plugin.RecordSender) (err error)

StartRead 开始读

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL