`drizzle-kit up`

This guide assumes familiarity with:

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

drizzle-kit up command lets you upgrade drizzle schema snapshots to a newer version. It’s required whenever we introduce breaking changes to the json snapshots of the schema and upgrade the internal version.

drizzle-kit up command requires you to specify both dialect and database connection credentials, you can provide them 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: "postgresql",
});

npx drizzle-kit up

npx drizzle-kit up --dialect=postgresql

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 migrate --config=drizzle-dev.config.ts
npx drizzle-kit migrate --config=drizzle-prod.config.ts

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

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

bun drizzle-kit migrate --config=drizzle-dev.config.ts
bun 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

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 `postgresql`,`mysql` or `sqlite`
`out`		migrations folder, default=`./drizzle`
`config`		config file path, default=`drizzle.config.ts`

npm

yarn

pnpm

bun

npx drizzle-kit up --dialect=postgresql
npx drizzle-kit up --dialect=postgresql --out=./migrations-folder

yarn drizzle-kit up --dialect=postgresql
yarn drizzle-kit up --dialect=postgresql --out=./migrations-folder

pnpm drizzle-kit up --dialect=postgresql
pnpm drizzle-kit up --dialect=postgresql --out=./migrations-folder

bun drizzle-kit up --dialect=postgresql
bun drizzle-kit up --dialect=postgresql --out=./migrations-folder