Drizzle 迁移基础
SQL 数据库要求你在一开始就为要存储的实体指定一个严格的 schema，如果（当）你需要更改这些实体的结构，你就需要通过schema 迁移来完成。
管理数据库迁移有多种适合生产环境的方式。
Drizzle 的设计目标是完美适配所有这些方式，无论你采用的是 database first 还是 codebase first。
Database first 是指你的数据库 schema 是事实来源。你要么直接在数据库上管理 schema，要么通过数据库迁移工具管理，然后再把数据库 schema 拉取到代码库中的应用层实体。
Codebase first 是指你代码库中的数据库 schema 是事实来源，并且受版本控制。你在 JavaScript/TypeScript 中声明并管理数据库 schema，然后再通过 Drizzle、直接操作或外部迁移工具将该 schema 应用到数据库中。
Drizzle 能如何帮忙？
我们构建了 drizzle-kit —— 一个用于配合 Drizzle 管理迁移的 CLI 应用。
drizzle-kit migrate
drizzle-kit generate
drizzle-kit push
drizzle-kit pull
drizzle-kit export
它的设计目标是让你能根据当前业务需求自由选择迁移方式。
它同时适用于 database first 和 codebase first 两种方式；它允许你推送 schema、生成 SQL migration 文件，或者从数据库拉取 schema。
无论你是单独工作还是团队协作，它都非常适合。
现在让我们为你的项目选择最佳方案：
选项 1
我自己使用外部迁移工具管理数据库 schema，或者直接在数据库上运行 SQL 迁移。
我只需要 Drizzle 帮我从数据库获取当前 schema 状态，并将其保存为 TypeScript schema 文件。
这是一种 database first 方式。你的数据库 schema 是 事实来源，而
Drizzle 允许你使用 drizzle-kit pull 命令将数据库 schema 拉取为 TypeScript。
┌────────────────────────┐ ┌─────────────────────────┐
│ │ <--- CREATE TABLE "users" (
┌──────────────────────────┐ │ │ "id" INT4 PRIMARY KEY,
│ ~ drizzle-kit pull │ │ │ "name" STRING,
└─┬────────────────────────┘ │ DATABASE │ "email" STRING UNIQUE
│ │ │ );
└ 拉取数据库 schema -----> │ │
┌ 生成 Drizzle <----- │ │
│ schema TypeScript 文件 └────────────────────────┘
│
v
import * as p from "drizzle-orm/cockroach-core";
export const users = p.cockroachTable("users", {
id: p.int4().primaryKey(),
name: p.string(),
email: p.string(),
}, (table) => [
uniqueIndex("users_email_key").using("btree", table.email.asc()),
]);
选项 2
我想把数据库 schema 放在我的 TypeScript 代码库里，
我不想处理 SQL migration 文件。
我希望 Drizzle 直接把我的 schema “推送” 到数据库
这是一种 codebase first 方式。你的 TypeScript Drizzle schema 是 事实来源，而
Drizzle 允许你使用 drizzle-kit push 命令将 schema 变更推送到数据库。
这是快速原型开发的最佳方式，我们已经看到很多团队和独立开发者
成功将其作为生产应用的主要迁移流程。
import * as p from "drizzle-orm/cockroach-core";
export const users = p.cockroachTable("users", {
id: p.int4().primaryKey(),
name: p.string(),
email: p.string().unique(), // <--- 新增列
});
向 `users` 表添加列
┌────────────────────────────┐
│ + email: string().unique() │
└─┬──────────────────────────┘
│
v
┌──────────────────────────┐
│ ~ drizzle-kit push │
└─┬────────────────────────┘
│ ┌──────────────────────────┐
└ 拉取当前数据库 schema -----------------> │ │
│ │
┌ 根据差异生成变更 <-------------------- │ DATABASE │
│ │ │
└ 将迁移应用到数据库 --------------------> │ │
│ └──────────────────────────┘
│
┌────────────────────────────────────┴──────────────────────┐
ALTER TABLE "users" ADD COLUMN "email" string;
CREATE UNIQUE INDEX "users_email_key" ON "users" ("email");
选项 3
我想把数据库 schema 放在我的 TypeScript 代码库里，
我希望 Drizzle 为我生成 SQL migration 文件，并将它们应用到我的数据库
这是一种 codebase first 方式。你的 TypeScript Drizzle schema 是事实来源，
Drizzle 允许你使用 drizzle-kit generate 根据 schema 变更生成 SQL migration 文件，
然后再使用 drizzle-kit migrate 命令将它们应用到数据库。
import * as p from "drizzle-orm/cockroach-core";
export const users = p.cockroachTable("users", {
id: p.int4().primaryKey(),
name: p.string(),
email: p.string().unique(),
});
┌────────────────────────┐
│ $ drizzle-kit generate │
└─┬──────────────────────┘
│
└ 1. 读取之前的 migration 文件夹
2. 找出当前 schema 与上一个 schema 的差异
3. 如有必要，提示开发者进行重命名确认
┌ 4. 生成 SQL migration 并持久化到文件
│ ┌─┴───────────────────────────────────────┐
│ 📂 drizzle
│ └ 📂 20242409125510_premium_mister_fear
│ ├ 📜 snapshot.json
│ └ 📜 migration.sql
v
-- drizzle/20242409125510_premium_mister_fear/migration.sql
CREATE TABLE "users" (
"id" int4 PRIMARY KEY,
"name" string,
"email" string,
CONSTRAINT "users_email_key" UNIQUE("email")
);
┌───────────────────────┐
│ $ drizzle-kit migrate │
└─┬─────────────────────┘
│ ┌──────────────────────────┐
└ 1. 读取 migrations 文件夹中的 migration.sql 文件 │ │
2. 从数据库获取 migration 历史 ---------------------> │ │
┌ 3. 选出之前尚未应用的 migration <--------------------- │ DATABASE │
└ 4. 将新的 migration 应用到数据库 ---------------------> │ │
│ │
└──────────────────────────┘
[✓] 完成！
选项 4
我想把数据库 schema 放在我的 TypeScript 代码库里，
我希望 Drizzle 为我生成 SQL migration 文件，并且我希望 Drizzle 在运行时应用它们
这是一种 codebase first 方式。你的 TypeScript Drizzle schema 是事实来源，
Drizzle 允许你使用 drizzle-kit generate 根据 schema 变更生成 SQL migration 文件，然后
你可以在应用运行时将它们应用到数据库中。
这种方式广泛用于 单体 应用中，在零停机部署过程中应用数据库迁移，
并在出现问题时回滚 DDL 变更。
它也用于 serverless 部署，在部署过程中通过 custom resource 运行一次迁移。
import * as p from "drizzle-orm/cockroach-core";
export const users = p.cockroachTable("users", {
id: p.int4().primaryKey(),
name: p.string(),
email: p.string().unique(),
});
┌────────────────────────┐
│ $ drizzle-kit generate │
└─┬──────────────────────┘
│
└ 1. 读取之前的 migration 文件夹
2. 找出当前 schema 与上一个 schema 的差异
3. 如有必要，提示开发者进行重命名确认
┌ 4. 生成 SQL migration 并持久化到文件
│ ┌─┴───────────────────────────────────────┐
│ 📂 drizzle
│ └ 📂 20242409125510_premium_mister_fear
│ ├ 📜 snapshot.json
│ └ 📜 migration.sql
v
-- drizzle/20242409125510_premium_mister_fear/migration.sql
CREATE TABLE "users" (
"id" int4 PRIMARY KEY,
"name" string,
"email" string,
CONSTRAINT "users_email_key" UNIQUE("email")
);
// index.ts
import { drizzle } from "drizzle-orm/cockroach"
import { migrate } from 'drizzle-orm/cockroach/migrator';
const db = drizzle(process.env.DATABASE_URL);
await migrate(db);
┌───────────────────────┐
│ npx tsx src/index.ts │
└─┬─────────────────────┘
│
├ 1. 初始化数据库连接 ┌──────────────────────────┐
└ 2. 读取 migrations 文件夹中的 migration.sql 文件 │ │
3. 从数据库获取 migration 历史 ---------------------> │ │
┌ 4. 选出之前尚未应用的 migration <--------------------- │ DATABASE │
└ 5. 将新的 migration 应用到数据库 ---------------------> │ │
│ │
└──────────────────────────┘
[✓] 完成！
选项 5
我想把数据库 schema 放在我的 TypeScript 代码库里，
我希望 Drizzle 为我生成 SQL migration 文件，
但我会自己或通过外部迁移工具将它们应用到数据库中
这是一种 codebase first 方式。你的 TypeScript Drizzle schema 是事实来源，
Drizzle 允许你使用 drizzle-kit generate 根据 schema 变更生成 SQL migration 文件，然后
你可以直接或通过外部迁移工具将它们应用到数据库。
import * as p from "drizzle-orm/cockroach-core";
export const users = p.cockroachTable("users", {
id: p.int4().primaryKey(),
name: p.string(),
email: p.string().unique(),
});
┌────────────────────────┐
│ $ drizzle-kit generate │
└─┬──────────────────────┘
│
└ 1. 读取之前的 migration 文件夹
2. 找出当前 scheama 与上一个 schema 的差异
3. 如有必要，提示开发者进行重命名确认
┌ 4. 生成 SQL migration 并持久化到文件
│ ┌─┴───────────────────────────────────────┐
│ 📂 drizzle
│ └ 📂 20242409125510_premium_mister_fear
│ ├ 📜 snapshot.json
│ └ 📜 migration.sql
v
-- drizzle/20242409125510_premium_mister_fear/migration.sql
CREATE TABLE "users" (
"id" int4 PRIMARY KEY,
"name" string,
"email" string,
CONSTRAINT "users_email_key" UNIQUE("email")
);
┌───────────────────────────────────┐
│ (._.) 现在你运行你的 migrations │
└─┬─────────────────────────────────┘
│
直接应用到数据库
│ ┌────────────────────┐
├────────────────────────────────────┬───>│ │
│ │ │ Database │
或通过外部工具 │ │ │
│ │ └────────────────────┘
│ ┌────────────────────┐ │
└──│ Bytebase ├────────────┘
├────────────────────┤
│ Liquibase │
├────────────────────┤
│ Atlas │
├────────────────────┤
│ 等等… │
└────────────────────┘
[✓] 完成！
选项 6
我想把数据库 schema 放在我的 TypeScript 代码库里，
我希望 Drizzle 将我的 Drizzle schema 的 SQL 表达输出到控制台，
然后我会通过 Atlas 将它们应用到我的数据库
这是一种 codebase first 方式。你的 TypeScript Drizzle schema 是事实来源，
Drizzle 允许你使用 drizzle-kit export 基于 schema 变更导出 SQL 语句，然后
你可以通过 Atlas 或其他外部 SQL migration 工具将它们应用到数据库中。
import * as p from "drizzle-orm/cockroach-core";
export const users = p.cockroachTable("users", {
id: p.int4().primaryKey(),
name: p.string(),
email: p.string().unique(),
});
┌────────────────────────┐
│ $ drizzle-kit export │
└─┬──────────────────────┘
│
└ 1. 读取你的 drizzle schema
2. 生成你的 schema 的 SQL 表达
┌ 3. 输出到控制台
│
│
v
CREATE TABLE "users" (
"id" int4 PRIMARY KEY,
"name" string,
"email" string,
CONSTRAINT "users_email_key" UNIQUE("email")
);
┌───────────────────────────────────┐
│ (._.) 现在你运行你的 migrations │
└─┬─────────────────────────────────┘
│
通过 Atlas
│ ┌──────────────┐
│ ┌────────────────────┐ │ │
└──│ Atlas ├───────────>│ 数据库 │
└────────────────────┘ │ │
└──────────────┘
[✓] 完成！
