You need to enable JavaScript to run this app.
导航

配置 Oracle 数据源

最近更新时间2023.11.24 14:46:20

首次发布时间2022.09.15 17:46:56

Oracle 数据源为您提供读取和写入 Oracle 的双向通道数据集成能力,实现不同数据源与 Oracle 之间的数据传输场景。
本文为您介绍 DataSail 的 Oracle 数据同步的能力支持情况。

1 支持的 Oracle 版本

  • 离线读写

    版本离线读(Oracle Reader)离线写(Oracle Writer)
    Oracle 11.2 or 11gR2支持支持
    Oracle 12.1 or 12cR1支持支持
    Oracle 12.2 or 12cR2支持(新版本特性不支持)支持(新版本特性不支持)
    Oracle 18.3支持(新版本特性不支持)支持(新版本特性不支持)
    Oracle 19.x支持(新版本特性不支持)支持(新版本特性不支持)
    Oracle 21.1支持(新版本特性不支持)支持(新版本特性不支持)

说明

Oracle 离线读写插件使用 ojdbc8-12.2.0.1.jar 驱动。

2 使用前提

  1. 确保同步任务使用的独享数据集成资源组,具有 Oracle 数据库节点的网络访问能力。详见网络连通解决方案

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

3 支持的字段类型

  • 当前主要字段类型支持情况如下

    字段类型离线读(Oracle Reader)离线写(Oracle Writer)
    NUMBER支持支持
    NUMERIC支持支持
    REAL支持支持
    BIT支持支持
    BOOL支持支持
    BINARY_FLOAT支持支持
    BINARY_DOUBLE支持支持
    DOUBLE PRECISION支持支持
    CHAR支持支持
    NCHAR支持支持
    VARCHAR2支持支持
    NVARCHAR2支持支持
    DATE支持支持
    TIMESTAMP支持支持
    TIMESTAMP WITH TIME ZONE支持支持
    TIMESTAMP WITH LOCAL TIME ZONE支持支持
    DATETIME支持支持
    CLOB支持支持
    BLOB支持支持
    RAW支持支持
    ROWID支持支持
    UROWID支持支持
    FLOAT支持支持
    INTERVAL DAY支持不支持
    INTERVAL YEAR支持不支持
    BFILE支持支持
    LONG支持支持
    LONG RAW支持支持
    NCLOB支持支持
    STRUCT不支持不支持
    User-Defined Types不支持不支持
    AnyType不支持不支持
    AnyData不支持不支持
    AnyDataSet不支持不支持
    XmlType支持支持
    Spatial Types不支持不支持
    Media Types不支持不支持
  • Oracle 读针对 Oracle 类型的转换列表,如下所示:

    类型分类Oracle 数据类型
    整数类INTEGER、INT和SMALLINT
    浮点类NUMBER、NUMERIC、DECIMAL、FLOAT、DOUBLE PRECISIOON、REAL、BINARY_FLOAT、BINARY_DOUBLE、DEC
    字符串类LONG、CHAR、NCHAR、VARCHAR、VARCHAR2、NVARCHAR2、CLOB、NCLOB、CHARACTER、CHARACTER VARYING、CHAR VARYING、NATIONAL CHARACTER、NATIONAL CHAR、NATIONAL CHARACTER VARYING、NATIONAL CHAR VARYING、NCHAR VARYING、ROWID、UROWID、XMLTYPE
    日期时间类TIMESTAMP、DATE、TIMESTAMP WITH TIME ZONE、TIMESTAMP WITH LOCAL TIME ZONE、DATETIME
    布尔型BIT和BOOL
    二进制类BLOB、BFILE、RAW和LONG RAW

4 数据同步任务开发

4.1 数据源注册

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

注意

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

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

详见网络连通解决方案

参数说明
基本配置
数据源类型Oracle
接入方式连接串
数据源名称数据源的名称,可自行设置,仅支持中文,英文,数字,“_”,100个字符以内。
参数配置
主机名或IP地址Oracle 数据库的主机名称或者 IP 地址。
端口连接主机的端口号。

