drizzle-kit check
This guide assumes familiarity with:
drizzle-kit check
命令可以让你检查生成的 SQL 迁移历史的一致性。
当多个开发者在项目中工作并在不同的分支上更改数据库模式时, 这非常有用 - 了解更多有关 团队迁移。
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
📦 <项目根目录>
├ 📂 drizzle
├ 📂 src
├ 📜 .env
├ 📜 drizzle-dev.config.ts
├ 📜 drizzle-prod.config.ts
├ 📜 package.json
└ 📜 tsconfig.json
扩展配置选项列表
我们推荐通过 drizzle.config.ts 文件配置 drizzle-kit
,
但如有必要,你也可以通过 CLI 提供所有配置选项,例如在 CI/CD 管道中等。
dialect | required | 你正在使用的数据库方言。可以是 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