# @gate-forge/pack-alembic 中文文档

规范地址：https://npmcn.com/package/%40gate-forge/pack-alembic/

版本：0\.19\.2
npm 元数据更新时间：2026-11-10T03:56:30.983Z
中文译文更新时间：2026-11-16T00:05:14.088Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gate-forge/pack-alembic
原文对照：https://npmcn.com/package/%40gate-forge/pack-alembic/?lang=original
项目主页：https://github.com/umiddey/gateforge#readme
源码仓库：https://github.com/umiddey/gateforge

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：148 kB，55 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：3 个
- 首次发布：2026-10-03T06:25:20.060Z
- 最新版本发布：2026-11-10T03:56:30.608Z
- 近 30 天下载量：2445（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：34（近 12 个月 34 个）

## 中文简介

Alembic 迁移义务包:静地行道验证,引擎运行在可支配数据库上的回转,数据保存检查,多开发者合并安全.

## 安装

```sh
npm install @gate-forge/pack-alembic
```

也可以使用：`pnpm add @gate-forge/pack-alembic`、`yarn add @gate-forge/pack-alembic`、`bun add @gate-forge/pack-alembic`

## README

# @ gate-forge/ pack- alembic (英语)

(原始内容存档于2018-10-21) (英语). Opt-in Alembic 迁移义务. 没有仓库 `alembic` 键入 `.gateforge.yml` 行为完全如前;没有增加移徙义务.

当启用时, Gateforge 只使用 Python AST 解析迁移脚本, 然后运行 `upgrade` → `downgrade base` → `upgrade` 对抗引擎创建 `gf_tmp_<id>` 数据库并删除。 信任的管理员 URL 仅来自此配置,从未来自测试环境. 套用债权不能履行这些义务.

```yaml
alembic:
  chains:
    - name: invoices
      migrations: migrations/versions
      models:
        - models.py
      # Optional; defaults shown:
      alembicIni: alembic.ini
      modelsModule: models
      metadata: Base.metadata
  scratch:
    adminUrl: postgresql://gateforge:gateforge@127.0.0.1:5432/postgres
  # Optional: seed existing rows, verify counts/fingerprints, and declare renames.
  seed:
    path: tests/seed.sql
    tables:
      - name: invoices
        columns: [id, number]
        copies:
          - from: legacy_number
            to: number
  # Optional owner-approved irreversible revisions.
  irreversible: []
  # Optional; validates against target branch merge result.
  merge:
    targetRef: origin/main
```

`gateforge init` 当 `alembic.ini` 已存在;无法启用组合。 将块添加到 `.gateforge.yml`,提供一次性的 Postgres 服务和可信任的管理员 URL,然后运行 `gateforge check`。 。 。 .

迁移跑者需要Alembic、SQLAlchemy和一个PostgreSQL驱动程序(`psycopg` 或者说 `psycopg2`)在其Python环境中. 它不导入工程的 `env.py`。跑步者会绘制表格、列、约束、索引、图表和序列,但不包括 `alembic_version`与 `seed`,它比较行数 并声明纵列指纹 整个迁移。 在一个临时的 Git 工作树中测试一个配置的合并目标 .

原因代码( 所有添加剂): `MIGRATION_MISSING`, (中文(简体) ), `MIGRATION_LINEAGE_BROKEN`, (中文(简体) ), `MIGRATION_DOWNGRADE_NOOP`, (中文(简体) ), `MIGRATION_DRIFT`, (中文(简体) ), `MIGRATION_ROUNDTRIP_FAILED`, (中文(简体) ), `MIGRATION_DATA_LOST`, (中文(简体) ), `MIGRATION_CONFLICT`, (中文(简体) ), `MIGRATION_SCRATCH_UNSAFE`。 。 。 .

## 失败矩阵

`test/scanner.test.ts` 覆盖了没有数据库的静态病例:重复的修改代号,折叠的父母,和多头,都只用 Python AST 读取.

`test/postgres.e2e.test.ts` 覆盖一次性 PostgreSQL 实例上的引擎运行案例。 它被跳过,有印刷的原因,除非 `GATEFORGE_ALEMBIC_TEST_ADMIN_URL` 设置为丢弃实例的管理员 URL(例如 CI) `postgres` 服务集装箱). `GATEFORGE_ALEMBIC_TEST_PYTHON` 可选择选择一个已经拥有 Alembic, SQLAlchemy 和 PostgreSQL 驱动程序; 它默认为 `python3`。 。 。 .

| 大小写 | 原因代码 |
| --- | --- |
| 模式改变,没有在同一变化中迁移 | `MIGRATION_MISSING` |
| `downgrade()` 空或不完整 | `MIGRATION_DOWNGRADE_NOOP` |
| 迁移链与模型不符 | `MIGRATION_DRIFT` |
| 种子装入后的破坏性重命名 | `MIGRATION_DATA_LOST` |
| 两个分支更改同一个表格,合并结果保留两个头 | `MIGRATION_CONFLICT` |
| 合并修订断开合并结果上的种子行 | `MIGRATION_DATA_LOST` |
| 在抓取数据库创建后立即注入失败 | `MIGRATION_ROUNDTRIP_FAILED`,数据库已删除 |

套房还声称,只有 `gf_tmp_<id>` 在运行中记录的名称被删除:一个类似命名的现有数据库和所配置的应用程序数据库都以其数据存活.

`packages/cli/test/alembic-first-run.test.ts` 证明设置流程结束为结束: 复制 `examples/alembic` 进入新仓库, 运行 `gateforge init`,然后运行 `check` 财务报告和审定财务报表 `next`。如果没有块块,运行将完全不产生任何义务;通过它,引擎在可支配数据库上见证链条,而诚实的例子不会产生迁移结果。 之后编辑模型 `check` 财务报告和审定财务报表 `next` 报告 `MIGRATION_DRIFT`。它被跳过,带有印刷原因,除非 `GATEFORGE_ALEMBIC_TEST_ADMIN_URL` 已经设定,它需要 `python3` 来搭载 Alembic, SQLAlchemy, 和一个 PostgreSQL 驱动程序, 因为引擎运行 `python3` 就像生产一样.

## 常见问题

### @gate-forge/pack-alembic 是什么？

Alembic 迁移义务包:静地行道验证,引擎运行在可支配数据库上的回转,数据保存检查,多开发者合并安全\.

### 如何安装 @gate-forge/pack-alembic？

在项目目录运行 npm install @gate-forge/pack-alembic，或使用 pnpm add / yarn add / bun add。

### @gate-forge/pack-alembic 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @gate-forge/pack-alembic 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @gate-forge/pack-alembic 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @gate-forge/pack-alembic 可以商用吗？

@gate-forge/pack-alembic 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @gate-forge/pack-alembic 的下载量有多少？

根据 npm 官方下载统计，@gate-forge/pack-alembic 在 2026/10/16 – 2026/11/14 这 30 天内被下载 2,445 次，日均约 82 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gate-forge/pack-alembic 还在维护吗？

最新版本 0\.19\.2 发布于 2026/11/10（5 天前）；至今共发布 34 个版本，其中过去 12 个月发布了 34 个；首次发布于 2026/10/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

