You need to enable JavaScript to run this app.
导航
配置 GaussDB 数据源
最近更新时间:2023.10.24 10:38:36首次发布时间:2023.10.24 10:38:36

GaussDB 数据源为您提供读取 GaussDB 数据的单向通道能力,实现将读取出来的数据,写入到不同的目标数据源中。
本文为您介绍 DataSail 的 GaussDB 数据同步的能力支持情况。

1 支持的 GaussDB 版本

  • 离线读:

    支持自建 GaussDB 数据库,支持 3.x 版本。

2 使用限制

  1. 当前仅支持离线读 GaussDB 数据,后续敬请期待离线写 GaussDB 能力。

  2. 子账号新建数据源时,需要有项目的管理员角色,方可以进行新建数据源操作。各角色对应权限说明,详见:管理成员

3 通用要求

确保同步任务使用的独享集成资源组,具有 GaussDB 数据库节点的网络访问能力,您需将独享集成资源组和数据库节点网络打通,不同网络方案操作详见网络连通解决方案

  • 若通过 VPC 网络访问,则独享集成资源组所在 VPC 中的 IPv4 CIDR 地址,需加入到 GaussDB 访问白名单中:

    1. 确认集成资源组所在的 VPC:

    2. 查看 VPC 的 IPv4 CIDR 地址:

      注意

      若考虑安全因素,减少 IP CIDR 的访问范围,您至少需要将集成资源组绑定的子网下的 IPv4 CIDR 地址加入到数据库白名单中。

    3. 将获取到的 IPv4 CIDR 地址添加进 GaussDB 数据库白名单中。

  • 若是通过公网形式访问 GaussDB 数据库,则您需进行以下操作:

    • 独享集成资源组开通公网访问能力,操作详见开通公网

    • 并将公网 IP 地址,添加进 GaussDB 数据库白名单中。

4 支持的字段类型

当前主要字段支持情况如下。

字段类型离线读(GaussDB Reader)
BOOL支持
BOOLEAN支持
TINYINT支持
INT支持
INTEGER支持
BIGINT支持
INT1支持
INT2支持
INT4支持
INT8支持
INT16支持
BINARY_INTEGER支持
SMALLSERIAL支持
SERIAL支持
BIGSERIAL支持
LARGESERIAL支持
DECIMAL支持
NUMBER支持
NUMERIC支持
FLOAT支持
DOUBLE支持
MONEY支持
FLOAT4支持
FLOAT8支持
BINARY_DOUBLE支持
DOUBLE PRECISION支持
DEC支持
REAL支持
CHAR支持
CHARACTER支持
CHARACTER VARYING支持
BPCHAR支持
NCHAR支持
VARCHAR支持
VARCHAR2支持
NVARCHAR2支持
TEXT支持
CLOB支持
BLOB支持
BIT支持
VARBIT支持
JSON支持
JSONB支持
XML支持
RAW支持
BYTEA支持
DATE支持
TIME支持
TIMETZ支持
SMALLDATETIME支持
TIMESTAMP支持
TIMESTAMPTZ支持
ABSTIME支持
INTERVAL支持

5 数据同步任务开发

5.1 数据源注册

新建数据源操作详见配置数据源,下面为您介绍用连接串方式配置 GaussDB 数据源信息:

注意

GaussDB 侧如果是白名单访问机制,则不同网络环境的连接串地址,需要添加不同的 IP 地址到数据库白名单中,确保集成资源组使用的 VPC 与 GaussDB 网络能互通:

  • 如果使用的是公网连接串访问,则需要给集成资源组添加公网 IP,并将公网 IP 地址加入到白名单中。
  • 如果使用的是私网连接串访问,则需要将资源组 VPC 下的 IPv4 CIDR 地址加入到白名单中。

详见网络连通解决方案

参数说明
基本配置
数据源类型GaussDB
接入方式连接串
数据源名称数据源的名称,可自行设置,仅支持中文,英文,数字,“_”,100个字符以内。
参数配置
JDBC URL填写连接 GaussDB 数据库的 JDBC 地址信息。
用户名有权限访问数据库的用户名信息。
密码输入用户名对应的密码信息。

5.2 新建离线任务

OceanBase 数据源测试连通性成功后,进入到数据开发界面,开始新建 GaussDB 相关通道任务。
新建任务方式详见离线数据同步

5.3 可视化配置说明

任务创建成功后,您可根据实际场景,配置 GaussDB 离线读通道任务。

5.3.1 GaussDB 离线读

数据来源选择 GaussDB,并完成以下相关参数配置:
其中参数名称前带 * 的为必填参数,名称前未带 * 的为可选填参数。

参数
说明
*数据源类型下拉选择 GaussDB 数据源类型。

*数据源名称

已在数据源管理中注册成功的 GaussDB 数据源,下拉可选。
若还未建立相应数据源,可单击数据源管理按钮,前往创建 GaussDB 数据源。

*Schema 名称数据库下已有的 Schema 目录信息,下拉可选。
*数据表选择需要采集的数据表名称信息,目前单个任务只支持将单表的数据采集到一个目标表中。

数据过滤

支持您将需要同步的数据进行筛选条件设置,只同步符合过滤条件的数据,可直接填写关键词 where 后的过滤 SQL 语句,例如:create_time > '${date}',不需要填写 where 关键字。
语句填写完成后,您可单击右侧的校验按钮,进行过滤语句校验。

说明

该过滤语句通常用作增量同步,暂时不支持 limit 关键字过滤,其 SQL 语法需要和选择的数据源类型对应。

切分建

根据配置的字段进行数据分片,建议使用主键或有索引的列作为切分键:

  • 如果表没有主键或者索引列,可以不配置该字段,同步任务不会进行分片,并以单并发的方式同步所有的数据;

  • 建议使用主键或有索引的列作为切分键,切分键配置没有索引的列同步任务会比较慢;

