JDBC Catalog

Doris JDBC Catalog 支持通过标准 JDBC 接口连接不同支持 JDBC 协议的数据库。本文档介绍 JDBC Catalog 的通用配置和使用方法。

支持的数据库

Doris JDBC Catalog 支持连接以下数据库：

数据库	说明
MySQL
PostgreSQL
Oracle
SQL Server
IBM Db2
ClickHouse
SAP HANA
OceanBase

配置

基本属性

参数	说明
`type`	固定为 `jdbc`
`user`	数据源用户名
`password`	数据源密码
`jdbc_url`	数据源连接 URL
`driver_url`	数据源 JDBC 驱动程序的路径
`driver_class`	数据源 JDBC 驱动程序的类名

可选属性

参数	默认值	说明
`lower_case_meta_names`	"false"	是否以小写的形式同步外部数据源的库名和表名以及列名
`meta_names_mapping`	""	当外部数据源存在名称相同只有大小写不同的情况，例如 DORIS 和 doris，Doris 由于歧义而在查询 Catalog 时报错，此时需要配置 `meta_names_mapping` 参数来解决冲突。
`only_specified_database`	"false"	是否只同步 JDBC URL 中指定的数据源的 Database（此处的 Database 为映射到 Doris 的 Database 层级）
`include_database_list`	""	当 `only_specified_database=true` 时，指定同步多个 Database，以','分隔。Database 名称是大小写敏感的。
`exclude_database_list`	""	当 `only_specified_database=true` 时，指定不需要同步的多个 Database，以','分割。Database 名称是大小写敏感的。

连接池属性

参数	默认值	说明
`connection_pool_min_size`	1	定义连接池的最小连接数，用于初始化连接池并保证在启用保活机制时至少有该数量的连接处于活跃状态。
`connection_pool_max_size`	30	定义连接池的最大连接数，每个 Catalog 对应的每个 FE 或 BE 节点最多可持有此数量的连接。
`connection_pool_max_wait_time`	5000	如果连接池中没有可用连接，定义客户端等待连接的最大毫秒数。
`connection_pool_max_life_time`	1800000	设置连接在连接池中保持活跃的最大时长（毫秒）。超时的连接将被回收。同时，此值的一半将作为连接池的最小逐出空闲时间，达到该时间的连接将成为逐出候选对象。
`connection_pool_keep_alive`	false	仅在 BE 节点上有效，用于决定是否保持达到最小逐出空闲时间但未到最大生命周期的连接活跃。默认关闭，以减少不必要的资源使用。

属性须知

驱动包路径与安全性

driver_url 可以通过以下三种方式指定：

文件名。如 mysql-connector-j-8.3.0.jar。需将 Jar 包预先存放在 FE 和 BE 部署目录下的 jdbc_drivers/ 目录下。系统会自动在这个目录下寻找。该目录的位置，也可以由 fe.conf 和 be.conf 中的 jdbc_drivers_dir 配置修改。
本地绝对路径。如 file:///path/to/mysql-connector-j-8.3.0.jar。需将 Jar 包预先存放在所有 FE/BE 节点指定的路径下。
Http 地址。如：http://repo1.maven.org/maven2/com/mysql/mysql-connector-j/8.3.0/mysql-connector-j-8.3.0.jar 系统会从这个 Http 地址下载 Driver 文件。仅支持无认证的 Http 服务。

驱动包安全性

为了防止在创建 Catalog 时使用了未允许路径的 Driver Jar 包，Doris 会对 Jar 包进行路径管理和校验和检查。

针对上述方式 1，Doris 默认用户配置的 jdbc_drivers_dir 和其目录下的所有 Jar 包都是安全的，不会对其进行路径检查。
针对上述方式 2、3，Doris 会对 Jar 包的来源进行检查，检查规则如下：
- 通过 FE 配置项 jdbc_driver_secure_path 来控制允许的驱动包路径，该配置项可配置多个路径，以分号分隔。当配置了该项时，Doris 会检查 Catalog properties 中 driver_url 的路径是的部分前缀是否在 jdbc_driver_secure_path 中，如果不在其中，则会拒绝创建 Catalog。
- 此参数默认为 * ，表示允许所有路径的 Jar 包。
- 如果配置 jdbc_driver_secure_path 为空，也表示允许所有路径的 Jar 包。
备注
如配置 jdbc_driver_secure_path = "file:///path/to/jdbc_drivers;http://path/to/jdbc_drivers" ：
则只允许以 file:///path/to/jdbc_drivers 或 http://path/to/jdbc_drivers 开头的驱动包路径。
在创建 Catalog 时，可以通过 checksum 参数来指定驱动包的校验和，Doris 会在加载驱动包后，对驱动包进行校验，如果校验失败，则会拒绝创建 Catalog。

备注

上述的校验只会在创建 Catalog 时进行，对于已经创建的 Catalog，不会再次进行校验。

小写名称同步

当 lower_case_meta_names 设置为 true 时，Doris 通过维护小写名称到远程系统中实际名称的映射，使查询时能够使用小写去查询外部数据源非小写的数据库和表以及列。

