跳到主要内容

Hudi Catalog

Hudi Catalog 复用了 Hive Catalog。通过连接 Hive Metastore,或者兼容 Hive Metatore 的元数据服务,Doris 可以自动获取 Hudi 的库表信息,并进行数据查询。

使用 Docker 快速体验 Apache Doris & Hudi

适用场景​

场景说明
查询加速利用 Doris 分布式计算引擎,直接访问 Hudi 数据进行查询加速。
数据集成读取 Hudi 数据并写入到 Doris 内表。或通过 Doris 计算引擎进行 ZeroETL 操作。
数据写回不支持。

配置 Catalog​

语法​

CREATE CATALOG [IF NOT EXISTS] catalog_name PROPERTIES (
'type' = 'hms', -- required
'hive.metastore.uris' = '<metastore_thrift_url>', -- required
{MetaStoreProperties},
{StorageProperties},
{HudiProperties},
{CommonProperties}
);
  • [MetaStoreProperties]

    MetaStoreProperties 部分用于填写 Metastore 元数据服务连接和认证信息。具体可参阅【支持的元数据服务】部分。

  • [StorageProperties]

    StorageProperties 部分用于填写存储系统相关的连接和认证信息。具体可参阅【支持的存储系统】部分。

  • [CommonProperties]

    CommonProperties 部分用于填写通用属性。请参阅 数据目录概述 中【通用属性】部分。

  • {HudiProperties}

    参数名称曾用名说明默认值
    hudi.use_hive_sync_partitionuse_hive_sync_partition是否使用 Hive Metastore 已同步的分区信息。如果为 true,则会直接从 Hive Metastore 中获取分区信息。否则,会从文件系统的元数据文件中获取分区信息。通过 Hive Metastore 获取信息性能更好,但需要用户保证最新的元数据已经同步到了 Hive Metastore。false

元数据缓存​

为了提升访问外部数据源的性能,Apache Doris 会对 Hudi 的元数据进行缓存。元数据包括表结构(Schema)、分区信息、FS View 和 Meta Client 对象等。

提示

对于 Doris 4.1.x 之前的版本,元数据缓存主要由 FE 配置项全局控制,详情请参阅元数据缓存。 从 Doris 4.1.x 开始,Hudi 相关外表元数据缓存使用统一键 meta.cache.* 进行配置。

缓存属性配置(4.1.x+)​

各引擎 cache entry 使用统一的配置键格式:meta.cache.<engine>.<entry>.{enable,ttl-second,capacity}。

属性示例含义
enabletrue/false是否启用该缓存模块。
ttl-second600、0、-10 表示关闭缓存(即刻生效,可用于查看最新数据);-1 表示永不过期;其他正整数表示按访问时间计算 TTL(秒)。
capacity10000最大缓存条目数(按条目数量计)。0 表示关闭。

生效逻辑说明: 只有当 enable=true 且 ttl-second != 0 且 capacity > 0 时,该模块缓存才会生效。

缓存模块​

Hudi Catalog 包含以下缓存模块:

模块 (<entry>)属性键前缀缓存内容与影响
schemameta.cache.hudi.schema.缓存表结构。影响:列新增、删除、类型变更在 Doris 中的可见性。若关闭,每次查询都会拉取最新 Schema。
partitionmeta.cache.hudi.partition.缓存 Hudi 分区相关元数据。影响:分区发现、分区裁剪,以及新增/删除分区何时在 Doris 中可见。
fs_viewmeta.cache.hudi.fs_view.缓存 Hudi 文件系统视图相关元数据。影响:查询规划时选择到的最新 base file / log file 以及 file slice 视图的新鲜度。
meta_clientmeta.cache.hudi.meta_client.缓存 Hudi Meta Client 对象。影响:时间线(timeline)、表配置等底层元数据重新加载的频率,以及提交/表配置变更何时被感知。

旧参数映射与转换​

在 4.1.x 之前,Hudi 的 Schema 缓存有 Catalog 兼容属性,分区与表级元数据则主要遵循旧的 FE 全局缓存模型,详见元数据缓存。升级到 4.1.x 后,建议统一改写为 meta.cache.hudi.*,并分别配置分区、FS View 和 Meta Client。

