跳到内容
光环标志
光环基地

部署

零停机迁移、原子回滚、通过 GitHub Actions / GitLab / CLI 进行 CI/CD 以及数据库分支:用于在生产前测试迁移或策略的项目副本。

说明8分钟 读取级别 中间修改于 2026年4月15日

该页面已自动翻译。英文版具有权威性。

三个部署面#

Aurabase 项目公开三个要部署的表面: Postgres 架构 (版本化 SQL 迁移)、 边缘函数 (WASM + cron + 作业)、 策略和机密 (RLS、环境变量、 OAuth 应用程序)。每个都通过 aura CLI 独立推送自己。

CLI (aura) 是一个二进制文件,也可以与 npm install -g @aurabase/cli一起安装,并支持试运行、确认提示和差异预览。兼容 Linux / macOS / Windows。

开发、预览、生产#

默认情况下,一个项目有两个环境:dev(本地,Kubernetes)和prod(云)。要在生产之前尝试更改数据副本,请创建 数据库分支。

fluxtext
LOCAL DEV
    $ ./start.sh              → full local stack (k3d)
    $ aura dev                → watch mode + types gen

BRANCH (copy of a project, deleted by its TTL)
    $ aura branch create pr-142 --from my-app --ttl 3d
    $ aura db push            → on the branch project, to try the migration
    $ aura branch delete pr-142

PRODUCTION
    merge to main             → CI run: aura db push
                              → aura deploy functions

版本化 SQL、原子回滚#

迁移位于 aurabase/migrations中。每次更改一个文件,时间戳在前缀中。 CLI 将缺少的迁移应用到链接的项目;更改后使用 npx @aurabase/gen 重新生成 TypeScript 类型。

terminalbash
# 创建新的迁移
aura db migration new add_devices_table
# → aurabase/migrations/20260415120000_add_devices_table.sql

# 查看哪些迁移已应用或待处理,然后将它们应用到链接的项目
aura db status
aura db push

# 重新生成 TypeScript 类型
npx @aurabase/gen --out src/aurabase.types.ts

# 列出已应用的迁移
aura db migration list
注意

零停机迁移。遵循规则:首先添加可为空的列,单独回填,最后约束 NOT NULL。 CLI 不会为您检查向后兼容性:在 aura db push之前检查破坏性语句(drop column、 alter column … type)。

数据库分支#

分支是从现有 PostgreSQL 项目克隆的 新项目:其架构、行级安全策略、函数、触发器、视图及其行(除非您仅要求架构)。它有自己的 URL、API 密钥和数据库,因此您可以运行迁移、测试策略或将预览部署指向它,而无需接触源。当分支的生存时间结束时,分支将被自动删除。

clibash
# 来自链接项目(aura链接),默认72小时
aura branch create feat/new-checkout

# 来自另一个项目,保留 7 天
aura branch create pr-142 --from my-app --ttl 7d

# 仅模式:不复制行,序列重新开始
aura branch create schema-test --no-data

aura branch list                    # 链接项目的分支
aura branch list --all              # 组织的每个分支机构
aura branch delete feat/new-checkout

aura branch create 等待分支准备就绪,然后打印其 URL 及其 API 密钥,仅显示一次 与 aura projects create 类似(--json 为脚本打印它们)。使用 --no-wait 立即返回并跟随 aura branch list。分支是一个项目:使用 aura link --project-id <id> 将文件夹链接到它并在那里运行 aura db push 来尝试迁移。

到底什么是分支

分支是在创建时创建的 副本,不是实时副本,也不是写时复制克隆:没有任何内容流回源或随后从源流回。平台在一个一致快照中读取源并将行复制到分支数据库中,因此时间与数据成正比。在本地测试堆栈上,在 14 秒内克隆了包含 350,000 行的 333 MB 表。然后,在分支上运行的迁移将使用通常的 aura db push应用于生产。

限制,完整#