由于 FE 存在 lower_case_table_names 的参数，会影响查询时的表名大小写规则，所以规则如下

lower_case_meta_names = true
库表列名都会被转换为小写。
lower_case_meta_names = false
当 FE 的 lower_case_table_names 参数为 0 或 2 时，库名表名列名都不会被转换。
当 FE 的 lower_case_table_names 参数为 1 时，表名会被转换为小写，库名和列名不会被转换。

如果创建 Catalog 时的参数配置匹配到了上述规则中的转变小写规则，则 Doris 会将对应的名称转变为小写存储在 Doris 中，查询时需使用 Doris 显示的小写名称去查询。

如果外部数据源存在名称相同只有大小写不同的情况，例如 DORIS 和 doris，Doris 由于歧义而在查询 Catalog 时报错，此时需要配置 meta_names_mapping 参数来解决冲突。

meta_names_mapping 参数接受一个 Json 格式的字符串，格式如下：

{
  "databases": [
    {
      "remoteDatabase": "DORIS",
      "mapping": "doris_1"
    },
    {
      "remoteDatabase": "doris",
      "mapping": "doris_2"
    }
  ],
  "tables": [
    {
      "remoteDatabase": "DORIS",
      "remoteTable": "DORIS",
      "mapping": "doris_1"
    },
    {
      "remoteDatabase": "DORIS",
      "remoteTable": "doris",
      "mapping": "doris_2"
    }
  ],
  "columns": [
    {
      "remoteDatabase": "DORIS",
      "remoteTable": "DORIS",
      "remoteColumn": "DORIS",
      "mapping": "doris_1"
    },
    {
      "remoteDatabase": "DORIS",
      "remoteTable": "DORIS",
      "remoteColumn": "doris",
      "mapping": "doris_2"
    }
  ]
}

在将此配置填写到创建 Catalog 的语句中时，Json 中存在双引号，因此在填写时需要将双引号转义或者直接使用单引号包裹 Json 字符串。

指定同步数据库

only_specified_database: 是否只同步 JDBC URL 中指定的数据源的 Database。默认值为 false，表示同步 JDBC URL 中所有的 Database。

include_database_list: 仅在only_specified_database=true时生效，指定需要同步的 PostgreSQL 的 Schema，以','分隔。Schema 名称是大小写敏感的。

exclude_database_list: 仅在only_specified_database=true时生效，指定不需要同步的 PostgreSQL 的 Schema，以','分隔。Schema 名称是大小写敏感的。

备注

上述三个参数中提到的 Database 是指 Doris 中的 Database 层级，而不是外部数据源的 Database 层级，具体的映射关系可以参考各个数据源文档。
当 include_database_list 和 exclude_database_list 有重合的 database 配置时，exclude_database_list会优先生效。

连接池配置

在 Doris 中，每个 FE 和 BE 节点都会维护一个连接池，这样可以避免频繁地打开和关闭单独的数据源连接。连接池中的每个连接都可以用来与数据源建立连接并执行查询。任务完成后，这些连接会被归还到池中以便重复使用，这不仅提高了性能，还减少了建立连接时的系统开销，并帮助防止达到数据源的连接数上限。

可以根据实际情况调整连接池的大小，以便更好地适应您的工作负载。通常情况下，连接池的最小连接数应该设置为 1，以确保在启用保活机制时至少有一个连接处于活跃状态。连接池的最大连接数应该设置为一个合理的值，以避免过多的连接占用资源。

同时为了避免在 BE 上累积过多的未使用的连接池缓存，可以通过设置 BE 的 jdbc_connection_pool_cache_clear_time_sec 参数来指定清理缓存的时间间隔。默认值为 28800 秒（8 小时），此间隔过后，BE 将强制清理所有超过该时间未使用的连接池缓存。

危险

使用 Doris JDBC Catalog 连接外部数据源时，需谨慎更新数据库凭证。

Doris 通过连接池维持活跃连接以快速响应查询。但凭证变更后，连接池可能会继续使用旧凭证尝试建立新连接并失败。由于系统试图保持一定数量的活跃连接，这种错误尝试会重复执行，且在某些数据库系统中，频繁的失败可能导致账户被锁定。

建议在必须更改凭证时，同步更新 Doris JDBC Catalog 配置，并重启 Doris 集群，以确保所有节点使用最新凭证，防止连接失败和潜在的账户锁定。

可能遇到的账户锁定如下：

MySQL: account is locked

Oracle: ORA-28000: the account is locked

SQL Server: Login is locked out

Insert 事务

Doris 的数据是由一组 batch 的方式写入 JDBC Catalog 的，如果中途导入中断，之前写入数据可能需要回滚。所以 JDBC Catalog 支持数据写入时的事务，事务的支持需要通过设置 session variable: enable_odbc_transcation 。

set enable_odbc_transcation = true; 

事务保证了 JDBC Catalog 数据写入的原子性，但是一定程度上会降低数据写入的性能，可以考虑酌情开启该功能。

