drizzle-kit push

This guide assumes familiarity with:

drizzle-kit push 允许你直接将模式及其后续更改推送到数据库，同时省略 SQL 文件生成，它旨在覆盖 Drizzle 迁移的 代码优先 方法。

How it works under the hood?

运行 Drizzle Kit push 命令时，它将：

  1. 通读 Drizzle 架构文件并编写 json 快照
  2. 拉取（自省）数据库模式
  3. 根据两者之间的差异，生成 SQL 迁移
  4. 将 SQL 迁移应用于数据库
src/schema.ts
import * as p from "drizzle-orm/pg-core";

export const users = p.pgTable("users", {
  id: p.serial().primaryKey(),
  name: p.text(),
};
┌─────────────────────┐                  
│ ~ drizzle-kit push  │                  
└─┬───────────────────┘                  
  │                                           ┌──────────────────────────┐
  └ Pull current datatabase schema ---------> │                          │
                                              │                          │
  ┌ Generate alternations based on diff <---- │         DATABASE         │
  │                                           │                          │
  └ Apply migrations to the database -------> │                          │
                                       │      └──────────────────────────┘
                                       │
  ┌────────────────────────────────────┴────────────────┐
   create table users(id serial primary key, name text);

这是快速原型设计的最佳方法，我们已经看到数十个团队和个人开发者成功地将其用作其生产应用中的主要迁移流程。它与蓝绿部署策略以及 Planetscale、Neon、Turso 等无服务器数据库完美匹配。



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

With config file
With CLI options
// drizzle.config.ts
import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "postgresql",
  schema: "./src/schema.ts",
  dbCredentials: {
    url: "postgresql://user:password@host:port/dbname",
  },
});
npx drizzle-kit push

Schema 文件路径

你可以拥有一个 schema.ts 文件，也可以在整个项目中分布任意数量的模式文件。Drizzle Kit 要求你将这些模式文件的路径指定为 glob via schema 配置选项。

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

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

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

npm
yarn
pnpm
bun 
npx drizzle-kit push --config=drizzle-dev.config.ts 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 数据库模式。
Drizzle 为嵌入式数据库提供嵌入式迁移 - 查看我们的 开始 指南。

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

大多数情况下，同一种方言的所有驱动程序都共享相同的连接参数集，例如 aws-data-api、pglight 和 d1-http 等异常。 - 你必须明确指定 driver 参数。

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

包含表、模式和扩展

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

tablesFilter基于 glob 的表名过滤器，例如 ["users", "user_info"] 或 "user*"。默认为 "*"
schemaFilter模式名称过滤器，例如 ["public", "drizzle"]。默认为 ["public"]
extensionsFilters已安装数据库扩展的列表，例如 ["postgis"]。默认为 []

让我们将 drizzle-kit 配置为仅对公共模式中的所有表进行操作，并让 drizzle-kit 知道已安装 Postgis 扩展，该扩展会在公共模式中创建自己的表，以便 drizzle 可以忽略它们。

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

export default defineConfig({
  dialect: "postgresql",
  schema: "./src/schema.ts",
  dbCredentials: {
    url: "postgresql://user:password@host:port/dbname",
  },
  extensionsFilters: ["postgis"],
  schemaFilter: ["public"],
  tablesFilter: ["*"],
});
npx drizzle-kit push

配置的扩展列表

drizzle-kit push 包含一系列仅限命令行选项

verbose执行前打印所有 SQL 语句
strict执行 SQL 语句前始终要求批准。
force自动接受所有数据丢失声明

npm
yarn
pnpm
bun 
npx drizzle-kit push --strict --verbose --force


我们建议通过 drizzle.config.ts 文件配置 drizzle-kit，但你也可以根据需要通过 CLI 提供所有配置选项，例如在 CI/CD 管道中等。

dialectrequired数据库方言，postgresql mysql sqlite turso singlestore 之一
schemarequiredTypeScript 模式文件或包含多个模式文件的文件夹的路径
driveraws-data-api d1-http pglight 驱动程序异常
tablesFilter表名过滤器
schemaFilter模式名称过滤器。默认：["public"]
extensionsFilters数据库扩展内部数据库过滤器
url数据库连接字符串
user数据库用户
password数据库密码
host主机
port端口
database数据库名称
config配置文件路径，默认值=drizzle.config.ts
npm
yarn
pnpm
bun 
npx drizzle-kit push dialect=postgresql schema=src/schema.ts url=postgresql://user:password@host:port/dbname drizzle-kit push dialect=postgresql schema=src/schema.ts driver=pglite url=database/ drizzle-kit push dialect=postgresql schema=src/schema.ts --tablesFilter=‘用户*’ --extensionsFilters=postgis url=postgresql://user:password@host:port/dbname

扩展示例

让我们在项目中声明 Drizzle 模式，并通过 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: "postgresql",
  schema: "./src/schema.ts",
  dbCredentials: {
    url: "postgresql://user:password@host:port/dbname"
  },
});

现在运行

npx drizzle-kit push

它会从数据库中提取现有的（空）模式，生成 SQL 迁移并在后台应用它。

CREATE TABLE "users"(
  id serial primary key,
  name text
)

DONE ✅