连接方式

下拉选择 Oracle 数据库的连接方式:

  • SID:Oracle 实例的唯一名称
  • Service Name:Oracle 一个实例或者多个实例的连接别名
数据库名输入已创建的 Oracle 数据库名称。
用户名有权限访问数据库的用户名信息。
密码输入用户名对应的密码信息。

4.2 新建任务

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

4.3 可视化配置说明

任务创建成功后,您可根据实际场景,配置Oracle 批式读、Oracle 批式写或 Oracle 流式写等通道任务。

4.3.1 Oracle 批式读

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

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

*数据源名称

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

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

数据过滤

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

说明

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

切分建

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

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

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

说明

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

4.3.2 Oracle 批式写

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

参数说明
*目标类型数据去向目标类型选择 Oracle。

*数据源名称

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

*Schema 目录数据库下已有的 Schema 目录信息,下拉可选。
*数据表数据源下所属需数据写入的表名,下拉可选。

写入前准备语句

在执行该数据集成任务前,需要率先执行的 SQL 语句,通常是为了使任务重跑时支持幂等。
例如您可以通过填写语句,清空表中的某些旧数据,清空完成后,再执行集成任务写入新的数据。如删除 date='${date}' 的数据:delete from table_name where date='${date}'
语句填写完成后,您可单击右侧的校验按钮,进行语句校验是否符合逻辑。

说明

可视化通道任务配置中只允许执行一条写入前准备语句。

写入后准备语句

执行数据同步任务之后执行的 SQL 语句。例如写入完成后插入某条特殊的数据,标志导入任务执行结束。
语句填写完成后,您可单击右侧的校验按钮,进行语句校验是否符合逻辑。

说明

可视化通道任务配置中只允许执行一条写入后准备语句。

*数据写入方式

下拉选择数据写入 Oracle 的方式:

  • insert into: 当主键/唯一性索引冲突时会无法写入冲突的行,任务会运行失败。

说明

如果希望主键/唯一索引冲突时任务正常执行可以添加高级参数: job.writer.is_insert_ignoretrue

4.3.3 Oracle 流式写

支持可视化方式配置流式写入 Oracle 单表。Oracle Writer 通过 JDBC 远程连接 Oracle 数据库,并执行相应的 SQL 语句,将数据写入Oracle。流式写入 Oracle 配置方式如下:

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

参数说明
*目标类型数据去向目标类型选择 Oracle。

*数据源名称

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

*Schema 目录数据库下已有的 Schema 目录信息,下拉可选。
*数据表数据源下所属需数据写入的表名,下拉可选。

4.3.4 字段映射

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

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

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

    说明

    来源端字段信息支持输入数据库函数和常量配置,单击手动添加按钮,在源表字段中输入需添加的值,并选择函数或常量类型,例如:

    • 函数:支持您输入 now()、current_timestamp() 等 Oracle 数据库支持的函数。

    • 常量:您可自定义输入常量值,'123'、'${DATE}'、'${hour}' 等,输入值两侧需要加上英文单引号,支持结合时间变量参数使用。

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

4.4 DSL 配置说明

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

4.4.1 进入 DSL 模式

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

4.4.2 Oracle 批式读

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

// 变量使用规则如下:
// 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": "oracle",
        // [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":"table_schema",
            "table_name": "table_name_sample"
        }
    },
    // writer config
    "writer": {
    },
    // common config
    "common": {
        // [required] user parameter
        "parameter": {
            // ********** please write here **********
            // "key" : value
        }
    }
}

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

参数名
描述默认值
*type数据源类型,对于 Oracle 类型,填写:oracle
*datasource_id注册的 Oracle 数据源 ID。可以在项目控制台 > 数据源管理界面中查找。
*table_schema填写 Oracle 数据库中的 Schema 名称。
*table_name需要同步的数据表名称,目前单个任务只支持将单表的数据采集到一个目标表中。

filter

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

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

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

split_pk

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

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

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

说明

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

