You need to enable JavaScript to run this app.
文档中心
AI 原生 BaaS 平台 Supabase 版

AI 原生 BaaS 平台 Supabase 版

复制全文
下载 pdf
分支管理
对比分支
复制全文
下载 pdf
对比分支
本文介绍进行分支对比的操作步骤。​
背景信息​
在多分支并行开发场景下,业务需要合并分支前明确源分支与目标分支的数据库结构(Schema)差异。传统依靠人工比对或开源工具存在效率低、无法直接导出迁移 SQL、以及易将重命名(Rename)误判为删除重建从而导致数据丢失等痛点。​
“分支对比功能”基于 Schema Diff 生成安全的迁移 SQL(目标分支 + 迁移 SQL = 源分支)。它提供了可视化的对象级差异审查能力,并在受限场景下通过 OID 识别支持 Rename 变更。整个过程异步且不锁表,帮助用户在不影响业务的前提下,高效、安全地完成结构对齐。​
前提条件​
  • 已创建 Workspace 且 Workspace 的状态为运行中。​
  • 源分支和目标分支的状态均为运行中。​
注意事项​
  • 每个分支下,同一时刻只能存在一个分支对比任务。​
  • 建议一次分支对比任务中的表数量不超过 2000。​
  • 分支对比功能支持对以下对象进行差异对比:​
  • ​
    对象​
    说明​
    table​
    表。包含表的 列(column)、索引(index) 、 外键(foreign_key) 和触发器(trigger)​
    sequence​
    序列​
    function​
    函数​
    procedure​
    程序​
    view​
    视图​
    materialized_view​
    物化视图​
    extension​
    插件​
    enum​
    枚举​
    comment​
    注释​
    extension 依赖​
    插件的依赖关系。包含插件之间的依赖声明,用于确保插件按正确顺序安装和卸载。​
    rule​
    规则。数据库中定义的重写规则(Rewrite Rule),用于在查询执行前对 SQL 语句进行条件改写。​
    type​
    自定义类型。包含用户自定义的复合类型(composite type)、枚举类型(enum type)等数据库类型定义。​
    ​
操作步骤​
  1. 在顶部导航栏,选择目标项目和目标地域。​
  1. 进入目标 Workspace 的分支管理页面。可通过以下两种途径中的任意一种进入目标 Workspace 的分支管理页面。​
  • 单击页面中间导航栏中的​​分支管理,再单击页面左上角的 Workspace 名称右侧的​​,在弹出的下拉列表中选择目标 Workspace,即可进入目标 Workspace 的分支管理页面。​
  • 单击页面中间导航栏中的​​ Workspaces 进入 Workspaces 页面。在 Workspaces 页面单击目标 Workspace 名称进入目标 Workspace 的概览页。在概览页,单击分支区域右侧的全部分支,即可进入目标 Workspace 的分支管理页面。​
  1. 单击页面右上角的对比分支,进入对比分支页。​
  1. 在对比分支页,依次指定进行对比的源分支、源数据库、源 Schema、目标分支、目标数据库和目标 Schema 后,单击开始对比。​
说明​
完成对比后,会将差异按表进行逐个展示。您可以在差异列表中展开差异,获取差异的详细内容。​
后续步骤​
下载差异信息到本地​
在完成对比后,您可单击差异列表右上角的下载所有内容,将差异信息下载至本地。差异信息会按照以下目录结构进行组织,并压缩为 zip 格式供下载。​
相关 API​
​
API​
说明​
调用 DescribeBranchSchemaNames 接口查询分支的 Schema 列表。​
调用 CreateSchemaDiff 接口创建分支对比任务。​
调用 DescribeSchemaDiffJobStatus 查询分支对比任务的状态。​
调用 DescribeSchemaDiffResultMeta 查询分支对比任务的详细信息。​
调用 DescribeSchemaDiffResultSQLText 查询分支对比结果的 SQL 文本。​
调用 DescribeSchemaDiffResultSQLTextAll 接口查询分支对比任务的完整迁移 SQL 文本。​
调用 GetSchemaDiffResultDownloadLink 获取分支对比结果的下载链接。​
​
​
​
​
最近更新时间:2026.08.25 11:48:44
这个页面对您有帮助吗?
有用
有用
无用
无用