目录 Catalog

为什么需要 Catalog?

Catalog 是 ProtonBase 平台中实现数据共享和协作的关键组件。它提供了一种机制,使得多个团队可以在不同的 Warebase 实例之间共享数据库资源,同时保持适当的隔离性和访问控制。

Catalog 的核心价值:

  • 数据共享:实现跨团队、跨项目的数据库资源共享
  • 协作开发:支持多团队协同开发和数据分析
  • 资源管理:通过 Catalog 组织和管理数据库集合
  • 访问控制:提供统一的权限管理机制

目录(Catalog)是一组 Database 的集合。Warebase 绑定到 Catalog 后,可以访问 Catalog 下所有的 Database,通过 Catalog,可以实现多团队,多 Warebase,共享多 Database 的企业级数据开发协作与共享的场景。

Catalog 用法

  1. 一个 Data Cloud 支持多个 Catalog。业务上可以把多个相关的 Database 放在一个 Catalog下,从而支持该 Catalog 下的 Database 可以被所有 Warebase 访问。不会被分享的 Database 隔离在不同的 Catalog 下。

  2. 绑定到同一个 Catalog 的所有 Warebase 版本需要保持一致,以保证元数据的兼容性。在需要版本升级时,Catalog 下所有 Warebase 实例同时升级。

  3. 用户在新建 Warebase 初始化时,可以新建 Catalog,或者选择绑定到已有的 Catalog。

  4. Warebase 在绑定 Catalog 后,不可以再绑定其他 Catalog。

Catalog 使用建议

  • 根据业务需求和团队结构合理规划 Catalog
  • 确保绑定到同一 Catalog 的 Warebase 版本一致性
  • 定期审查 Catalog 内的数据库和访问权限

新建 Catalog

在新建 Warebase 时,可以选择"新建"Catalog。新建的 Catalog 会默认产生系统数据库,包括 postgres、template0、template1 三个 Database。

Create New Catalog

新建 Catalog 注意事项

  • Catalog 名称在 Data Cloud 内必须唯一
  • 新建 Catalog 会自动创建系统数据库
  • 考虑 Catalog 的长期使用需求,合理命名

绑定 Catalog

在新建 Warebase 时,可以选择"现有"的 Catalog,Warebase 绑定 Catalog 后,不可以再解绑,如需解绑,可以删除 Warebase 重新创建。

Select a Catalog

绑定 Catalog 最佳实践

  • 在创建 Warebase 时仔细选择 Catalog
  • 确保所选 Catalog 符合业务需求
  • 考虑未来扩展性需求

查看 Catalog

在"数据"菜单下,可以查看 Catalog;在 Catalog 下,可以查看 Database 并进行管理。

List Catalogs

Catalog 管理建议

  • 定期审查 Catalog 内的数据库资源
  • 监控 Catalog 的使用情况
  • 根据业务变化调整 Catalog 结构

删除 Catalog

如果需要删除 Catalog ,首先需要删除 Catalog 下所有手动创建的 Database,系统默认创建的 Database 可以忽略。

删除 Catalog 前检查清单

  • 确认 Catalog 内无重要数据或已备份
  • 删除所有手动创建的 Database
  • 通知可能使用该 Catalog 的相关团队

Catalog 管理最佳实践

  1. 命名规范:使用清晰的命名规范,如 项目名-环境-用途
  2. 权限控制:为不同的 Catalog 设置适当的访问权限
  3. 定期审查:定期审查 Catalog 的使用情况,清理不再需要的资源
  4. 版本管理:确保绑定到同一 Catalog 的 Warebase 版本一致性
  5. 文档记录:记录 Catalog 的用途和包含的数据库信息