better-sqlite3-migrations
A utility for database migrations with better-sqlite3.
The module using user_version to record the schema version.
Install
npm install --save @blackglory/better-sqlite3-migrations
API
interface IMigration {
// An integer starting from 1
version: number
up: string | ((db: Database) => void)
down: string | ((db: Database) => void)
}
You may need migration-files.
migrate
function migrate(
db: Database
, migrations: IMigration[]
, options?: {
targetVersion?: number
throwOnNewerVersion?: boolean = false
}
): void
If options.targetVersion is undefined,
the maximum version of the migrations is used.
When the maximum known migration version is less than the user_version,
it means the current instance is outdated.
- When
options.throwOnNewerVersion is false (default),
it will skip the migration,
so your outdated instance continues to run.
- When
options.throwOnNewerVersion is true,
it will throw an error,
so your outdated instance fails immediately.
Can multiple instances migrate in parallel?
Yes, the user_version update is visible to every database connection.
Each migration uses BEGIN IMMEDIATE to ensure that parallel write transactions fail early.
Therefore, you may need a proper retry strategy.
关于 @blackglory/better-sqlite3-migrations 的常见问题
@blackglory/better-sqlite3-migrations 是什么？
A utility for database migrations with better-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 和提交记录判断。