Drizzle Kit 配置文件

本指南假定您已熟悉：

开始使用 Drizzle 和 drizzle-kit - 点此阅读
Drizzle schema 基础 - 点此阅读
数据库连接基础 - 点此阅读
Drizzle migrations 基础 - 点此阅读
Drizzle Kit 概览和配置文件

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

📦 <项目根目录>
 ├ ...
 ├ 📂 drizzle
 ├ 📂 src
 ├ 📜 drizzle.config.ts
 └ 📜 package.json

drizzle.config.ts

drizzle.config.js

import { defineConfig } from "drizzle-kit";

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

扩展配置文件示例

import { defineConfig } from "drizzle-kit";

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

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

  schemaFilter: "dbo",
  tablesFilter: "*",

  introspect: {
    casing: "camel",
  },

  migrations: {
    table: "__drizzle_migrations__",
    schema: "drizzle",
  },

  breakpoints: true,
  verbose: true,
});

Expand

多个配置文件

你可以在项目中拥有多个配置文件，当你有多个数据库阶段、多个数据库，或者同一项目中存在不同数据库时，这会非常有用：

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

📦 <项目根目录>
 ├ 📂 drizzle
 ├ 📂 src
 ├ 📜 .env
 ├ 📜 drizzle-dev.config.ts
 ├ 📜 drizzle-prod.config.ts
 ├ 📜 package.json
 └ 📜 tsconfig.json

migrations 文件夹

out 参数允许你定义 migrations 的文件夹，它是可选的，默认值为 drizzle。
由于你可以在同一个项目中为不同数据库拥有多个独立的 schema，并为它们设置不同的 migrations 文件夹，因此它非常有用。

migrations 文件夹包含带有 .sql migration 文件的文件夹，这些文件由 drizzle-kit 使用

📦 <项目根目录>
 ├ ...
 ├ 📂 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: "mssql",
  schema: "./src/schema/*",
  out: "./drizzle",
});

---

`dialect`

你正在使用的数据库方言


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: "mssql", 
});

`schema`

glob 基于路径的 drizzle schema 文件或文件夹路径。


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`

定义 SQL 迁移文件、schema 的 json 快照以及 drizzle-kit pull 命令生成的 schema.ts 的输出文件夹。


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

import { defineConfig } from "drizzle-kit";

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

---

`dbCredentials`

以 url 的形式或
user:password@host:port/db 参数形式提供数据库连接凭据。


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: "mssql",
  dbCredentials: {
    url: "mssql://user:password@host:3306/db",
  }
});

import { defineConfig } from 'drizzle-kit';

export default defineConfig({
  dialect: 'mssql',
  schema: './schema.ts',
  breakpoints: false,
  dbCredentials: {
    database: '',
    password: '',
    port: 3306,
    server: '',
    user: '',
    options: {
      encrypt: true,
      trustServerCertificate: true,
    },
  },
});

`migrations`

当运行 drizzle-kit migrate 时，drizzle 会把
成功应用的迁移记录到数据库中名为 __drizzle_migrations 的日志表里，该表位于 drizzle schema 中。

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


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

export default defineConfig({
  dialect: "mssql",
  schema: "./src/schema.ts",
  migrations: {
    table: 'my-migrations-table', // 默认为 `__drizzle_migrations`
    schema: 'my_schema', // 默认为 `drizzle`
  },
});

`introspect`

drizzle-kit pull 命令的配置。

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


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

camel

preserve

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

export const users = p.mssqlTable("users", {
  id: p.int().primaryKey().identity(),
  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 }),
});

SELECT COLUMN_NAME, DATA_TYPE FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = 'users';

 COLUMN_NAME   | DATA_TYPE        
---------------+--------------
 id            | int
 first-name    | varchar
 LastName      | varchar
 email         | varchar
 phone_number  | varchar

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

export const users = p.mssqlTable("users", {
  id: p.int().primaryKey().identity(),
  "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 }),
});

SELECT COLUMN_NAME, DATA_TYPE FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = 'users';

 COLUMN_NAME   | DATA_TYPE
---------------+--------------
 id            | int
 first-name    | varchar
 LastName      | varchar
 email         | varchar
 phone_number  | varchar

---

`tablesFilter`

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

drizzle-kit push 和 drizzle-kit pull 默认会管理所有表。你可以通过 tablesFilters 和 schemaFilter 选项配置表和模式列表。

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


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

import { defineConfig } from "drizzle-kit";

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

`schemaFilter`

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

drizzle-kit push 和 drizzle-kit pull 默认会管理所有模式。

schemaFilter 选项允许你指定基于 glob 的模式名过滤器，例如 ["dbo", "auth"] 或 "tenant_*"


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

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

---

`verbose`

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


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

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

`breakpoints`

Drizzle Kit 会自动将 --> statement-breakpoint 嵌入生成的 SQL 迁移文件中，
这对于不支持在一个事务中执行多个 DDL 变更语句的数据库是必要的。

breakpoints 选项标志可让你将其开启或关闭


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

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