`drizzle-kit push`

本指南假定您熟悉

Drizzle 和 drizzle-kit 入门 - 在此阅读
Drizzle 模式基础 - 在此阅读
数据库连接基础 - 在此阅读
Drizzle 迁移基础 - 在此阅读
Drizzle Kit 概述和配置文件文档

drizzle-kit push 允许您直接将模式和后续模式更改推送到数据库，而无需生成 SQL 文件，它旨在覆盖 Drizzle 迁移的代码优先方法。

底层原理是什么？

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

读取您的 Drizzle 模式文件并生成模式的 JSON 快照
拉取（内省）数据库模式
根据两者之间的差异生成 SQL 迁移
将 SQL 迁移应用到数据库

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 选项提供这些参数。

使用配置文件

使用 CLI 选项

// 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

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

模式文件路径

您可以拥有一个 schema.ts 文件，也可以拥有任意数量的模式文件分散在整个项目中。Drizzle Kit 要求您通过 schema 配置选项以 glob 模式指定它们的路径。

示例 1

示例 2

示例 3

示例 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

bun drizzle-kit push --config=drizzle-dev.config.ts
bun 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

指定数据库驱动

重要提示

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

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

包含表、模式和扩展

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


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

让我们配置 drizzle-kit，使其仅操作 public 模式中的所有表，并让 drizzle-kit 知道已安装 postgis 扩展，该扩展在 public 模式中创建了自己的表，因此 drizzle 可以忽略它们。

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 具有 CLI 专用选项列表


`verbose`	在执行前打印所有 SQL 语句
`strict`	在执行 SQL 语句前总是请求批准
`force`	自动接受所有数据丢失语句

npm

yarn

pnpm

bun

npx drizzle-kit push --strict --verbose --force

yarn drizzle-kit push --strict --verbose --force

pnpm drizzle-kit push --strict --verbose --force

bun drizzle-kit push --strict --verbose --force

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


`dialect`	`必填`	数据库方言，可以是 `postgresql` `mysql` `sqlite` `turso` `singlestore` 之一
`schema`	`必填`	TypeScript 模式文件或包含多个模式文件的文件夹路径
`driver`		驱动程序例外 `aws-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
npx drizzle-kit push dialect=postgresql schema=src/schema.ts driver=pglite url=database/
npx drizzle-kit push dialect=postgresql schema=src/schema.ts --tablesFilter=‘user*’ --extensionsFilters=postgis url=postgresql://user:password@host:port/dbname

yarn drizzle-kit push dialect=postgresql schema=src/schema.ts url=postgresql://user:password@host:port/dbname
yarn drizzle-kit push dialect=postgresql schema=src/schema.ts driver=pglite url=database/
yarn drizzle-kit push dialect=postgresql schema=src/schema.ts --tablesFilter=‘user*’ --extensionsFilters=postgis url=postgresql://user:password@host:port/dbname

pnpm drizzle-kit push dialect=postgresql schema=src/schema.ts url=postgresql://user:password@host:port/dbname
pnpm drizzle-kit push dialect=postgresql schema=src/schema.ts driver=pglite url=database/
pnpm drizzle-kit push dialect=postgresql schema=src/schema.ts --tablesFilter=‘user*’ --extensionsFilters=postgis url=postgresql://user:password@host:port/dbname

bun drizzle-kit push dialect=postgresql schema=src/schema.ts url=postgresql://user:password@host:port/dbname
bun drizzle-kit push dialect=postgresql schema=src/schema.ts driver=pglite url=database/
bun drizzle-kit push dialect=postgresql schema=src/schema.ts --tablesFilter=‘user*’ --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"
  },
});

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

export const users = p.pgTable("users", {
  id: p.serial().primaryKey(),
  name: p.text(),
})

现在运行

npx drizzle-kit push

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

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

完成 ✅