`drizzle-kit check`

This guide assumes familiarity with:

Get started with Drizzle and drizzle-kit - read here
Drizzle schema fundamentals - read here
Database connection basics - read here
Drizzle migrations fundamentals - read here
Drizzle Kit overview and config file
drizzle-kit generate command - read here

drizzle-kit check command lets you check consistency of your generated SQL migrations history.

That’s extremely useful when you have multiple developers working on the project and altering database schema on different branches - read more about migrations for teams.

drizzle-kit check command requires you to specify dialect, you can provide it either via drizzle.config.ts config file or via CLI options

With config file

As CLI options

// drizzle.config.ts
import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "cockroach",
});

npx drizzle-kit check

npx drizzle-kit check --dialect=cockroach

Multiple configuration files in one project

You can have multiple config files in the project, it’s very useful when you have multiple database stages or multiple databases on the same project:

npm

yarn

pnpm

bun

npx drizzle-kit check --config=drizzle-dev.config.ts
npx drizzle-kit check --config=drizzle-prod.config.ts

yarn drizzle-kit check --config=drizzle-dev.config.ts
yarn drizzle-kit check --config=drizzle-prod.config.ts

pnpm drizzle-kit check --config=drizzle-dev.config.ts
pnpm drizzle-kit check --config=drizzle-prod.config.ts

bunx drizzle-kit check --config=drizzle-dev.config.ts
bunx 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

Ignore conflicts

In case you need check command to skip commutativity checks and bypass it, you can use --ignore-conflicts. If there is a situation you want to use it, then there is a big chance that drizzle-kit didn’t check migrations right and it’s a bug. Please report us your case, so we can fix it

drizzle-kit check --ignore-conflicts

Extended list of configurations

We recommend configuring drizzle-kit through drizzle.config.ts file, yet you can provide all configuration options through CLI if necessary, e.g. in CI/CD pipelines, etc.


`dialect`	`required`	Database dialect you are using. Can be one of `postgresql` `mysql` `sqlite` `turso` `singlestore` `mssql` `cockroach`
`out`		Migrations folder, default=`./drizzle`
`config`		Configuration file path, default=`drizzle.config.ts`

npm

yarn

pnpm

bun

npx drizzle-kit check --dialect=cockroach
npx drizzle-kit check --dialect=cockroach --out=./migrations-folder

yarn drizzle-kit check --dialect=cockroach
yarn drizzle-kit check --dialect=cockroach --out=./migrations-folder

pnpm drizzle-kit check --dialect=cockroach
pnpm drizzle-kit check --dialect=cockroach --out=./migrations-folder

bunx drizzle-kit check --dialect=cockroach
bunx drizzle-kit check --dialect=cockroach --out=./migrations-folder