drizzle-kit check

本指南假定您已熟悉:

drizzle-kit check 命令可让你检查已生成的 SQL migrations 历史的一致性。

当多个开发者在项目中协作,并且在不同分支上修改数据库 schema 时,这个功能非常有用 - 阅读更多关于团队 migrations




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: "mysql",
});
npx drizzle-kit check

一个项目中使用多个配置文件

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

npm
yarn
pnpm
bun
npx drizzle-kit check --config=drizzle-dev.config.ts
npx drizzle-kit check --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 流水线等场景中。

dialectrequired你正在使用的数据库方言。可以是 postgresql mysql sqlite turso singlestore mssql cockroach
outmigrations 文件夹,默认=./drizzle
config配置文件路径,默认=drizzle.config.ts

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