SqlServerReader 插件文档

1 快速介绍

SqlServerReader插件实现了从SqlServer读取数据。在底层实现上，SqlServerReader通过JDBC连接远程SqlServer数据库，并执行相应的sql语句将数据从SqlServer库中SELECT出来。

2 实现原理

简而言之，SqlServerReader通过JDBC连接器连接到远程的SqlServer数据库，并根据用户配置的信息生成查询SELECT SQL语句并发送到远程SqlServer数据库，并将该SQL执行返回结果使用Addax自定义的数据类型拼装为抽象的数据集，并传递给下游Writer处理。

对于用户配置Table、Column、Where的信息，SqlServerReader将其拼接为SQL语句发送到SqlServer数据库；对于用户配置querySql信息，SqlServer直接将其发送到SqlServer数据库。

3 功能说明

3.1 配置样例

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

{
  "job": {
    "setting": {
      "speed": {
        "byte": -1,
        "channel": 1
      }
    },
    "content": [
      {
        "reader": {
          "name": "sqlserverreader",
          "parameter": {
            "username": "root",
            "password": "root",
            "column": [
              "*"
            ],
            "splitPk": "db_id",
            "connection": [
              {
                "table": [
                  "table"
                ],
                "jdbcUrl": [
                  "jdbc:sqlserver://localhost:3433;DatabaseName=dbname"
                ]
              }
            ]
          }
        },
        "writer": {
          "name": "streamwriter",
          "parameter": {
            "print": true,
            "encoding": "UTF-8"
          }
        }
      }
    ]
  }
}

3.2 参数说明

配置项	是否必须	默认值	描述
jdbcUrl	是	无	对端数据库的JDBC连接信息，jdbcUrl按照RDBMS官方规范，并可以填写连接附件控制信息
username	是	无	数据源的用户名
password	否	无	数据源指定用户名的密码
table	是	无	所选取的需要同步的表名,使用JSON数据格式，当配置为多张表时，用户自己需保证多张表是同一表结构
column	是	无	所配置的表中需要同步的列名集合，详细描述见rdbmsreader
splitPk	否	无	使用splitPk代表的字段进行数据分片，详细描述见rdbms
autoPk	否	false	是否自动猜测分片主键，3.2.6 版本引入
where	否	无	针对表的筛选条件
querySql	否	无	使用自定义的SQL而不是指定表来获取数据，当配置了这一项之后，Addax系统就会忽略 table，column这些配置项
fetchSize	否	1024	定义了插件和数据库服务器端每次批量数据获取条数，调高该值可能导致 Addax 出现OOM

3.3 类型转换

目前SqlServerReader支持大部分SqlServer类型，但也存在部分个别类型没有支持的情况，请注意检查你的类型。

下面列出SqlServerReader针对SqlServer类型转换列表:

Addax 内部类型	SqlServer 数据类型
Long	bigint, int, smallint, tinyint
Double	float, decimal, real, numeric
String	char,nchar,ntext,nvarchar,text,varchar,nvarchar(MAX),varchar(MAX)
Date	date, datetime, time
Boolean	bit
Bytes	binary,varbinary,varbinary(MAX),timestamp, image

请注意:

• 除上述罗列字段类型外，其他类型均不支持

• timestamp类型作为二进制类型