一、版本说明
| Flink 版本 | 说明 |
| 1.13 | 支持 |
| 1.14 | 支持 |
| 1.16 | 支持 |
二、使用范围
jdbc-oceanbase 支持用作数据源表(Source),用于按固定列扫描表和用于 JOIN 的右表(维表);也支持用作数据目的表(sink),用于 Tuple 数据流表和用于 Upsert 数据流表(需要指定主键)。
三、用作按列扫描的数据源(Source)
CREATE TABLE `jdbc_source_table` ( `id` INT, `name` STRING) WITH ( — 指定数据库连接参数 'connector' = 'jdbc-oceanbase', 'compatible-mode'= 'mysql', 'url' = 'jdbc:oceanbase://10.1.28.93:3306/CDB?rewriteBatchedStatements=true&serverTimezone=Asia/Shanghai', — 请替换为你的实际 MySQL 连接参数 'table-name' = 'my-table', — 需要写入的数据表 'username' = 'admin', — 数据库访问的用户名(需要提供 INSERT 权限) 'password' = 'MyPa$$w0rd', — 数据库访问的密码 'scan.partition.column' = 'id', — 分区扫描列名 'scan.partition.num' = '2', — 分区数量 'scan.partition.lower-bound' = '0', — 首个分区的最小值 'scan.partition.upper-bound' = '100', — 最后一个分区的最大值 'scan.fetch-size' = '1' — 每次从数据库读取时,批量获取的行数);
四、用作维表数据源(Source)
CREATE TABLE `jdbc_dim_table` ( `id` INT, `name` STRING) WITH ( — 指定数据库连接参数 'connector' = 'jdbc-oceanbase', 'compatible-mode'= 'mysql', 'url' = 'jdbc:oceanbase://10.1.28.93:3306/CDB?rewriteBatchedStatements=true&serverTimezone=Asia/Shanghai', — 请替换为你的实际 MySQL 连接参数 'table-name' = 'my-table', — 需要写入的数据表 'username' = 'admin', — 数据库访问的用户名(需要提供 INSERT 权限) 'password' = 'MyPa$$w0rd', — 数据库访问的密码 'lookup.cache.max-rows' = '100', — 读缓存大小 'lookup.cache.ttl' = '5000' — 读缓存的 TTL);
五、用作数据目的(Tuple Sink)
CREATE TABLE `jdbc_sink_table` ( `id` INT, `name` STRING) WITH ( — 指定数据库连接参数 'connector' = 'jdbc-oceanbase', 'compatible-mode'= 'mysql', 'url' = 'jdbc:oceanbase://10.1.28.93:3306/CDB?rewriteBatchedStatements=true&serverTimezone=Asia/Shanghai', — 请替换为你的实际 MySQL 连接参数 'table-name' = 'my-table', — 需要写入的数据表 'username' = 'admin', — 数据库访问的用户名(需要提供 INSERT 权限) 'password' = 'MyPa$$w0rd', — 数据库访问的密码 'sink.buffer-flush.max-rows' = '200', — 批量输出的条数 'sink.buffer-flush.interval' = '2s' — 批量输出的间隔);
六、用作数据目的(Upsert Sink)
CREATE TABLE `jdbc_upsert_sink_table` ( `id` INT PRIMARY KEY NOT ENFORCED, `name` STRING) WITH ( — 指定数据库连接参数 'connector' = 'jdbc-oceanbase', 'compatible-mode'= 'mysql', 'url' = 'jdbc:oceanbase://10.1.28.93:3306/CDB?rewriteBatchedStatements=true&serverTimezone=Asia/Shanghai', — 请替换为你的实际 MySQL 连接参数 'table-name' = 'my-upsert-table', — 需要写入的数据表 'username' = 'admin', — 数据库访问的用户名(需要提供 INSERT 权限) 'password' = 'MyPa$$w0rd', — 数据库访问的密码 'sink.buffer-flush.max-rows' = '200', — 批量输出的条数 'sink.buffer-flush.interval' = '2s' — 批量输出的间隔);
注意:Upsert 需要定义 PRIMARY KEY。
七、WITH 参数
| 参数值 | 必填 | 默认值 | 描述 |
| connector | 是 | 无 | 连接数据库时,需要填写 'jdbc-oceanbase'。 |
| compatible-mode | 是 | 无 | 连接数据时,根据实际情况填写,mysql或者oracle |
| url | 是 | 无 | JDBC 数据库的连接 URL。 |
| table-name | 是 | 无 | 数据库表名。 |
| driver | 否 | 无 | JDBC Driver 的类名。如果不输入,则自动使用各个模式默认的驱动类名。 |
| username | 否 | 无 | 数据库用户名。'username' 和'password' 必须同时使用。 |
| password | 否 | 无 | 数据库密码。 |
| scan.partition.column | 否 | 无 | 指定对输入分区扫描(Partitioned Scan)的列名,该列必须是数值类型、日期类型、时间戳类型等。 |
| scan.partition.num | 否 | 无 | 分区扫描启用后,指定分区数。 |
| scan.partition.lower-bound | 否 | 无 | 分区扫描启用后,指定首个分区的最小值。 |
| scan.partition.upper-bound | 否 | 无 | 分区扫描启用后,指定最后一个分区的最大值。 |
| scan.fetch-size | 否 | 0 | 每次循环读取时应该从数据库中获取的行数。如果指定的值为 '0',则该配置项会被忽略。 |
| lookup.cache.max-rows | 否 | 无 | lookup cache 的最大行数,若超过该值,则最老的行记录将会过期。 默认情况下,lookup cache 是未开启的。 |
| lookup.cache.ttl | 否 | 无 | lookup cache 中每一行记录的最大存活时间,若超过该时间,则最老的行记录将会过期。 默认情况下,lookup cache 是未开启的。 |
| lookup.max-retries | 否 | 3 | 数据库查询失败时,最多重试的次数。 |
| sink.buffer-flush.max-rows | 否 | 100 | flush 前缓存记录的最大值,可以设置为 '0' 来禁用它。 |
| sink.buffer-flush.interval | 否 | 1s | 批量输出时,每批次最大的间隔(毫秒)。如果 'sink.buffer-flush.max-rows' 设为 '0',而这个选项不为零,则说明启用纯异步输出功能,即数据输出到算子、从算子最终写入数据库这两部分线程完全解耦。 |
| sink.max-retries | 否 | 3 | 数据库写入失败时,最多重试的次数。 |
八、代码示例
CREATE TABLE `oceanbase_source_table` ( `id` INT, `name` STRING) WITH ( — 指定数据库连接参数 'connector' = 'jdbc-oceanbase', 'url' = 'jdbc:oceanbase://10.1.28.93:3306/CDB?rewriteBatchedStatements=true&serverTimezone=Asia/Shanghai', — 请替换为你的实际 MySQL 连接参数 'table-name' = 'my-table', — 需要写入的数据表 'username' = 'admin', — 数据库访问的用户名(需要提供 INSERT 权限) 'password' = 'MyPa$$w0rd', — 数据库访问的密码 'scan.partition.column' = 'id', — 分区扫描列名 'scan.partition.num' = '2', — 分区数量 'scan.partition.lower-bound' = '0', — 首个分区的最小值 'scan.partition.upper-bound' = '100', — 最后一个分区的最大值 'scan.fetch-size' = '1' — 每次从数据库读取时,批量获取的行数);CREATE TABLE `oceanbase_upsert_sink_table` ( `id` INT PRIMARY KEY NOT ENFORCED, `name` STRING) WITH ( — 指定数据库连接参数 'connector' = 'jdbc-oceanbase', 'url' = 'jdbc:oceanbase://10.1.28.93:3306/CDB?rewriteBatchedStatements=true&serverTimezone=Asia/Shanghai', — 请替换为你的实际 MySQL 连接参数 'table-name' = 'my-upsert-table', — 需要写入的数据表 'username' = 'admin', — 数据库访问的用户名(需要提供 INSERT 权限) 'password' = 'MyPa$$w0rd', — 数据库访问的密码 'sink.buffer-flush.max-rows' = '200', — 批量输出的条数 'sink.buffer-flush.interval' = '2s' — 批量输出的间隔);insert into oceanbase_upsert_sink_table select * from oceanbase_source_table;
九、主键说明
·对于 Append(Tuple)数据,作业 DDL 不需要设置主键,OceanBase 数据库的表也不需要定义主键,也不建议定义主键(否则可能因为重复数据而造成写入失败)。
·对于 Upsert 数据,OceanBase 数据库的表必须定义主键,并需要在 DDL 语句的 CREATE TABLE 中,将相应列名也加上 PRIMARY KEY NOT ENFORCED 约束。
十、分区扫描
分区扫描(Partitioned Scan)可以加速多个并行度的 Source 算子读取 OceanBase 数据表,每个子任务可以读取自己的专属分区。使用该功能时,所有四个 scan.partition 开头的参数都必须指定,否则会报错。
注意:这里的 scan.partition.upper-bound 指定的最大值和 scan.partition.lower-bound 指定的最小值,指的是每个分区的步长,不会影响最终读取的数据条数和精确性。
十一、读取缓存
Flink 提供了读取缓存(Lookup Cache)功能,可以提升维表读取的性能。目前该缓存的实现是同步的,默认未启用(每次请求都会读取数据库,吞吐量很低),必须手动设置 lookup.cache.max-rows 和 lookup.cache.ttl 两个参数来启用该功能。
注意:如果缓存的 TTL 太长,或者缓存的条数太多,可能会造成数据库中数据更新后,Flink 作业仍然读取的是缓存中的旧数据。因此对于数据库变动敏感的作业,请谨慎使用缓存功能。
十二、批量写入优化
通过设置 sink.buffer-flush 开头的两个参数,可以实现批量写入数据库。建议配合相应底层数据库的参数,以达到更好的批量写入效果,否则底层仍然会一条一条写入,效率不高。
·建议在 url 连接参数后加入 rewriteBatchedStatements=true 参数。
jdbc:oceanbase://10.1.28.93:3306/CDB?rewriteBatchedStatements=true