示例

此处以 MySQL 为例，展示如何创建一个 MySQL Catalog 并查询其中的数据。

创建一个名为 mysql 的 Catalog：

CREATE CATALOG mysql PROPERTIES (
    "type"="jdbc",
    "user"="root",
    "password"="secret",
    "jdbc_url" = "jdbc:mysql://example.net:3306",
    "driver_url" = "mysql-connector-j-8.3.0.jar",
    "driver_class" = "com.mysql.cj.jdbc.Driver"
)

通过运行 SHOW DATABASES 查看此 Catalog 所有数据库：

SHOW DATABASES FROM mysql;

如果您有一个名为 test 的 MySQL 数据库，您可以通过运行 SHOW TABLES 查看该数据库中的表：

SHOW TABLES FROM mysql.test;

最后，您可以访问 MySQL 数据库中的表：

SELECT * FROM mysql.test.table;

语句透传

Doris 支持通过透传的方式，直接执行 JDBC 数据源的 DDL、DML 语句和查询语句。

透传 DDL 和 DML

CALL EXECUTE_STMT("catalog_name", "raw_stmt_string");

EXECUTE_STMT() 过程有两个参数：

Catalog Name：目前仅支持 JDBC 类型 Catalog。
执行语句：目前仅支持 DDL 和 DML 语句，并且需要直接使用数据源对应的语法。

CALL EXECUTE_STMT("jdbc_catalog", "insert into db1.tbl1 values(1,2), (3, 4)");

CALL EXECUTE_STMT("jdbc_catalog", "delete from db1.tbl1 where k1 = 2");

CALL EXECUTE_STMT("jdbc_catalog", "create table dbl1.tbl2 (k1 int)");

透传查询

query(
  "catalog" = "catalog_name", 
  "query" = "select * from db_name.table_name where condition"
  );

query 表函数有两个参数：

catalog：Catalog 名称，需要按照 Catalog 的名称填写。
query：需要执行的查询语句，并且需要直接使用数据源对应的语法。

select * from query("catalog" = "jdbc_catalog", "query" = "select * from db_name.table_name where condition");

原理和限制

通过 CALL EXECUTE_STMT() 命令，Doris 会直接将用户编写的 SQL 语句发送给 Catalog 对应的 JDBC 数据源进行执行。因此，这个操作有如下限制：

SQL 语句必须是数据源对应的语法，Doris 不会做语法和语义检查。
SQL 语句中引用的表名建议是全限定名，即 db.tbl 这种格式。如果未指定 db，则会使用 JDBC Catalog 的 JDBC URL 中指定的 db 名称。
SQL 语句中不可引用 JDBC 数据源之外的库表，也不可以引用 Doris 的库表。但可以引用在 JDBC 数据源内的，但是没有同步到 Doris JDBC Catalog 的库表。
执行 DML 语句，无法获取插入、更新或删除的行数，只能获取命令是否执行成功。
只有对 Catalog 有 LOAD 权限的用户，才能执行CALL EXECUTE_STMT()命令。
只有对 Catalog 有 SELECT 权限的用户，才能执行query()表函数。
query 表函数读取到的的数据，数据类型的支持与所查询的 catalog 类型支持的数据类型一致。

连接池问题排查

HikariPool 获取连接超时错误

Connection is not available, request timed out after 5000ms

可能的原因：

原因 1：网络问题（例如，服务器不可达）
原因 2：身份认证问题，例如无效的用户名或密码
原因 3：网络延迟过高，导致创建连接超过 5 秒超时时间
原因 4：并发查询过多，超过了连接池配置的最大连接数

解决方案：

如果只有 "Connection is not available, request timed out after 5000ms" 这一类错误，请检查 原因 3 和 原因 4：
- 检查是否存在网络延迟过高或资源耗尽的情况。
- 调大连接池的最大连接数：
```
ALTER CATALOG <catalog_name> SET PROPERTIES ('connection_pool_max_size' = '100');
```
- 调大连接超时时间：
```
ALTER CATALOG <catalog_name> SET PROPERTIES ('connection_pool_max_wait_time' = '10000');
```
如果除了 "Connection is not available, request timed out after 5000ms" 之外还有其他错误信息，请检查这些附加错误：
- 网络问题（例如，服务器不可达）可能导致连接失败。请检查网络连接是否正常。
- 身份认证问题（例如，用户名或密码无效）也可能导致连接失败。请检查配置中使用的数据库凭据，确保用户名和密码正确无误。
- 根据具体错误信息，调查与网络、数据库或身份认证相关的问题，找出根本原因。

支持的数据库​

配置​

基本属性​

可选属性​

连接池属性​

属性须知​

驱动包路径与安全性​

小写名称同步​

指定同步数据库​

连接池配置​

Insert 事务​

示例​

语句透传​

透传 DDL 和 DML​

透传查询​

原理和限制​

连接池问题排查​

HikariPool 获取连接超时错误​

可能的原因：​

解决方案：​