谁可以创建来自处于活动状态且未休眠的 PostgreSQL 项目的具有 developer 角色或更高角色的成员。 MongoDB 项目被拒绝。
分支分支拒绝:从其父项目创建分支。
名称字母、数字、 .、 _、 - 和 /,最多 63 个字符,每个项目在实时分支中是唯一的(不区分大小写)。
生存时间默认为 72 小时,从 1 小时到 30 天(--ttl 1h 到 --ttl 30d)。过期的分支及其数据库将在截止日期前大约一分钟内自动删除。您可以提前删除它。
计划限额分支不会 不 计入您的项目限制 (max_projects);每个组织都有自己的活动分支限制 (max_branches):免费 1 个、专业版 10 个、团队 25 个。过了它,创建就会被 BRANCH_LIMIT_REACHED拒绝。失败的分支不算数。请参阅 限制。
数据大小这些行是流式传输的,而不是保存在内存中,因此没有 32 MiB 上限。当表容纳的内容超过部署限制(默认情况下为 2 GiB,当您托管 Aurabase时为 BRANCH_CLONE_MAX_BYTES )时,克隆将在几秒钟内被拒绝:该消息给出大小并建议 --no-data。克隆也会在 30 分钟后停止。

什么不是克隆#

  • 克隆:表及其行、列类型、默认值、标识列、序列及其当前值、约束、索引、行级安全性(启用、强制、策略)、SQL 函数和过程、触发器、视图和物化视图、枚举类型以及所有这些的权限。
  • 未克隆:身份验证用户、会话和身份验证设置;存储桶和物品;边缘函数、秘密、环境变量和 cron 作业;实时表设置(在分支上重新启用它们);表和列注释,包括 @graphql 指令;列级权限; pg_graphql 激活(分支上的aura projects graphql-enable)。对象由分支的管理员角色拥有。
  • 拒绝 (分支将不完整):分区和继承表、外部表、域、复合和范围类型、聚合函数、重写规则、指向另一个模式的外键以及平台在每个项目中安装的扩展之外的扩展。

当在复制之前读取架构时,会根据架构创建分支。创建分支时,请勿更改源的架构(aura db push、DDL)。

创建失败时#

什么都没有留下。副本在分支数据库上的单个事务中运行;任何失败都会回滚,分支项目被删除,并且 aura branch create 打印原因(例如无法克隆的对象)。失败的分支及其消息在 aura branch list 中保持可见 24 小时,并且其名称再次免费。如果数据库服务在复制过程中重新启动,则该分支将被声明失败并在 45 分钟后被删除。

三个集成已准备就绪#

CLI 可与任何 CI 配合使用。以下是三种最常见的食谱。

.github/workflows/deploy.ymlyaml
name: Deploy to Aurabase
on:
  push: { branches: [main] }

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm install -g @aurabase/cli   # 或从发布页面下载二进制文件
      - run: aura login --token ${{ secrets.AURA_PAT }}   # 个人访问令牌 aura_pat_*
      - run: aura link ${{ vars.AURA_PROJECT_ID }}
      - run: aura db push
      - run: aura deploy functions

每个环境链接一个项目(一个暂存项目和一个生产项目),并针对每个环境运行相同的管道。没有 --env 标志:目标是文件夹链接到的项目。

原子,通过向下迁移#

每个 20260415_xxx.sql 迁移旁边都可以有一个 20260415_xxx.down.sql 文件。 aura db migration down [n] 运行最后 n 应用的迁移的 .down.sql,最新的优先,并将它们从历史记录中删除;该命令检查服务器的答案,如果没有恢复任何内容,则失败。没有 .down.sql 的迁移只会从历史记录中删除,CLI 也是这么说的。

rollbackbash
# 恢复上次应用的迁移(运行其 .down.sql)
aura db migration down

# 恢复最后三个
aura db migration down 3

# 修复历史记录而不触及架构(手动应用的迁移,失败的迁移)
aura db migration repair 20260415120000_add_devices_table.sql --applied

# 失败的迁移将在其自己的事务中取消:无需恢复。
# 整个数据库的时间点恢复通过备份进行(aura db backup restore <id> --yes)
注意

时间点恢复 尚无自助服务命令。对于您自己驱动的恢复,请使用 aura db backup create / aura db backup restore <id> --yes的快照;恢复会覆盖数据库,因此请先进行全新备份。

为了走得更远#