基于湖库一体架构,统一管理结构化、半结构化与非结构化等多模态数据,一个系统承载事务处理、实时分析与 AI 工作负载。
catalog_sync_target
更新时间:2026-10-29 17:22:34
说明
该配置项从 V4.6.2 版本开始引入。
功能描述
配置项 catalog_sync_target 用于指定 Catalog 数据同步的目标 Catalog,即 Internal catalog 中的库表元数据同步到 Hive Metastore(HMS)时所使用的 HMS 类型 External Catalog。
设置该配置项后,当前租户 Internal catalog 下新发生的 DDL 会自动同步到目标 HMS,使 Spark、Daft 等计算引擎能够通过 HMS 发现并查询 OceanBase AI 数据库中的表。将该配置项设置为空字符串时,即关闭 Catalog 数据同步。
权限要求
查询配置项
sys租户和所有用户租户均可以使用SHOW PARAMETERS语句或视图GV$OB_PARAMETERS查询该配置项。修改配置项
sys租户和用户租户均可修改该配置项。
属性说明
| 属性 | 描述 |
|---|---|
| 参数类型 | String |
| 默认值 | 空字符串 |
| 取值范围 | 空字符串或当前租户下已创建的 HMS 类型 External Catalog 名称 |
| 是否可修改 | 是,支持通过 ALTER SYSTEM SET 语句修改。 |
| 是否重启 OBServer 节点生效 | 否,设置后立即生效,仅对设置后新发生的 DDL 生效。 |
使用说明
该配置项为租户级配置项,仅对当前租户生效,不同租户可以指定不同的同步目标 Catalog。
目标 Catalog 必须是通过
CREATE EXTERNAL CATALOG语句创建的 HMS 类型 External Catalog,且 OceanBase AI 数据库能够访问该 Catalog 对应的 HMS Thrift 地址。开启同步后,仅对开启后新发生的 DDL 生效,存量库表不会自动同步。如需同步存量对象,可通过
SYNC CATALOG语句手动同步,有关详细介绍,请参见 Catalog 数据手动同步。开启同步期间,不支持
RENAME TABLE和CTAS(CREATE TABLE AS SELECT),执行时会被直接拦截并报错。如需执行上述操作,请先关闭同步,操作完成后再重新开启。关闭同步(将配置值置空)后,远端表会立即不可见,本地表不受影响;HMS 中已注册的占位表不会被自动清理,如需移除,须在 HMS 侧手动删除。
重新开启同步时,若指向原先的 Catalog,需重新设置该配置项;若指向其他 Catalog,同步目标将变更为新 Catalog 对应的 HMS。关闭同步期间产生的 DDL 不支持追溯同步。
有关 Catalog 数据同步的适用范围、支持的 DDL 操作、查询语义及类型映射等详细信息,请参见 Catalog 数据自动同步。
配置示例
创建 HMS 类型的 External Catalog。
更多语法细节,请参见 CREATE EXTERNAL CATALOG。
CREATE EXTERNAL CATALOG hms_sync_catalog PROPERTIES ( TYPE = 'hms', URI = 'thrift://<hms-host>:<port>' );开启 Catalog 数据同步。
ALTER SYSTEM SET catalog_sync_target = 'hms_sync_catalog';查看当前配置。
SHOW PARAMETERS LIKE 'catalog_sync_target';关闭 Catalog 数据同步。
ALTER SYSTEM SET catalog_sync_target = '';