drizzle-kit migrate
This guide assumes familiarity with:
drizzle-kit migrate 允许你应用由 drizzle-kit generate 生成的 SQL 迁移。它旨在涵盖管理 Drizzle 迁移的 代码优先（选项 3） 方法。
How it works under the hood?
Drizzle Kit migrate 命令会触发一系列事件：
- 通读迁移文件夹并读取所有
.sql 迁移文件
- 连接到数据库并从 drizzle 迁移日志表中获取条目
- 根据之前应用的迁移，决定运行哪些新迁移
- 运行 SQL 迁移并将已应用的迁移记录到 drizzle 迁移表中
├ 📂 drizzle
│ ├ 📂 _meta
│ ├ 📜 0000_premium_mister_fear.sql
│ └ 📜 0001_delicate_professor_xavie.sql
└ …
┌───────────────────────┐
│ $ drizzle-kit migrate │
└─┬─────────────────────┘
│ ┌──────────────────────────┐
└ 1. reads migration.sql files in migrations folder │ │
2. fetch migration history from database -------------> │ │
┌ 3. pick previously unapplied migrations <-------------- │ DATABASE │
└ 4. apply new migration to the database ---------------> │ │
│ │
└──────────────────────────┘
[✓] done!
drizzle-kit migrate 命令要求你指定 dialect 和数据库连接凭据，你可以通过 drizzle.config.ts 配置文件或 CLI 选项进行设置。
With config file
As CLI options
// drizzle.config.ts
import { defineConfig } from "drizzle-kit";
export default defineConfig({
dialect: "postgresql",
schema: "./src/schema.ts",
dbCredentials: {
url: "postgresql://user:password@host:port/dbname"
},
});
npx drizzle-kit migrate
npx drizzle-kit migrate --dialect=postgresql --url=postgresql://user:password@host:port/dbname
已应用的迁移日志记录到数据库中
运行迁移后，Drizzle Kit 会将成功应用的迁移记录保存在你的数据库中。它将将它们存储在名为 __drizzle_migrations 的迁移日志表中。
你可以通过 drizzle 配置文件自定义该表的表和模式（仅限 PostgreSQL）：
export default defineConfig({
dialect: "postgresql",
schema: "./src/schema.ts",
dbCredentials: {
url: "postgresql://user:password@host:port/dbname"
},
migrations: {
table: 'my-migrations-table', // `__drizzle_migrations` by default
schema: 'public', // used in PostgreSQL only, `drizzle` by default
},
});
一个项目中的多个配置文件
项目中可以有多个配置文件，当同一个项目有多个数据库阶段或多个数据库时，这非常有用：
npx drizzle-kit 迁移 --config=drizzle-dev.config.ts drizzle-kit 迁移--config=drizzle-prod.config.ts
yarn drizzle-kit 迁移 --config=drizzle-dev.config.ts drizzle-kit 迁移--config=drizzle-prod.config.ts
pnpm drizzle-kit 迁移 --config=drizzle-dev.config.ts drizzle-kit 迁移--config=drizzle-prod.config.ts
bun drizzle-kit 迁移 --config=drizzle-dev.config.ts drizzle-kit 迁移--config=drizzle-prod.config.ts
📦 <project root>
├ 📂 drizzle
├ 📂 src
├ 📜 .env
├ 📜 drizzle-dev.config.ts
├ 📜 drizzle-prod.config.ts
├ 📜 package.json
└ 📜 tsconfig.json
扩展示例
让我们生成 SQL 迁移，并使用 drizzle-kit generate 和 drizzle-kit migrate 命令将其应用到数据库中。
📦 <project root>
├ 📂 drizzle
├ 📂 src
│ ├ 📜 schema.ts
│ └ 📜 index.ts
├ 📜 drizzle.config.ts
└ …
drizzle.config.ts
src/schema.ts
import { defineConfig } from "drizzle-kit";
export default defineConfig({
dialect: "postgresql",
schema: "./src/schema.ts",
dbCredentials: {
url: "postgresql://user:password@host:port/dbname"
},
migrations: {
table: 'journal',
schema: 'drizzle',
},
});
import * as p from "drizzle-orm/pg-core";
export const users = p.pgTable("users", {
id: p.serial().primaryKey(),
name: p.text(),
})
现在运行
npx drizzle-kit generate --name=init
它将生成
📦 <project root>
├ …
├ 📂 migrations
│ ├ 📂 _meta
│ └ 📜 0000_init.sql
└ …
-- ./drizzle/0000_init.sql
CREATE TABLE "users"(
id serial primary key,
name text
)
现在运行
npx drizzle-kit migrate
我们的 SQL 迁移现已成功应用于数据库。 ✅