Documentation

---

Documentation / @kizami/db / node / migrateDb

Function: migrateDb()

migrateDb(options?): Promise<DatabaseHandle>

Defined in: packages/db/src/migrate.ts:146

指定した接続先(既定は SQLite の in-memory)にマイグレーションを適用し、DB ハンドルを返す。

マイグレーションフォルダはダイアレクトごとに別系統(migrations/ と migrations-pg/)。

D1 では適用しない: Cloudflare D1 のマイグレーションはデプロイ時に wrangler d1 migrations apply が流す(Workers に「起動時に1回」の場所が無いため)。 この関数は Node 専用で D1 ハンドルを作ることは無いが、将来 D1 ハンドルが渡された場合に node:fs 依存のマイグレータへ落ちないよう明示的に skip する。詳細は docs/design/workers-d1.md。

Parameters

options?

CreateDatabaseOptions & object

Returns

Promise<DatabaseHandle>