Drizzle Kit configuration file

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 lets you declare configuration options in TypeScript or JavaScript configuration files.

📦 <project root>
 ├ ...
 ├ 📂 drizzle
 ├ 📂 src
 ├ 📜 drizzle.config.ts
 └ 📜 package.json

drizzle.config.ts

drizzle.config.js

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "mysql",
  schema: "./src/schema.ts",
  out: "./drizzle",
});

Example of an extended config file

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  out: "./drizzle",
  dialect: "mysql",
  schema: "./src/schema.ts",

  dbCredentials: {
    url: "mysql://user:password@host:3306/dbname",
  },

  tablesFilter: "*",

  introspect: {
    casing: "camel",
  },

  migrations: {
    table: "__drizzle_migrations__",
  },

  breakpoints: true,
  verbose: true,
});

Expand

Multiple configuration files

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

npm

yarn

pnpm

bun

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

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

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

bunx drizzle-kit generate --config=drizzle-dev.config.ts
bunx drizzle-kit generate --config=drizzle-prod.config.ts

📦 <project root>
 ├ 📂 drizzle
 ├ 📂 src
 ├ 📜 .env
 ├ 📜 drizzle-dev.config.ts
 ├ 📜 drizzle-prod.config.ts
 ├ 📜 package.json
 └ 📜 tsconfig.json

Migrations folder

out param lets you define folder for your migrations, it’s optional and drizzle by default.
It’s very useful since you can have many separate schemas for different databases in the same project and have different migration folders for them.

Migration folder contains folders with .sql migration files which is used by drizzle-kit

📦 <project root>
 ├ ...
 ├ 📂 drizzle
 │ ├ 📂 20242409125510_premium_mister_fear
 │ ├ 📜 user.ts 
 │ ├ 📜 post.ts 
 │ └ 📜 comment.ts 
 ├ 📂 src
 ├ 📜 drizzle.config.ts
 └ 📜 package.json

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "mysql",
  schema: "./src/schema/*",
  out: "./drizzle",
});

---

`dialect`

Dialect of the database you’re using


type	`postgresql` `mysql` `sqlite` `turso` `singlestore` `mssql` `cockroach`
default	—
commands	`generate`, `push`, `pull`, `studio`, `migrate`, `up`, `export`

import { defineConfig } from "drizzle-kit";

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

`schema`

glob based path to drizzle schema file(s) or folder(s) contaning schema files.


type	`string` `string[]`
default	—
commands	`generate`, `push`, `export`, `studio`

Example 1

Example 2

Example 3

Example 4

📦 <project root>
 ├ ...
 ├ 📂 drizzle
 ├ 📂 src
 │ ├ ...
 │ ├ 📜 index.ts
 │ └ 📜 schema.ts 
 ├ 📜 drizzle.config.ts
 └ 📜 package.json

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  schema: "./src/schema.ts",
});

📦 <project root>
 ├ ...
 ├ 📂 drizzle
 ├ 📂 src
 │ ├ 📂 user
 │ │ ├ 📜 handler.ts 
 │ │ └ 📜 schema.ts 
 │ ├ 📂 posts
 │ │ ├ 📜 handler.ts 
 │ │ └ 📜 schema.ts 
 │ └ 📜 index.ts
 ├ 📜 drizzle.config.ts
 └ 📜 package.json

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  schema: "./src/**/schema.ts",
  //or
  schema: ["./src/user/schema.ts", "./src/posts/schema.ts"]
});

📦 <project root>
 ├ ...
 ├ 📂 drizzle
 ├ 📂 src
 │ ├ 📂 schema
 │ │ ├ 📜 user.ts 
 │ │ ├ 📜 post.ts 
 │ │ └ 📜 comment.ts 
 │ └ 📜 index.ts
 ├ 📜 drizzle.config.ts
 └ 📜 package.json

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  schema: "./src/schema/*",
});

📦 <project root>
 ├ ...
 ├ 📂 drizzle
 ├ 📂 src
 │ ├ 📜 userById.ts 
 │ ├ 📜 userByEmail.ts 
 │ ├ 📜 listUsers.ts 
 │ ├ 📜 user.sql.ts 
 │ ├ 📜 postById.ts 
 │ ├ 📜 listPosts.ts 
 │ └ 📜 post.sql.ts 
 │ 📜 index.ts
 ├ 📜 drizzle.config.ts
 └ 📜 package.json

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  schema: "./src/**/*.sql.ts", // Dax's favourite
});