说明

目前仅支持类型为整型或字符串的字段作为切分建。

5.3.2 字段映射

数据来源和目标端配置完成后,需要指定来源和目标端的字段映射关系,根据字段映射关系,数据集成任务将源端字段中的数据,写入到目标端对应字段中。
您可通过以下三种方式操作字段映射关系:

  • 自动添加:单击自动添加按钮,根据两端数据表信息,可以自动填充来源和目标的字段信息。

  • 手动添加:单击手动添加按钮,可以手动编辑来源和目标的字段信息,可以逐个添加。

  • 移动\删除字段:您也可以根据需要移动字段映射顺序或删除字段。

5.4 DSL 配置说明

GaussDB 数据源支持使用脚本模式(DSL)的方式进行配置。
在某些复杂场景下,或当数据源类型暂不支持可视化配置时,您可通过任务脚本的方式,按照统一的 Json 格式,编写 GaussDB Reader 参数脚本代码,来运行数据集成任务。

5.4.1 进入 DSL 模式

进入 DSL 模式操作流程,可详见 MySQL 数据源-4.4.1 进入DSL 模式

5.4.2 GaussDB Reader

进入 DSL 模式编辑界面后,您可根据实际情况替换相应参数,GaussDB Reader脚本示例如下:

// 变量使用规则如下:
// 1.自定义参数变量: {{}}, 比如{{number}}
// 2.系统时间变量${}, 比如 ${date}、${hour}
// **************************************
{
    // [required] dsl version, suggest to use latest version
    "version": "0.2",
    // [required] execution mode, supoort streaming / batch now
    "type": "batch",
    // reader config
    "reader": {
        // [required] datasource type
        "type": "gaussdb",
        // [optional] datasource id, set it if you have registered datasource
        "datasource_id": 12345,
        // [required] user parameter
        "parameter": {
            // ********** please write here **********
            // "key" : value
            "columns": [
                {
                    "name": "name_sample",
                    "type": "type_sample"
                }
            ],
            "filter": "id > 10",
            "split_pk": "split_pk_sample",
            "table_schema":"public",
            "table_name": "table_name_sample"
        }
    },
    // writer config
    "writer": {
    },
    // common config
    "common": {
        // [required] user parameter
        "parameter": {
            // ********** please write here **********
            // "key" : value
        }
    }
}

Reader 参数说明,其中参数名称前带 * 的为必填参数,名称前未带 * 的为可选填参数:

参数名描述默认值
*type数据源类型,输入 gaussdb 类型的 Reader type,默认固定值填写:gaussdb
*datasource_id注册的 gaussdb 数据源 ID,数据源 ID 可以在数据源管理界面查找
*table_schema填写 GaussDB 数据库中的 Schema 名称。
*table_name填写需要同步的数据表名称。

filter

同步数据的筛选条件,同步数据时只会同步符合过滤条件的数据,直接填写关键词 where 后的过滤 SQL 语句。

  • 如将过滤条件指定为:date>=${date} ,表示只同步 date 大于等于 ${date}。

  • 过滤条件可以有效地进行业务增量同步。如果不配置,默认会同步全量数据。

split_pk

根据配置的字段进行数据分片,建议使用主键或有索引的列作为切分键,同步任务会启动并发任务进行数据同步,提高同步速率:

  • 如果表没有主键或者索引列,可以不配置该字段,同步任务不会进行分片,并以单并发的方式同步所有的数据;

  • 建议使用主键或有索引的列作为切分键,切分键配置没有索引的列同步任务会比较慢;

说明

目前仅支持类型为整型或字符串的字段作为切分建。

*columns

所配置的表中需要同步的列名集合,使用 JSON 的数组描述字段信息。

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

  • 支持列换序:列可以不按照表 Schema 信息顺序进行导出。

  • Column 必须显示指定同步的列集合,不允许为空。

5.5 高级参数说明

  • 对于可视化通道任务,读参数可在任务运行参数 > 自定义参数设置中配置,如下图所示:

  • 对于 DSL 任务,读参数请配置到 reader.parameter 下,直接输入参数名称和参数值。如下图所示:

5.5.1 GaussDB 离线读常见参数

参数名描述默认值
init_sql读取数据前执行的 SQL 语句。对于视图的查询可能需要使用 init SQL 语句初始化环境。
reader_fetch_size每次拉取的数据条数,只在准确分片中有效。10000

shard_split_mode

分片模式,支持准确分片、并发分片、不分片三种模式:

  • 准确分片(默认):根据配置的分片键将数据拆分为不同的区间,除下最后一个区间外,每个区间精准的有 reader_fetch_size 条数。

    • 拉取数据量很大的表或者分片键不是主键或者索引键时,该分片模式分片时间会比较长;

    • 该分片模式支持分片键为整型数据类型和字符串数据类型;

    • 配置方式:将该参数配置为 accurate

  • 并发分片:根据表的最大最小值,将所有的数据按照并发数进行区间分片。

    • 该分片模式仅支持分片键为整型数据类型;

    • 配置方式:将该参数配置为 parallelism

  • 不分片:不进行分片,适用于没有主键、索引键的表

    • 配置方式:将该参数配置为 nosplit 或者不配置 split_pk

准确分片

customized_sql

自定义查询读取 SQL 语句中。filter 过滤配置项不足以描述所筛选的条件,通过该配置型来自定义筛选SQL。
配置该项后,数据同步系统会忽略 table_name、column 、split_pk 、shard_split_mode 配置项,直接使用该项配置的内容对数据进行筛选。
例如:需要进行多表 join 后同步数据,使用select a,b from table_a join table_b on table_a.id = table_b.id