Drizzle Kit 配置文件

This guide assumes familiarity with:

开始使用 Drizzle 和 drizzle-kit - 点击此处阅读
Drizzle 模式基础知识 - 点击此处阅读
数据库连接基础知识 - 点击此处阅读
Drizzle 迁移基础知识 - 点击此处阅读
Drizzle Kit overview 和配置文件

Drizzle Kit 允许你在 TypeScript 或 JavaScript 配置文件中声明配置选项。

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

drizzle.config.ts

drizzle.config.js

import { defineConfig } from "drizzle-kit";

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

扩展配置文件示例

import { defineConfig } from "drizzle-kit";

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

  driver: "pglite",
  dbCredentials: {
    url: "./database/",
  },

  extensionsFilters: ["postgis"],
  schemaFilter: "public",
  tablesFilter: "*",

  introspect: {
    casing: "camel",
  },

  migrations: {
    prefix: "timestamp",
    table: "__drizzle_migrations__",
    schema: "public",
  },

  entities: {
    roles: {
      provider: '',
      exclude: [],
      include: []
    }
  }

  breakpoints: true,
  strict: true,
  verbose: true,
});

Expand

多个配置文件

项目中可以有多个配置文件，当同一个项目有多个数据库阶段或多个数据库或不同的数据库时，这非常有用：

npm

yarn

pnpm

bun

npx drizzle-kit 生成 --config=drizzle-dev.config.ts drizzle-kit 生成 --config=drizzle-prod.config.ts

yarn drizzle-kit 生成 --config=drizzle-dev.config.ts drizzle-kit 生成 --config=drizzle-prod.config.ts

pnpm drizzle-kit 生成 --config=drizzle-dev.config.ts drizzle-kit 生成 --config=drizzle-prod.config.ts

bun 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

迁移文件夹

out 参数允许你定义迁移的文件夹，它是可选的，默认情况下为 drizzle。它非常有用，因为你可以在同一个项目中为不同的数据库创建多个单独的模式，并为它们创建不同的迁移文件夹。

迁移文件夹包含 .sql 迁移文件和 drizzle-kit 使用的 _meta 文件夹

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

import { defineConfig } from "drizzle-kit";

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

`dialect`

你正在使用的数据库的方言


type
default	—
commands	`generate` `migrate` `push` `pull` `check` `up`

import { defineConfig } from "drizzle-kit";

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

`schema`

