# @blackglory/better-sqlite3-migrations 中文文档

规范地址：https://npmcn.com/package/%40blackglory/better-sqlite3-migrations/

版本：0\.2\.3
npm 元数据更新时间：2026-10-11T15:36:11.089Z
中文译文更新时间：2026-11-08T05:57:19.104Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40blackglory/better-sqlite3-migrations
原文对照：https://npmcn.com/package/%40blackglory/better-sqlite3-migrations/?lang=original
项目主页：https://github.com/BlackGlory/better-sqlite3-migrations#readme
源码仓库：https://github.com/BlackGlory/better-sqlite3-migrations

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

- 包体积（解压后）：14.6 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：3 个
- peer 依赖：better-sqlite3 ^7\.0\.0 \|\| ^8\.0\.0 \|\| ^9\.0\.0 \|\| ^10\.0\.0 \|\| ^11\.0\.0 \|\| ^12\.0\.0 \|\| ^13\.0\.0
- 首次发布：2020-10-19T04:44:36.845Z
- 最新版本发布：2026-10-11T15:36:10.882Z
- 近 30 天下载量：1917（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：24（近 12 个月 4 个）

## 中文简介

使用更好的sqlite3 的数据库迁移工具

## 安装

```sh
npm install @blackglory/better-sqlite3-migrations
```

也可以使用：`pnpm add @blackglory/better-sqlite3-migrations`、`yarn add @blackglory/better-sqlite3-migrations`、`bun add @blackglory/better-sqlite3-migrations`

## README

# 3 -- -- 移徙

数据库迁移工具 [较好的sqlite3](https://www.npmjs.com/package/better-sqlite3)。 。 。 .

使用 [用户版本( v)](https://www.sqlite.org/pragma.html#pragma_user_version) 以记录计划版本.

## 安装

```sh
npm install --save @blackglory/better-sqlite3-migrations
```

## API 密码

```ts
interface IMigration {
  // An integer starting from 1
  version: number

  up: string | ((db: Database) => void)
  down: string | ((db: Database) => void)
}
```

你也许需要 [迁移文件](https://github.com/BlackGlory/migration-files)。 。 。 .

### 移徙

```ts
function migrate(
  db: Database
, migrations: IMigration[]
, options?: {
    targetVersion?: number
    throwOnNewerVersion?: boolean = false
  }
): void
```

若为 `options.targetVersion` 实值 `undefined`, (中文(简体) ), 最大版本的 `migrations` 已使用.

当已知最大迁移版本小于 `user_version`, (中文(简体) ), 说明本案已经过时了.

-   何时 `options.throwOnNewerVersion` 实值 `false` (违约), 它会跳过迁移, 所以,你的过时案例 继续运行.
-   何时 `options.throwOnNewerVersion` 实值 `true`, (中文(简体) ), 将犯错误, 所以,你过时的案例 立即失败.

#### 多种情况能否平行迁移?

是的,那个 `user_version` 每个数据库连接都可以看到更新.

每次迁移都使用 `BEGIN IMMEDIATE` 以确保并行写入交易提前失败. 因此,你可能需要一个适当的重试策略.

## 常见问题

### @blackglory/better-sqlite3-migrations 是什么？

使用更好的sqlite3 的数据库迁移工具

### 如何安装 @blackglory/better-sqlite3-migrations？

在项目目录运行 npm install @blackglory/better-sqlite3-migrations，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：better-sqlite3（^7\.0\.0 \|\| ^8\.0\.0 \|\| ^9\.0\.0 \|\| ^10\.0\.0 \|\| ^11\.0\.0 \|\| ^12\.0\.0 \|\| ^13\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @blackglory/better-sqlite3-migrations 支持 TypeScript 吗？

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

### @blackglory/better-sqlite3-migrations 支持 ESM 还是 CommonJS？

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

### @blackglory/better-sqlite3-migrations 需要什么版本的 Node\.js？

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

### @blackglory/better-sqlite3-migrations 可以商用吗？

@blackglory/better-sqlite3-migrations 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @blackglory/better-sqlite3-migrations 的下载量有多少？

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

### @blackglory/better-sqlite3-migrations 还在维护吗？

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