drizzle-kit check
This guide assumes familiarity with:
drizzle-kit check
命令允许你检查生成的 SQL 迁移历史记录的一致性。
当多个开发者在同一个项目上工作,并在不同分支上修改数据库架构时,这种方法非常有用。 - 了解更多关于 团队迁移 的信息。
drizzle-kit check
命令要求你指定 dialect
和数据库连接凭据,你可以通过 drizzle.config.ts 配置文件或 CLI 选项进行设置。
With config file
As CLI options
// drizzle.config.ts
import { defineConfig } from "drizzle-kit";
export default defineConfig({
dialect: "postgresql",
});
npx drizzle-kit check
一个项目中的多个配置文件
项目中可以有多个配置文件,当同一个项目有多个数据库阶段或多个数据库时,这非常有用:
npm
yarn
pnpm
bun
npx drizzle-kit 迁移 --config=drizzle-dev.config.ts drizzle-kit 迁移--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 | required | 你正在使用的数据库方言。可以是 postgresql 、mysql 或 sqlite |
out | migrations 文件夹,默认值=./drizzle | |
config | 配置文件路径,默认值:drizzle.config.ts |
npm
yarn
pnpm
bun
npx drizzle-kit 检查 --dialect=postgresql drizzle-kit 检查 --dialect=postgresql --out=./migrations-folder