使用 Drizzle Kit 进行迁移

本指南假定您已熟悉：

开始使用 Drizzle 和 drizzle-kit - 在这里阅读
Drizzle schema 基础 - 在这里阅读
数据库连接基础 - 在这里阅读
Drizzle 迁移基础 - 在这里阅读

Drizzle Kit 是一个用于管理 Drizzle SQL 数据库迁移的 CLI 工具。

npm

yarn

pnpm

bun

npm i -D drizzle-kit

yarn add -D drizzle-kit

pnpm add -D drizzle-kit

bun add -D drizzle-kit

IMPORTANT

请务必先阅读 Drizzle 的入门指南和迁移基础，并选择最适合你业务需求的 SQL 迁移流程。

基于你的 schema，Drizzle Kit 可以让你生成并运行 SQL 迁移文件，直接将 schema 推送到数据库，从数据库拉取 schema，启动 drizzle studio，并提供一些实用命令。

npm

yarn

pnpm

bun

npx drizzle-kit generate
npx drizzle-kit migrate
npx drizzle-kit push
npx drizzle-kit pull
npx drizzle-kit check
npx drizzle-kit up
npx drizzle-kit studio
npx drizzle-kit export

yarn drizzle-kit generate
yarn drizzle-kit migrate
yarn drizzle-kit push
yarn drizzle-kit pull
yarn drizzle-kit check
yarn drizzle-kit up
yarn drizzle-kit studio
yarn drizzle-kit export

pnpm drizzle-kit generate
pnpm drizzle-kit migrate
pnpm drizzle-kit push
pnpm drizzle-kit pull
pnpm drizzle-kit check
pnpm drizzle-kit up
pnpm drizzle-kit studio
pnpm drizzle-kit export

bunx drizzle-kit generate
bunx drizzle-kit migrate
bunx drizzle-kit push
bunx drizzle-kit pull
bunx drizzle-kit check
bunx drizzle-kit up
bunx drizzle-kit studio
bunx drizzle-kit export


`drizzle-kit generate`	允许你基于 Drizzle schema 在声明时或后续变更时生成 SQL 迁移文件，见此处。
`drizzle-kit migrate`	允许你将生成的 SQL 迁移文件应用到数据库，见此处。
`drizzle-kit pull`	允许你拉取（反向解析）数据库 schema，将其转换为 Drizzle schema 并保存到你的代码库中，见此处
`drizzle-kit push`	允许你在声明时或后续 schema 变更时将 Drizzle schema 推送到数据库，见此处
`drizzle-kit studio`	将连接到你的数据库并为 Drizzle Studio 启动代理服务器，你可以用它方便地浏览数据库，见此处
`drizzle-kit check`	将遍历所有生成的迁移并检查生成的迁移是否存在任何竞态条件（冲突），见此处
`drizzle-kit up`	用于升级先前生成的迁移快照，见此处
`drizzle-kit export`	用于将 TypeScript schema 转换为原始 SQL DDL 并输出，见此处

Drizzle Kit 通过 drizzle.config.ts 配置文件或 CLI 参数进行配置。
至少需要提供 SQL dialect 和 schema 路径，让 Drizzle Kit 知道如何生成迁移。

📦 <project root>
 ├ 📂 drizzle
 ├ 📂 src
 ├ 📜 .env
 ├ 📜 drizzle.config.ts  <--- Drizzle 配置文件
 ├ 📜 package.json
 └ 📜 tsconfig.json

simple config

extended config

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "cockroach",
  schema: "./src/schema.ts",
});

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  out: "./drizzle",
  dialect: "cockroach",
  schema: "./src/schema.ts",

  entities: {
    roles: {
      exclude: ["admin"],
      include: ["user"],
      provider: "supabase",
    },
  },

  dbCredentials: {
    url: "./database/",
  },

  schemaFilter: "public",
  tablesFilter: "*",

  introspect: {
    casing: "camel",
  },

  migrations: {
    table: "__drizzle_migrations__",
    schema: "public",
  },

  breakpoints: true,
  verbose: true,
});

你可以通过 CLI 参数提供 Drizzle Kit 配置路径，当你有多个数据库阶段、多个数据库，或者同一项目中的不同数据库时，这非常有用：

npm

yarn

pnpm

bun

npx drizzle-kit push --config=drizzle-dev.drizzle.config
npx drizzle-kit push --config=drizzle-prod.drizzle.config

yarn drizzle-kit push --config=drizzle-dev.drizzle.config
yarn drizzle-kit push --config=drizzle-prod.drizzle.config

pnpm drizzle-kit push --config=drizzle-dev.drizzle.config
pnpm drizzle-kit push --config=drizzle-prod.drizzle.config

bunx drizzle-kit push --config=drizzle-dev.drizzle.config
bunx drizzle-kit push --config=drizzle-prod.drizzle.config

📦 <project root>
 ├ 📂 drizzle
 ├ 📂 src
 ├ 📜 .env
 ├ 📜 drizzle-dev.config.ts
 ├ 📜 drizzle-prod.config.ts
 ├ 📜 package.json
 └ 📜 tsconfig.json