drizzle-kit check

本指南假定您熟悉

drizzle-kit check 命令允许您检查生成的 SQL 迁移历史的一致性。

当有多个开发人员在项目上工作并在不同分支上更改数据库 Schema 时,这非常有用——了解更多关于团队迁移的信息。




drizzle-kit check 命令要求您指定 `dialect` 和数据库连接凭据,您可以通过 drizzle.config.ts 配置文件或 CLI 选项提供它们。

使用配置文件
作为 CLI 选项
// drizzle.config.ts
import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "postgresql",
});
npx drizzle-kit check

单个项目中的多个配置文件

您可以在项目中拥有多个配置文件,当您在同一项目中有多个数据库阶段或多个数据库时,这非常有用

npm
yarn
pnpm
bun
npx drizzle-kit migrate --config=drizzle-dev.config.ts
npx drizzle-kit migrate --config=drizzle-prod.config.ts
📦 <project root>
 ├ 📂 drizzle
 ├ 📂 src
 ├ 📜 .env
 ├ 📜 drizzle-dev.config.ts
 ├ 📜 drizzle-prod.config.ts
 ├ 📜 package.json
 └ 📜 tsconfig.json

扩展配置列表

我们建议通过 drizzle.config.ts 文件配置 drizzle-kit,但在必要时,您也可以通过 CLI 提供所有配置选项,例如在 CI/CD 流水线中。

dialect必填您正在使用的数据库方言。可以是 `postgresql`、`mysql` 或 `sqlite`。
out迁移文件夹,默认值为`./drizzle`
config配置文件路径,默认值为`drizzle.config.ts`

npm
yarn
pnpm
bun
npx drizzle-kit check --dialect=postgresql
npx drizzle-kit check --dialect=postgresql --out=./migrations-folder