drizzle-kit pull

This guide assumes familiarity with:

drizzle-kit pull 允许你直接拉取（自检）现有数据库模式并生成 schema.ts drizzle 模式文件，它旨在覆盖 Drizzle 迁移的 数据库优先 方法。

How it works under the hood?

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

  1. 从现有数据库中提取数据库架构 (DDL)
  2. 生成 schema.ts drizzle 模式文件并将其保存到 out 文件夹
                                  ┌────────────────────────┐      ┌─────────────────────────┐ 
                                  │                        │ <---  CREATE TABLE "users" (
┌──────────────────────────┐      │                        │        "id" SERIAL PRIMARY KEY,
│ ~ drizzle-kit pull       │      │                        │        "name" TEXT,
└─┬────────────────────────┘      │        DATABASE        │        "email" TEXT UNIQUE
  │                               │                        │       );
  └ Pull datatabase schema -----> │                        │
  ┌ Generate Drizzle       <----- │                        │
  │ schema TypeScript file        └────────────────────────┘
  │
  v
import * as p from "drizzle-orm/pg-core";

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

如果你需要在 TypeScript 项目之外管理数据库模式，或者你正在使用由其他人管理的数据库，那么这是一种很好的方法。



drizzle-kit pull 要求你指定 dialect 以及数据库连接 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",
  dbCredentials: {
    url: "postgresql://user:password@host:port/dbname",
  },
});
npx drizzle-kit pull

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

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

npm
yarn
pnpm
bun 
npx drizzle-kit pull --config=drizzle-dev.config.ts drizzle-kit pull --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 是设备端（每个用户）数据库，无法从那里 pull 数据库模式。
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",
  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.config.ts 文件配置 drizzle-kit，但你也可以根据需要通过 CLI 提供所有配置选项，例如在 CI/CD 管道中等。

dialectrequired数据库方言，postgresql mysql sqlite turso singlestore 之一
driveraws-data-api d1-http pglight 驱动程序异常
out迁移输出文件夹路径，默认为 ./drizzle
url数据库连接字符串
user数据库用户
password数据库密码
host主机
port端口
database数据库名称
config配置文件路径，默认为 drizzle.config.ts
introspect-casing在列、表等中创建 JS 键的策略 preserve camel
tablesFilter表名过滤器
schemaFilter模式名称过滤器。默认：["public"]
extensionsFilters数据库扩展内部数据库过滤器
npm
yarn
pnpm
bun 
npx drizzle-kit pull --dialect=postgresql --url=postgresql://user:password@host:port/dbname drizzle-kit pull --dialect=postgresql --driver=pglite url=database/ drizzle-kit pull --dialect=postgresql --tablesFilter=‘用户*’ --extensionsFilters=postgis url=postgresql://user:password@host:port/dbname