`drizzle-kit push`

本指南假定您已熟悉：

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

drizzle-kit push 让你可以真正将 schema 以及后续的 schema 变更直接推送到数据库，同时省略 SQL 文件的生成，它旨在覆盖 Drizzle migrations 的代码优先方法。

它底层是如何工作的？

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

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

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

export const users = p.sqliteTable("users", {
  id: p.integer().primaryKey({ autoIncrement: true }),
  name: p.text(),
});

┌─────────────────────┐                  
│ ~ drizzle-kit push  │                  
└─┬───────────────────┘                  
  │                                           ┌──────────────────────────┐
  └ 拉取当前数据库 schema --------------------> │                          │
                                              │                          │
  ┌ 基于差异生成变更 <------------------------- │         DATABASE         │
  │                                           │                          │
  └ 将 migrations 应用到数据库 ---------------> │                          │
                                       │      └──────────────────────────┘
                                       │
  ┌────────────────────────────────────┴───────────────────────────────────────┐
   CREATE TABLE `users` (`id` integer PRIMARY KEY AUTOINCREMENT, `name` text );

对于快速原型开发来说，这是最好的方式，我们也看到很多团队和独立开发者把它作为生产应用中的主要 migrations 流程，并且使用得非常成功。它与蓝绿部署策略以及像 Planetscale、Neon、Turso 等无服务器数据库配合得非常好。

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: "sqlite",
  schema: "./src/schema.ts",
  dbCredentials: {
    url: "./sqlite.db",
  },
});

npx drizzle-kit push

npx drizzle-kit push --dialect=sqlite --schema=./src/schema.ts --url=./sqlite.db

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

指定数据库驱动

IMPORTANT

Expo SQLite 和 OP SQLite 是设备本地（每个用户）的数据库，无法在其中 push migrations。
对于嵌入式数据库，Drizzle 提供了 embedded migrations —— 请查看我们的入门指南。

Drizzle Kit 不自带预打包的数据库驱动，它会根据 dialect 自动从你当前项目中选择可用的 SQLite 驱动 - 查看讨论。

对于 Cloudflare D1 HTTP，请显式指定 driver: "d1-http"。

import { defineConfig } from "drizzle-kit";

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

包含哪些表

默认情况下，drizzle-kit push 会管理所有 SQLite 表。你可以通过 tablesFilter 配置表列表。


`tablesFilter`	基于 `glob` 的表名过滤器，例如 `["users", "user_info"]` 或 `"user"`。默认值是 `""`

现在我们来配置 drizzle-kit 以操作 SQLite 数据库中的所有表。

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "sqlite",
  schema: "./src/schema.ts",
  dbCredentials: {
    url: "./sqlite.db",
  },
  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 文件的文件夹路径
`driver`		驱动例外，例如 `d1-http`
`tablesFilter`		表名过滤器
`url`		数据库连接字符串
`user`		数据库用户
`password`		数据库密码
`host`		主机
`port`		端口
`database`		数据库名称
`config`		配置文件路径，默认=`drizzle.config.ts`

npm

yarn

pnpm

bun

npx drizzle-kit push dialect=sqlite schema=src/schema.ts url=./sqlite.db
npx drizzle-kit push dialect=sqlite schema=src/schema.ts --tablesFilter=‘user*’ url=./sqlite.db

yarn drizzle-kit push dialect=sqlite schema=src/schema.ts url=./sqlite.db
yarn drizzle-kit push dialect=sqlite schema=src/schema.ts --tablesFilter=‘user*’ url=./sqlite.db

pnpm drizzle-kit push dialect=sqlite schema=src/schema.ts url=./sqlite.db
pnpm drizzle-kit push dialect=sqlite schema=src/schema.ts --tablesFilter=‘user*’ url=./sqlite.db

bunx drizzle-kit push dialect=sqlite schema=src/schema.ts url=./sqlite.db
bunx drizzle-kit push dialect=sqlite schema=src/schema.ts --tablesFilter=‘user*’ url=./sqlite.db

扩展示例

让我们在项目中声明 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: "sqlite",
  schema: "./src/schema.ts",
  dbCredentials: {
    url: "./sqlite.db"
  },
});

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

export const users = p.sqliteTable("users", {
  id: p.integer().primaryKey({ autoIncrement: true }),
  name: p.text(),
})

现在让我们运行

npx drizzle-kit push

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

CREATE TABLE `users`(
  `id` integer primary key autoincrement,
  `name` text
)

完成 ✅