Drizzle 迁移基础
SQL 数据库要求您**预先指定**要存储的实体**严格模式**，如果您（何时）需要更改这些实体的形状，则需要通过**模式迁移**来完成。
有多种生产级方法来管理数据库迁移。Drizzle 旨在完美适应所有这些方法，无论您是采用**数据库优先**还是**代码库优先**。
**数据库优先**是指您的数据库模式是真理的来源。您可以直接在数据库上或通过数据库迁移工具管理数据库模式，然后将数据库模式拉取到代码库应用程序级别的实体。
**代码库优先**是指代码库中的数据库模式是真理的来源并受版本控制。您在 JavaScript/TypeScript 中声明和管理数据库模式，然后通过 Drizzle、直接或通过外部迁移工具将该模式应用于数据库本身。
Drizzle 如何提供帮助？
我们构建了 **drizzle-kit** - 用于使用 Drizzle 管理迁移的 CLI 应用程序。
drizzle-kit migrate
drizzle-kit generate
drizzle-kit push
drizzle-kit pull
它旨在让您根据当前的业务需求选择如何进行迁移。
它适用于数据库优先和代码库优先两种方法，它允许您**推送模式**、**生成 SQL 迁移**文件或从数据库**拉取模式**。无论您是单独工作还是在团队中工作，它都是完美的。
现在让我们为您的项目选择最佳选项
选项 1
我使用外部迁移工具或直接在数据库上运行 SQL 迁移来管理数据库模式。对于 Drizzle，我只需要从数据库获取当前模式状态并将其保存为 TypeScript 模式文件。
这是一种**数据库优先**方法。您的数据库模式是**真理的来源**，Drizzle 允许您使用 drizzle-kit pull 命令将数据库模式拉取到 TypeScript。
┌────────────────────────┐ ┌─────────────────────────┐
│ │ <--- CREATE TABLE "users" (
┌──────────────────────────┐ │ │ "id" SERIAL PRIMARY KEY,
│ ~ drizzle-kit pull │ │ │ "name" TEXT,
└─┬────────────────────────┘ │ DATABASE │ "email" TEXT UNIQUE
│ │ │ );
└ Pull datatabase schema -----> │ │
┌ Generate Drizzle <----- │ │
│ schema TypeScript file └────────────────────────┘
│
v
import * as p from "drizzle-orm/pg-core";
export const users = p.pgTable("users", {
id: p.serial().primaryKey(),
name: p.text(),
email: p.text().unique(),
};
选项 2
我希望在我的 TypeScript 代码库中拥有数据库模式，我不想处理 SQL 迁移文件。
我希望 Drizzle 直接将我的模式“推送”到数据库
这是一种**代码库优先**方法。您的 TypeScript Drizzle 模式是**真理的来源**，Drizzle 允许您使用 drizzle-kit push 命令将模式更改推送到数据库。
这是快速原型开发的最佳方法，我们已经看到数十个团队和独立开发者成功地将其作为生产应用程序中的主要迁移流程。
import * as p from "drizzle-orm/pg-core";
export const users = p.pgTable("users", {
id: p.serial().primaryKey(),
name: p.text(),
email: p.text().unique(), // <--- added column
};
Add column to `users` table
┌──────────────────────────┐
│ + email: text().unique() │
└─┬────────────────────────┘
│
v
┌──────────────────────────┐
│ ~ drizzle-kit push │
└─┬────────────────────────┘
│ ┌──────────────────────────┐
└ Pull current datatabase schema ---------> │ │
│ │
┌ Generate alternations based on diff <---- │ DATABASE │
│ │ │
└ Apply migrations to the database -------> │ │
│ └──────────────────────────┘
│
┌────────────────────────────────────┴──────────────┐
ALTER TABLE `users` ADD COLUMN `email` TEXT UNIQUE;
选项 3
我希望在我的 TypeScript 代码库中拥有数据库模式，我希望 Drizzle 为我生成 SQL 迁移文件并将其应用于我的数据库
这是一种**代码库优先**方法。您的 TypeScript Drizzle 模式是真理的来源，Drizzle 允许您使用 drizzle-kit generate 根据您的模式更改生成 SQL 迁移文件，然后使用 drizzle-kit migrate 命令将其应用于数据库。
import * as p from "drizzle-orm/pg-core";
export const users = p.pgTable("users", {
id: p.serial().primaryKey(),
name: p.text(),
email: p.text().unique(),
};
┌────────────────────────┐
│ $ drizzle-kit generate │
└─┬──────────────────────┘
│
└ 1. read previous migration folders
2. find diff between current and previous schema
3. prompt developer for renames if necessary
┌ 4. generate SQL migration and persist to file
│ ┌─┴───────────────────────────────────────┐
│ 📂 drizzle
│ └ 📂 20242409125510_premium_mister_fear
│ ├ 📜 snapshot.json
│ └ 📜 migration.sql
v
-- drizzle/20242409125510_premium_mister_fear/migration.sql
CREATE TABLE "users" (
"id" SERIAL PRIMARY KEY,
"name" TEXT,
"email" TEXT UNIQUE
);
┌───────────────────────┐
│ $ drizzle-kit migrate │
└─┬─────────────────────┘
│ ┌──────────────────────────┐
└ 1. read 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!
选项 4
我希望在我的 TypeScript 代码库中拥有数据库模式，我希望 Drizzle 为我生成 SQL 迁移文件，并且我希望 Drizzle 在运行时应用它们
这是一种**代码库优先**方法。您的 TypeScript Drizzle 模式是真理的来源，Drizzle 允许您使用 drizzle-kit generate 根据您的模式更改生成 SQL 迁移文件，然后您可以在应用程序运行时将其应用于数据库。
这种方法广泛用于**单体**应用程序，您可以在零停机部署期间应用数据库迁移，并在出现故障时回滚 DDL 更改。它也用于**无服务器**部署，迁移在部署过程中作为**自定义资源**运行一次。
import * as p from "drizzle-orm/pg-core";
export const users = p.pgTable("users", {
id: p.serial().primaryKey(),
name: p.text(),
email: p.text().unique(),
};
┌────────────────────────┐
│ $ drizzle-kit generate │
└─┬──────────────────────┘
│
└ 1. read previous migration folders
2. find diff between current and previous schema
3. prompt developer for renames if necessary
┌ 4. generate SQL migration and persist to file
│ ┌─┴───────────────────────────────────────┐
│ 📂 drizzle
│ └ 📂 20242409125510_premium_mister_fear
│ ├ 📜 snapshot.json
│ └ 📜 migration.sql
v
-- drizzle/20242409125510_premium_mister_fear/migration.sql
CREATE TABLE "users" (
"id" SERIAL PRIMARY KEY,
"name" TEXT,
"email" TEXT UNIQUE
);
// index.ts
import { drizzle } from "drizzle-orm/node-postgres"
import { migrate } from 'drizzle-orm/node-postgres/migrator';
const db = drizzle(process.env.DATABASE_URL);
await migrate(db);
┌───────────────────────┐
│ npx tsx src/index.ts │
└─┬─────────────────────┘
│
├ 1. init database connection ┌──────────────────────────┐
└ 2. read migration.sql files in migrations folder │ │
3. fetch migration history from database -------------> │ │
┌ 4. pick previously unapplied migrations <-------------- │ DATABASE │
└ 5. apply new migration to the database ---------------> │ │
│ │
└──────────────────────────┘
[✓] done!
选项 5
我希望在我的 TypeScript 代码库中拥有数据库模式，我希望 Drizzle 为我生成 SQL 迁移文件，但我将自己或通过外部迁移工具将其应用于我的数据库
这是一种**代码库优先**方法。您的 TypeScript Drizzle 模式是真理的来源，Drizzle 允许您使用 drizzle-kit generate 根据您的模式更改生成 SQL 迁移文件，然后您可以直接或通过外部迁移工具将其应用于数据库。
import * as p from "drizzle-orm/pg-core";
export const users = p.pgTable("users", {
id: p.serial().primaryKey(),
name: p.text(),
email: p.text().unique(),
};
┌────────────────────────┐
│ $ drizzle-kit generate │
└─┬──────────────────────┘
│
└ 1. read previous migration folders
2. find diff between current and previous scheama
3. prompt developer for renames if necessary
┌ 4. generate SQL migration and persist to file
│ ┌─┴───────────────────────────────────────┐
│ 📂 drizzle
│ └ 📂 20242409125510_premium_mister_fear
│ ├ 📜 snapshot.json
│ └ 📜 migration.sql
v
-- drizzle/20242409125510_premium_mister_fear/migration.sql
CREATE TABLE "users" (
"id" SERIAL PRIMARY KEY,
"name" TEXT,
"email" TEXT UNIQUE
);
┌───────────────────────────────────┐
│ (._.) now you run your migrations │
└─┬─────────────────────────────────┘
│
directly to the database
│ ┌────────────────────┐
├────────────────────────────────────┬───>│ │
│ │ │ Database │
or via external tools │ │ │
│ │ └────────────────────┘
│ ┌────────────────────┐ │
└──│ Bytebase ├────────────┘
├────────────────────┤
│ Liquibase │
├────────────────────┤
│ Atlas │
├────────────────────┤
│ etc… │
└────────────────────┘
[✓] done!
选项 6
我希望在我的 TypeScript 代码库中拥有数据库模式，我希望 Drizzle 将我的 Drizzle 模式的 SQL 表示输出到控制台，然后我将通过 Atlas 将它们应用于我的数据库
这是一种**代码库优先**方法。您的 TypeScript Drizzle 模式是真理的来源，Drizzle 允许您使用 drizzle-kit export 根据您的模式更改导出 SQL 语句，然后您可以通过 Atlas 或其他外部 SQL 迁移工具将它们应用于数据库。
import * as p from "drizzle-orm/pg-core";
export const users = p.pgTable("users", {
id: p.serial().primaryKey(),
name: p.text(),
email: p.text().unique(),
};
┌────────────────────────┐
│ $ drizzle-kit export │
└─┬──────────────────────┘
│
└ 1. read your drizzle schema
2. generated SQL representation of your schema
┌ 3. outputs to console
│
│
v
CREATE TABLE "users" (
"id" SERIAL PRIMARY KEY,
"name" TEXT,
"email" TEXT UNIQUE
);
┌───────────────────────────────────┐
│ (._.) now you run your migrations │
└─┬─────────────────────────────────┘
│
via Atlas
│ ┌──────────────┐
│ ┌────────────────────┐ │ │
└──│ Atlas ├───────────>│ Database │
└────────────────────┘ │ │
└──────────────┘
[✓] done!