基于 glob 的 drizzle 模式文件或包含模式文件的文件夹的路径。


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

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`

定义 SQL 迁移文件的输出文件夹、架构的 JSON 快照以及从 drizzle-kit pull 命令到 schema.ts 的路径。


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

import { defineConfig } from "drizzle-kit";

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

`driver`

Drizzle Kit 会根据提供的 dialect 自动从你当前项目中选择可用的数据库驱动程序，但某些特定于供应商的数据库需要不同的连接参数子集。

driver 选项允许你明确选择那些异常驱动程序。


type
default	—
commands	`migrate` `push` `pull`

AWS Data API

PGLite

Cloudflare D1 HTTP

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "postgresql",
  schema: "./src/schema.ts",
  driver: "aws-data-api",
  dbCredentials: {
    database: "database",
    resourceArn: "resourceArn",
    secretArn: "secretArn",
  },
});

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "postgresql",
  schema: "./src/schema.ts",
  driver: "pglite",
  dbCredentials: {
    // inmemory
    url: ":memory:"
    
    // or database folder
    url: "./database/"
  },
});

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "sqlite",
  schema: "./src/schema.ts",
  driver: "d1-http",
  dbCredentials: {
    accountId: "accountId",
    databaseId: "databaseId",
    token: "token",
  },
});

`dbCredentials`

数据库连接凭据，形式为 url、user:password@host:port/db 参数或异常驱动程序 (aws-data-api d1-http pglight ) 特定的连接选项。


type	驱动程序连接选项联合
default	—
commands	`migrate` `push` `pull`

PostgreSQL

MySQL

SQLite

Turso

Cloudflare D1

AWS Data API

PGLite

import { defineConfig } from 'drizzle-kit'

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

import { defineConfig } from 'drizzle-kit'

// via connection params
export default defineConfig({
  dialect: "postgresql",
  dbCredentials: {
    host: "host",
    port: 5432,
    user: "user",
    password: "password",
    database: "dbname",
    ssl: true, // can be boolean | "require" | "allow" | "prefer" | "verify-full" | options from node:tls
  }
});

import { defineConfig } from 'drizzle-kit'

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

import { defineConfig } from 'drizzle-kit'

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

import { defineConfig } from 'drizzle-kit'

export default defineConfig({
  dialect: "sqlite",
  dbCredentials: {
    url: ":memory:", // inmemory database
    // or
    url: "sqlite.db", 
    // or
    url: "file:sqlite.db" // file: prefix is required by libsql
  }
});

import { defineConfig } from 'drizzle-kit'

export default defineConfig({
  dialect: "turso",
  dbCredentials: {
    url: "libsql://acme.turso.io" // remote Turso database url
    authToken: "...",

    // or if you need local db

    url: ":memory:", // inmemory database
    // or
    url: "file:sqlite.db", // file: prefix is required by libsql
  }
});

import { defineConfig } from 'drizzle-kit'

export default defineConfig({
  dialect: "sqlite",
  driver: "d1-http",
  dbCredentials: {
    accountId: "",
    databaseId: "",
    token: "",
  }
});

import { defineConfig } from 'drizzle-kit'

export default defineConfig({
  dialect: "postgresql",
  driver: "aws-data-api",
  dbCredentials: {
    database: "database",
    resourceArn: "resourceArn",
    secretArn: "secretArn",
  },
});

import { defineConfig } from 'drizzle-kit'

export default defineConfig({
  dialect: "postgresql",
  driver: "pglite",
  dbCredentials: {
    url: "./database/", // database folder path
  }
});

`migrations`

运行 drizzle-kit migrate 时 - drizzle 将在数据库中名为 __drizzle_migrations 且采用 public 模式的日志表中记录已成功应用的迁移（仅限 PostgreSQL）。

migrations 配置选项允许你更改迁移日志 table 名称和 schema。


type	`{ table: string, schema: string }`
default	`{ table: "__drizzle_migrations", schema: "drizzle" }`
commands	`migrate`

export default defineConfig({
  dialect: "postgresql",
  schema: "./src/schema.ts",
  migrations: {
    table: 'my-migrations-table', // `__drizzle_migrations` by default
    schema: 'public', // used in PostgreSQL only, `drizzle` by default
  },
});

`introspect`

drizzle-kit pull 命令的配置。

casing 负责代码中列键的大小写


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

camel

preserve

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

export const users = p.pgTable("users", {
  id: p.serial(),
  firstName: p.text("first-name"),
  lastName: p.text("LastName"),
  email: p.text(),
  phoneNumber: p.text("phone_number"),
});

SELECT a.attname AS column_name, format_type(a.atttypid, a.atttypmod) as data_type FROM pg_catalog.pg_attribute a;

 column_name   | data_type        
---------------+------------------------
 id            | serial
 first-name    | text
 LastName      | text
 email         | text
 phone_number  | text

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

export const users = p.pgTable("users", {
  id: p.serial(),
  "first-name": p.text("first-name"),
  LastName: p.text("LastName"),
  email: p.text(),
  phone_number: p.text("phone_number"),
});

SELECT a.attname AS column_name, format_type(a.atttypid, a.atttypmod) as data_type FROM pg_catalog.pg_attribute a;

 column_name   | data_type        
---------------+------------------------
 id            | serial
 first-name    | text
 LastName      | text
 email         | text
 phone_number  | text

`tablesFilter`

如果你想使用一个数据库运行多个项目 - 查看我们的指南。

drizzle-kit push 和 drizzle-kit pull 默认管理 public 模式中的所有表。你可以通过 tablesFilters、schemaFilter 和 extensionFilters 选项配置表、模式和扩展的列表。

tablesFilter 选项允许你指定基于 glob 的表名过滤器，例如 ["users", "user_info"] 或 "user*"


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

import { defineConfig } from "drizzle-kit";

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

`schemaFilter`

如果你想使用一个数据库运行多个项目 - 查看我们的指南。

schemaFilter 选项允许你指定 Drizzle Kit 需要管理的模式列表


type	`string[]`
default	`["public"]`
commands	`push` `pull`

export default defineConfig({
  dialect: "postgresql",
  schemaFilter: ["public", "schema1", "schema2"],
});

`extensionsFilters`

某些扩展（例如 postgis）在安装在数据库上时，会在公共模式中创建自己的表。这些表必须被 drizzle-kit push 或 drizzle-kit pull 忽略。

extensionsFilters 选项允许你声明已安装的 drizzle 套件扩展列表，以忽略其模式中的表。


type	`["postgis"]`
default	`[]`
commands	`push` `pull`

export default defineConfig({
  dialect: "postgresql",
  extensionsFilters: ["postgis"],
});

`entities`

创建此配置是为了设置数据库中特定 entities 的管理设置。

目前，它仅包含 roles，但最终所有数据库实体都将迁移至此，例如 tables、schemas、extensions、functions、triggers 等。

`roles`

如果你使用 Drizzle Kit 管理你的架构，尤其是已定义的角色，则可能会出现某些角色未在 Drizzle 架构中定义的情况。在这种情况下，你可能希望 Drizzle Kit 跳过这些 roles，而无需在 Drizzle 架构中编写每个角色并将其标记为 .existing()。

roles 选项允许你：

使用 Drizzle Kit 启用或禁用角色管理。
从 Drizzle Kit 的管理中排除特定角色。
包含 Drizzle Kit 管理的特定角色。
为 Neon 和 Supabase 等提供程序启用模式，这些提供程序不管理其特定角色。
合并以上所有选项


type	`boolean \| { provider: "neon" \| "supabase", include: string[], exclude: string[]}`
default	`false`
commands	`push` `pull` `generate`

默认情况下，drizzle-kit 不会为你管理角色，因此你需要启用此功能。在 drizzle.config.ts 中

export default defineConfig({
  dialect: "postgresql",
  entities: {
    roles: true
  }
});

你有一个角色 admin，并希望将其从可管理角色列表中排除。

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

export default defineConfig({
  ...
  entities: {
    roles: {
      exclude: ['admin']
    }
  }
});

你有一个角色 admin，并希望将其添加到可管理角色列表中。

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

export default defineConfig({
  ...
  entities: {
    roles: {
      include: ['admin']
    }
  }
});

如果你正在使用 Neon 并希望排除 Neon 定义的角色，则可以使用提供程序选项。

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

export default defineConfig({
  ...
  entities: {
    roles: {
      provider: 'neon'
    }
  }
});

如果你正在使用 Supabase 并希望排除 Supabase 定义的角色，则可以使用提供程序选项。

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

export default defineConfig({
  ...
  entities: {
    roles: {
      provider: 'supabase'
    }
  }
});

important

你可能会遇到 Drizzle 与数据库提供商指定的新角色相比略显过时的情况，因此你可能需要同时使用 provider 选项和 exclude 附加角色。你可以使用 Drizzle 轻松做到这一点：

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

export default defineConfig({
  ...
  entities: {
    roles: {
      provider: 'supabase',
      exclude: ['new_supabase_role']
    }
  }
});

`strict`

运行 drizzle-kit push 命令时提示确认是否运行打印的 SQL 语句。


type	`boolean`
default	`false`
commands	`push`

export default defineConfig({
  dialect: "postgresql",
  strict: false,
});

`verbose`

在 drizzle-kit push 命令期间打印所有 SQL 语句。


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

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

`breakpoints`

Drizzle Kit 会自动将 --> statement-breakpoint 嵌入到生成的 SQL 迁移文件中，这对于不支持在一个事务中使用多个 DDL 替换语句的数据库（MySQL 和 SQLite）来说是必需的。

breakpoints 选项标志允许你打开和关闭它。


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

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