`out`

Defines output folder of your SQL migration files, json snapshots of your schema and schema.ts from drizzle-kit pull command.


type	`string` `string[]`
default	`drizzle`
commands	`generate`, `pull`, `migrate`, `check`, `up`

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  out: "./drizzle", 
});

---

`dbCredentials`

Database connection credentials in a form of url, user:password@host:port/db params or exceptions drivers(aws-data-api d1-http pglite ) specific connection options.


type	`postgresql` `mysql` `sqlite` `turso` `singlestore` `mssql` `cockroach`
default	—
commands	`push`, `pull`, `migrate`, `studio`

Connection string

Connection params

import { defineConfig } from 'drizzle-kit'

export default defineConfig({
  dialect: "mysql",
  dbCredentials: {
    url: "mysql://user:password@host:port/db",
  }
});

import { defineConfig } from 'drizzle-kit'

export default defineConfig({
  dialect: "mysql",
  dbCredentials: {
    host: "host",
    port: 3306,
    user: "user",
    password: "password",
    database: "dbname",
    ssl: "...", // can be: string | SslOptions from mysql2
  }
});

`migrations`

When running drizzle-kit migrate - drizzle will records about successfully applied migrations in your database in log table named __drizzle_migrations.

migrations config options lets you change both migrations log table name and schema.


type	`{ table: string }`
default	`{ table: "__drizzle_migrations" }`
commands	`migrate`, `push`, `pull`

export default defineConfig({
  dialect: "mysql",
  schema: "./src/schema.ts",
  migrations: {
    table: 'my-migrations-table', // `__drizzle_migrations` by default
  },
});

`introspect`

Configuration for drizzle-kit pull command.

casing is responsible for in-code column keys casing


type	`{ casing: "preserve" \| "camel" }`
default	`{ casing: "camel" }`
commands	`pull`

camel

preserve

import * as p from "drizzle-orm/mysql-core"

export const users = p.mysqlTable("users", {
  id: p.int().primaryKey().autoincrement(),
  firstName: p.varchar("first-name", { length: 255 }),
  lastName: p.varchar("LastName", { length: 255 }),
  email: p.varchar("email", { length: 255 }),
  phoneNumber: p.varchar("phone_number", { length: 255 }),
});

SHOW COLUMNS FROM users;

  Field        | Type
--------------+--------------
 id           | int
 first-name   | varchar(255)
 LastName     | varchar(255)
 email        | varchar(255)
 phone_number | varchar(255)

import * as p from "drizzle-orm/mysql-core"

export const users = p.mysqlTable("users", {
  id: p.int().primaryKey().autoincrement(),
  "first-name": p.varchar("first-name", { length: 255 }),
  LastName: p.varchar("LastName", { length: 255 }),
  email: p.varchar("email", { length: 255 }),
  phone_number: p.varchar("phone_number", { length: 255 }),
});

SHOW COLUMNS FROM users;

  Field        | Type
--------------+--------------
 id           | int
 first-name   | varchar(255)
 LastName     | varchar(255)
 email        | varchar(255)
 phone_number | varchar(255)

---

`tablesFilter`

If you want to run multiple projects with one database - check out our guide.

drizzle-kit push and drizzle-kit pull will manage all tables by default. You can configure the list of tables via tablesFilter.

tablesFilter option lets you specify glob based table names filter, e.g. ["users", "user_info"] or "user*"


type	`string` `string[]`
default	—
commands	`push` `pull`

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "mysql",
  tablesFilter: ["users", "posts", "project1_*"],
});

---

`verbose`

Print all SQL statements during drizzle-kit push command.


type	`boolean`
default	`false`
commands	`pull`

export default defineConfig({
  dialect: "mysql",
  verbose: false,
});

`breakpoints`

Drizzle Kit will automatically embed --> statement-breakpoint into generated SQL migration files, that’s necessary for databases that do not support multiple DDL alternation statements in one transaction(MySQL and SQLite).

breakpoints option flag lets you switch it on and off


type	`boolean`
default	`true`
commands	`generate` `pull`

export default defineConfig({
  dialect: "mysql",
  breakpoints: false,
});