Catalog 与外部表

功能简介

OceanBase 支持通过 Catalog（数据目录） 和 外部表（External Table） 访问外部数据。二者均为外部数据访问能力，但元数据管理方式与适用场景不同：

• Catalog：连接外部元数据服务（如 MaxCompute 项目），自动同步库表结构，适用于已有元数据中心的结构化数据源。
• 外部表：在 OceanBase 中手工定义表结构与访问路径，适用于文件路径、临时数据或单表映射等场景。

OceanBase 自 V4.3.5 BP2 起支持 ODPS Catalog。通过 Catalog，可查询 MaxCompute（ODPS）中的表；查询时可与 internal Catalog 中的内表进行联邦分析。

部署与环境依赖

Catalog 与外部表的关系

OceanBase 访问外部数据时，涉及以下层次，请勿混淆：

OceanBase 提供两种外部数据访问模式：

选型说明：

• Catalog 适用于数据源已在 MaxCompute 中注册的场景；OceanBase 通过 Catalog 读取元数据，再访问远端表。
• 显式外部表适用于按路径访问 CSV / Parquet / ORC 文件，或通过 MaxCompute API 映射单张 ODPS 表等场景。

Catalog 类型

Catalog 是数据库对象的顶层命名空间，用于组织和隔离不同数据源的元数据。OceanBase 支持内部 Catalog 与外部 Catalog：

内部 Catalog

每个租户有且仅有一个名为 internal 的内部 Catalog，包含该租户内通过 CREATE DATABASE、CREATE TABLE 等 DDL 创建的对象。internal Catalog 与外部 Catalog 逻辑隔离；不支持创建、删除或重命名 internal Catalog。

• 默认情况下可直接 USE database; 访问，无需显式指定 Catalog。
• 支持完整 DDL/DML；数据存储在 OceanBase 分布式存储引擎中。

USE ap_db;
SELECT COUNT(*) FROM user_behavior;

-- 显式指定 internal Catalog（可选）
SELECT COUNT(*) FROM internal.ap_db.user_behavior;

外部 Catalog

外部 Catalog 通过 CREATE EXTERNAL CATALOG 创建。SQL 参考当前以 ODPS Catalog 为正式语法；参数说明参见：

• ODPS Catalog

创建与访问 Catalog

创建 External Catalog

internal Catalog 无需手动创建。创建外部 Catalog 的语法参见 CREATE EXTERNAL CATALOG；各类型参数说明参见上述接入文档。

查看 Catalog

SHOW CATALOGS;

切换 Catalog 与跨 Catalog 查询

引用表时遵循以下规则：

• 未切换会话上下文时，须使用三段式标识符：catalog_name.database_name.table_name
• 已执行 SET CATALOG 和 USE 后，可使用简写表名

方式一：三段式标识符（无需切换上下文）

SELECT CURRENT_CATALOG();
SELECT DATABASE();

SELECT * FROM odps_catalog.odps_db.odps_table;

SELECT o.*, i.*
FROM odps_catalog.odps_db.odps_table o
JOIN internal.ap_db.ap_table i ON o.id = i.id;

方式二：切换上下文后使用简写表名

SET CATALOG odps_catalog;
USE odps_db;

SELECT o.*, i.*
FROM odps_table o
JOIN internal.ap_db.ap_table i ON o.id = i.id;

也可单独执行 SET CATALOG catalog_name;，或在查询中显式指定：

SELECT * FROM odps_catalog.database_name.table_name;

语法说明参见 SET CATALOG 与 查看 CATALOG。

Catalog 支持范围

本节概述各外部 Catalog 的能力边界。创建、认证及 Location 配置等详细说明，参见对应接入文档。

ODPS Catalog

详细参数与 API 模式说明参见 ODPS Catalog。

Catalog 权限管理

Catalog 权限分为两个层级：

MySQL 模式权限

授予全局权限：

GRANT CREATE CATALOG ON *.* TO 'user1';
GRANT USE CATALOG ON *.* TO 'user1' WITH GRANT OPTION;

授予特定 Catalog 权限：

GRANT SELECT, USE CATALOG ON CATALOG odps_prod TO 'user1' WITH GRANT OPTION;
REVOKE USE CATALOG ON CATALOG odps_prod FROM 'user1';

补充说明：

1. 执行 CREATE EXTERNAL CATALOG 成功后，创建者自动获得该 Catalog 的 USE CATALOG 和 SELECT 权限。
2. Catalog 权限与数据访问权限相互独立。Catalog 层负责获取远端元数据，数据访问层负责访问 MaxCompute 等远端存储，两层认证需分别配置。

权限验证示例：

GRANT SELECT, USE CATALOG ON CATALOG ca1 TO zhangsan WITH GRANT OPTION;
SHOW GRANTS FOR zhangsan;

权限查询视图：

• information_schema.USER_PRIVILEGES
• oceanbase.DBA_OB_USERS / CDB_OB_USERS

外部表

外部表（External Table）在 OceanBase 侧保存表定义与访问路径，数据仍位于外部存储（对象存储、HDFS、MaxCompute 等）。外部表通常为只读，不支持约束与索引。

与 Catalog 模式相比，显式外部表适用于以下场景：

• 按文件路径访问 CSV、Parquet、ORC 等数据
• 临时探查外部文件，无需预建 Catalog
• 通过 MaxCompute API 映射单张 ODPS 表（非整个项目）

OceanBase 支持以下外部表类型：

相关文档

接入文档

• ODPS Catalog
• ODPS 外部表
• 文件外部表
• URL 外部表
• 数据湖概述

参考文档

• Catalog 概述（参考）
• 创建 Catalog
• 查看 Catalog
• 删除 Catalog
• CREATE EXTERNAL CATALOG
• SET CATALOG
• DROP CATALOG