`drizzle-kit push`

本指南假定您已熟悉：

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

drizzle-kit push 让你可以直接把 schema 以及后续的 schema 变更直接推送到数据库，同时省略 SQL 文件的生成；它旨在覆盖 Drizzle migrations 的 code first 方法。

底层是如何工作的？

当你运行 Drizzle Kit 的 push 命令时，它会：

读取你的 Drizzle schema 文件，并生成 schema 的 json 快照
拉取（introspect）数据库 schema
基于两者之间的差异生成 SQL migrations
将 SQL migrations 应用到数据库

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

export const users = p.mssqlTable("users", {
  id: p.int().primaryKey().identity(),
  name: p.nvarchar({ length: 255 }),
});

┌─────────────────────┐                  
│ ~ drizzle-kit push  │                  
└─┬───────────────────┘                  
  │                                           ┌──────────────────────────┐
  └ 拉取当前数据库 schema --------------------> │                          │
                                              │                          │
  ┌ 基于 diff 生成变更 <---------------------- │         DATABASE         │
  │                                           │                          │
  └ 将 migrations 应用到数据库 ---------------> │                          │
                                       │      └──────────────────────────┘
                                       │
  ┌────────────────────────────────────┴─────┐
   CREATE TABLE [users] (
     [id] int IDENTITY(1, 1),
     [name] nvarchar(255),
     CONSTRAINT [users_pkey] PRIMARY KEY([id])
   );

这是快速原型开发的最佳方式，我们已经看到许多团队和个人开发者成功地将它作为生产应用中的主要 migrations 流程。它与蓝绿部署策略、托管数据库部署以及 CI/CD 工作流配合得非常好。

drizzle-kit push 需要你指定 dialect、schema 文件路径，以及数据库连接的 url 或 user:password@host:port/db 参数，你可以通过 drizzle.config.ts 配置文件，或者通过 CLI 选项来提供：

使用配置文件

使用 CLI 选项

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

export default defineConfig({
  dialect: "mssql",
  schema: "./src/schema.ts",
  dbCredentials: {
    url: "mssql://user:password@host:port/dbname",
  },
});

npx drizzle-kit push

npx drizzle-kit push --dialect=mssql --schema=./src/schema.ts --url=mssql://user:password@host:port/dbname

Schema 文件路径

你可以只使用一个 schema.ts 文件，也可以把尽可能多的 schema 文件分散在项目中。 Drizzle Kit 需要你通过 schema 配置项以 glob 的形式指定它们的路径。

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
});

一个项目中的多个配置文件

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

npm

yarn

pnpm

bun

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

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

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

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

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

包含 tables 和 schemas

默认情况下，drizzle-kit push 会管理所有 tables 和 schemas。你可以通过 tablesFilter、schemaFilter 选项配置 tables 和 schemas 的列表。


`tablesFilter`	基于 `glob` 的表名过滤器，例如 `["users", "user_info"]` 或 `"user"`。默认值为 `""`
`schemaFilter`	Schema 名称过滤器，例如 `["dbo", "drizzle"]`

让我们配置 drizzle-kit 只操作 dbo schema 中的 所有 tables。

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "mssql",
  schema: "./src/schema.ts",
  dbCredentials: {
    url: "mssql://user:password@host:port/dbname",
  },
  schemaFilter: ["dbo"],
  tablesFilter: ["*"],
});

npx drizzle-kit push

扩展配置列表

drizzle-kit push 还提供了一组仅限 CLI 的选项


`verbose`	在执行前打印所有 SQL 语句
`explain`	打印计划中的 SQL 变更，但不实际应用（dry run）
`force`	自动接受所有数据丢失相关语句

npm

yarn

pnpm

bun

npx drizzle-kit push --explain --verbose --force

yarn drizzle-kit push --explain --verbose --force

pnpm drizzle-kit push --explain --verbose --force

bunx drizzle-kit push --explain --verbose --force

我们建议通过 drizzle.config.ts 文件来配置 drizzle-kit，但如果有必要，你也可以通过 CLI 提供所有配置选项，例如在 CI/CD 流水线中，等等。


`dialect`	`required`	数据库方言，取值之一为 `postgresql` `mysql` `sqlite` `turso` `singlestore` `mssql` `cockroach`
`schema`	`required`	TypeScript schema 文件或包含多个 schema 文件的文件夹路径
`tablesFilter`		表名过滤器
`schemaFilter`		Schema 名称过滤器。默认值：`["*"]`
`url`		数据库连接字符串
`user`		数据库用户
`password`		数据库密码
`host`		主机
`port`		端口
`database`		数据库名称
`config`		配置文件路径，默认=`drizzle.config.ts`

npm

yarn

pnpm

bun

npx drizzle-kit push dialect=mssql schema=src/schema.ts url=mssql://user:password@host:port/dbname
npx drizzle-kit push dialect=mssql schema=src/schema.ts --tablesFilter=‘user*’ url=mssql://user:password@host:port/dbname

yarn drizzle-kit push dialect=mssql schema=src/schema.ts url=mssql://user:password@host:port/dbname
yarn drizzle-kit push dialect=mssql schema=src/schema.ts --tablesFilter=‘user*’ url=mssql://user:password@host:port/dbname

pnpm drizzle-kit push dialect=mssql schema=src/schema.ts url=mssql://user:password@host:port/dbname
pnpm drizzle-kit push dialect=mssql schema=src/schema.ts --tablesFilter=‘user*’ url=mssql://user:password@host:port/dbname

bunx drizzle-kit push dialect=mssql schema=src/schema.ts url=mssql://user:password@host:port/dbname
bunx drizzle-kit push dialect=mssql schema=src/schema.ts --tablesFilter=‘user*’ url=mssql://user:password@host:port/dbname

扩展示例

让我们在项目中声明 drizzle schema，并通过 drizzle-kit push 命令将其推送到数据库

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

drizzle.config.ts

src/schema.ts

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "mssql",
  schema: "./src/schema.ts",
  dbCredentials: {
    url: "mssql://user:password@host:port/dbname"
  },
});

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

export const users = p.mssqlTable("users", {
  id: p.int().primaryKey().identity(),
  name: p.nvarchar({ length: 255 }),
})

现在让我们运行

npx drizzle-kit push

它会从数据库中拉取现有的（空）schema，生成 SQL migration，并在底层将其应用

CREATE TABLE [users] (
	[id] int IDENTITY(1, 1),
	[name] nvarchar(255),
	CONSTRAINT [users_pkey] PRIMARY KEY([id])
);

完成 ✅