*columns

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

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

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

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

  • 支持函数、常量形式添加列:

    • 函数:Oracle Reader 支持您输入 now()、current_timestamp() 等 Oracle数据库支持的函数。

    • 常量:Oracle Reader 支持您自定义输入常量值,如 '123'、'${DATE}'、'${hour}' 等,输入值两侧需要加上英文单引号,支持结合时间变量参数使用。

4.4.3 Oracle 批式写

根据实际情况替换 Oracle 批式写相应参数,Oracle 批式写脚本示例如下:

// **************************************
// 变量使用规则如下:
// 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": "xx",
        // [optional] datasource id, set it if you have registered datasource
        "datasource_id": null,
        // [required] user parameter
        "parameter": {
            // ********** please write here **********
            // "key" : value
          
        }
    },
    // writer config
    "writer": {
        // [required] datasource type
        "type": "oracle",
        // [optional] datasource id, set it if you have registered datasource
        "datasource_id": 12345,
        // [required] user parameter
        "parameter": {
            // ********** please write here **********
            // "key" : value
            "table_schema":"table_schema",
            "table_name":"table_1",
            "pre_sql_list":[""],
            "post_sql_list":[""],
            "write_mode":"directlyInsert",
            "columns": [
                {
                    "name": "name_sample",
                    "type": "type_sample"
                }
            ]
        }
    },
    // common config
    "common": {
        // [required] user parameter
        "parameter": {
            // ********** please write here **********
            // "key" : value
        }
    }
}

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

参数名
描述默认值
*type数据源类型,对于 Oracle 类型,填写:oracle
*datasource_id注册的 Oracle 数据源 ID。可以在项目控制台 > 数据源管理界面中查找。
*table_schema填写 Oracle 数据库中的 Schema 名称。
*table_name填写需要同步的数据表名称,一个数据集成任务只能同步数据到一张目标表。

pre_sql_list

写入前准备语句:在执行数据集成任务前,率先执行的 SQL 语句。此语句通常是为了使任务重跑时支持幂等。
例如执行前清空表中的某些旧数据,清空完成后,在执行集成任务写入新的数据,例如删除 date='${date}' 的数据:["delete from table_name where date='${date}'", "xxx"]

说明

DSL 模式支持配置多条写入前准备语句,多条语句之间用英文逗号分隔。

post_sql_list

写入后准备语句:执行数据同步任务后执行的 SQL 语句。例如数据写入完成后,插入某条特殊的数据,标志导入任务执行结束。
示例:["insert into table_name (col1,col2..) values(values1,values2)", "xxx"]

说明

DSL 模式支持配置多条写入后准备语句,多条语句之间用英文逗号分隔。

*write_mode

数据导入模式,支持 insert into 模式:
insert into:当主键/唯一性索引冲突时会写不进去冲突的行,任务会运行失败。

  • 使用该模式时,请将 write_mode 设置为 directlyInsert

  • 如果希望主键/唯一索引冲突时任务正常执行,可以在 writer.parameter 参数下添加高级参数 job.writer.is_insert_ignore:true

*columns

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

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

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

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

  • column 必须与导入的源端列集合对齐,不允许多列或少列。

4.5 高级参数说明

  • 对于可视化通道任务,读参数需要加上 job.reader. 前缀,写参数需要加上 job.writer. 前缀,如下图所示:

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

4.5.1 Oracle 批式读

批式读支持以下高级参数,您可根据实际情况进行配置:

参数名
描述默认值
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

4.5.2 Oracle 批式写

批式写支持以下高级参数,您可根据实际情况进行配置:

参数名
描述
默认值
is_insert_ignoreinsert into 模式时,主键或者唯一键冲突时任务失败还是忽略冲突false

write_batch_interval

一次性批量提交的数据条数,该值可以减少与 Oracle 网络的交互次数并提升整体吞吐量。如果该值设置过大可能会导致数据同步进程 OOM。

100

write_retry_timesOracle 写入失败时重试次数。3
retry_interval_seconds写入失败后两次重试的时间间隔,单位秒write_batch_interval / 10