4.1 前属性键/旧模型适用范围4.1.x+ 统一键升级建议与影响
schema.cache.ttl-second4.1 前 Hudi Catalog 兼容属性meta.cache.hudi.schema.ttl-second控制 Schema 新鲜度。若希望列变更每次查询立即可见,设置为 0。
Hudi 分区旧模型4.1 前 FE 全局缓存策略(见旧版元数据缓存文档)meta.cache.hudi.partition.ttl-second控制分区发现与分区可见性。若希望新增/删除分区每次查询立即可见,设置为 0。
无一一对应的旧 Catalog 键4.1 前未单独暴露 fs_view / meta_client TTLmeta.cache.hudi.fs_view.*、meta.cache.hudi.meta_client.*这是 4.1.x 中拆分出的新模块。若希望更快感知最新 file slice 或提交时间线,分别调低对应 ttl-second。

4.1.x 的统一模型把缓存拆分为 enable、ttl-second、capacity 三个维度;旧模型主要描述 TTL/全局缓存行为。升级后如果仍沿用旧理解,容易遗漏 fs_view、meta_client 这类新模块的单独配置。

最佳实践​

  • 实时查看最新数据:如果您希望每次查询都能看到 Hudi 表的最新数据变动或 Schema 变更,可以将 schema 或 partition 的 ttl-second 设置为 0。
    -- 关闭分区元数据缓存,以感知 Hudi 表的最新分区变动
    ALTER CATALOG hudi_ctl SET PROPERTIES ("meta.cache.hudi.partition.ttl-second" = "0");
  • 性能优化:ALTER CATALOG ... SET PROPERTIES 的修改在 Hudi 中支持热生效(通过 HMS catalog 属性更新路径)。

可观测性​

可以通过 information_schema.catalog_meta_cache_statistics 系统表观测缓存指标:

SELECT catalog_name, engine_name, entry_name,
effective_enabled, ttl_second, capacity,
estimated_size, hit_rate, load_failure_count, last_error
FROM information_schema.catalog_meta_cache_statistics
WHERE catalog_name = 'hudi_ctl' AND engine_name = 'hudi'
ORDER BY entry_name;

该系统表文档见:catalog_meta_cache_statistics。

支持的 Hudi 版本​

当前依赖的 Hudi 版本为 0.15。推荐访问 0.14 版本以上的 Hudi 数据。

支持的查询类型​

表类型支持的查询类型
Copy On WriteSnapshot Query, Time Travel, Incremental Read
Merge On ReadSnapshot Queries, Read Optimized Queries, Time Travel, Incremental Read

支持的元数据服务​

支持的存储系统​

支持的数据格式​

列类型映射​

Hudi TypeDoris TypeComment
booleanboolean
intint
longbigint
floatfloat
doubledouble
decimal(P, S)decimal(P, S)
bytesstring
stringstring
datedate
timestampdatetime(N)根据精度,自动映射到 datetime(3) 或 datetime(6)
arrayarray
mapmap
structstruct
otherUNSUPPORTED

基础示例​

Hudi Catalog 的创建方式和 Hive Catalog 一致。更多示例可参阅 Hive Catalog

CREATE CATALOG hudi_hms PROPERTIES (
'type'='hms',
'hive.metastore.uris' = 'thrift://172.21.0.1:7004',
'hadoop.username' = 'hive',
'dfs.nameservices'='your-nameservice',
'dfs.ha.namenodes.your-nameservice'='nn1,nn2',
'dfs.namenode.rpc-address.your-nameservice.nn1'='172.21.0.2:4007',
'dfs.namenode.rpc-address.your-nameservice.nn2'='172.21.0.3:4007',
'dfs.client.failover.proxy.provider.your-nameservice'='org.apache.hadoop.hdfs.server.namenode.ha.ConfiguredFailoverProxyProvider'
);

查询操作​

基础查询​

配置好 Catalog 后,可以通过以下方式查询 Catalog 中的表数据:

-- 1. switch to catalog, use database and query
SWITCH hudi_ctl;
USE hudi_db;
SELECT * FROM hudi_tbl LIMIT 10;

-- 2. use hudi database directly
USE hudi_ctl.hudi_db;
SELECT * FROM hudi_tbl LIMIT 10;

-- 3. use full qualified name to query
SELECT * FROM hudi_ctl.hudi_db.hudi_tbl LIMIT 10;

时间旅行​

每一次对 Hudi 表的写操作都会产生一个新的快照,Doris 支持读取 Hudi 表指定的 Snapshot。默认情况下,查询请求只会读取最新版本的快照。

可以通过 hudi_meta() 表函数查询查询指定 Hudi 表的 Timeline:

该函数自 3.1.0 版本支持。

SELECT * FROM hudi_meta(
'table' = 'hudi_ctl.hudi_db.hudi_tbl',
'query_type' = 'timeline'
);

+-------------------+--------+--------------------------+-----------+-----------------------+
| timestamp | action | file_name | state | state_transition_time |
+-------------------+--------+--------------------------+-----------+-----------------------+
| 20241202171214902 | commit | 20241202171214902.commit | COMPLETED | 20241202171215756 |
| 20241202171217258 | commit | 20241202171217258.commit | COMPLETED | 20241202171218127 |
| 20241202171219557 | commit | 20241202171219557.commit | COMPLETED | 20241202171220308 |
| 20241202171221769 | commit | 20241202171221769.commit | COMPLETED | 20241202171222541 |
| 20241202171224269 | commit | 20241202171224269.commit | COMPLETED | 20241202171224995 |
| 20241202171226401 | commit | 20241202171226401.commit | COMPLETED | 20241202171227155 |
| 20241202171228827 | commit | 20241202171228827.commit | COMPLETED | 20241202171229570 |
| 20241202171230907 | commit | 20241202171230907.commit | COMPLETED | 20241202171231686 |
| 20241202171233356 | commit | 20241202171233356.commit | COMPLETED | 20241202171234288 |
| 20241202171235940 | commit | 20241202171235940.commit | COMPLETED | 20241202171236757 |
+-------------------+--------+--------------------------+-----------+-----------------------+

可以使用 FOR TIME AS OF 语句,根据快照的时间 (时间格式和 Hudi 官网保持一致) 读取历史版本的数据。示例如下:

SELECT * FROM hudi_tbl FOR TIME AS OF "2022-10-07 17:20:37";
SELECT * FROM hudi_tbl FOR TIME AS OF "20221007172037";
SELECT * FROM hudi_tbl FOR TIME AS OF "2022-10-07";

Hudi 表不支持 FOR VERSION AS OF 语句,使用该语法查询 Hudi 表将报错。

增量查询​

Incremental Read 可以查询在指定时间段之间变化的数据,返回的结果集是数据在指定时间段结束时的最终状态。

Doris 提供了 @incr 语法支持 Incremental Read:

SELECT * from hudi_table@incr('beginTime'='xxx', ['endTime'='xxx'], ['hoodie.read.timeline.holes.resolution.policy'='FAIL'], ...);
  • beginTime

    必填项。时间格式和 Hudi 官网 hudi_table_changes 保持一致,支持 "earliest"。

  • endTime

    选填,默认最新 commitTime。

可以在 @incr函数中添加更多选项,兼容 Spark Read Options。

通过 desc 查看执行计划,可以发现 Doris 将 @incr 转化为 predicates 下推给 VHUDI_SCAN_NODE:

|   0:VHUDI_SCAN_NODE(113)                                                                                            |
| table: lineitem_mor |
| predicates: (_hoodie_commit_time[#0] > '20240311151019723'), (_hoodie_commit_time[#0] <= '20240311151606605') |
| inputSplitNum=1, totalFileSize=13099711, scanRanges=1

FAQ​

  1. 通过 JNI 调用 Java SDK 读取 Hudi 增量数据偶发卡死

    请在 be.conf 的 JAVA_OPTS_FOR_JDK_17 或 JAVA_OPTS 中添加 -Djol.skipHotspotSAAttach=true.

附录​

版本更新记录​

Doris 版本功能支持
2.1.8/3.0.4Hudi 依赖升级到 0.15。新增 Hadoop Hudi JNI Scanner。