`drizzle-kit pull`

本指南假定您已熟悉：

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

drizzle-kit pull 允许你直接拉取（introspect）你现有的数据库 schema，并生成 schema.ts drizzle schema 文件，它旨在覆盖 Drizzle migrations 的 database first 方法。

底层是如何工作的？

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

从你现有的数据库中拉取数据库 schema（DDL）
生成 schema.ts drizzle schema 文件并将其保存到 out 文件夹

                                  ┌────────────────────────┐      ┌───────────────────────────────┐ 
                                  │                        │ <---  CREATE TABLE [users] (
┌──────────────────────────┐      │                        │        [id] int identity primary key,
│ ~ drizzle-kit pull       │      │                        │        [name] varchar(255),
└─┬────────────────────────┘      │        DATABASE        │        [email] varchar(255) unique
  │                               │                        │       );
  └ 拉取数据库 schema -------> │                        │
  ┌ 生成 Drizzle            <----- │                        │
  │ schema TypeScript 文件        └────────────────────────┘
  │
  v

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

export const users = p.mssqlTable("users", {
	id: p.int().identity({ seed: 1 ,increment: 1 }),
	name: p.varchar({ length: 255 }),
	email: p.varchar({ length: 255 }),
}, (table) => [
	p.primaryKey({ columns: [table.id], name: "PK__users__3213E83F9C94E8E5"}),
	p.unique("UQ__users__AB6E6164167EE806").on(table.email)
]);

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

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

使用配置文件

使用 CLI 选项

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

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

npx drizzle-kit pull

npx drizzle-kit pull --dialect=mssql --url=mssql://user:password@host:port/dbname

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

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

npm

yarn

pnpm

bun

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

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

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

bunx drizzle-kit pull --config=drizzle-dev.config.ts
bunx 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

初始 pull

你可以使用 --init 标志将拉取到的 schema 标记为数据库中一个已应用的 migration，这样后续所有 migrations 都会基于这个初始 migration 进行 diff

npx drizzle-kit pull --init

包含表和 schema

drizzle-kit pull 默认会管理所有 schema 中的所有表。你可以通过 tablesFilter 和 schemaFilter 选项配置表和 schema 列表。


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

让我们将 drizzle-kit 配置为仅操作 dbo schema 中的 所有表。

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 pull

扩展配置列表

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


`dialect`	`required`	数据库方言，`postgresql` `mysql` `sqlite` `turso` `singlestore` `mssql` `cockroach` 中的一种
`out`		migrations 输出文件夹路径，默认是 `./drizzle`
`url`		数据库连接字符串
`user`		数据库用户
`password`		数据库密码
`host`		主机
`port`		端口
`database`		数据库名称
`config`		配置文件路径，默认是 `drizzle.config.ts`
`introspect-casing`		用于创建列、表等 JS 键名的策略。`preserve` `camel`
`tablesFilter`		表名过滤器
`schemaFilter`		schema 名称过滤器。默认：`["*"]`

npm

yarn

pnpm

bun

npx drizzle-kit pull --dialect=mssql --url=mssql://user:password@host:port/dbname
npx drizzle-kit pull --dialect=mssql --tablesFilter=‘user*’ url=mssql://user:password@host:port/dbname

yarn drizzle-kit pull --dialect=mssql --url=mssql://user:password@host:port/dbname
yarn drizzle-kit pull --dialect=mssql --tablesFilter=‘user*’ url=mssql://user:password@host:port/dbname

pnpm drizzle-kit pull --dialect=mssql --url=mssql://user:password@host:port/dbname
pnpm drizzle-kit pull --dialect=mssql --tablesFilter=‘user*’ url=mssql://user:password@host:port/dbname

bunx drizzle-kit pull --dialect=mssql --url=mssql://user:password@host:port/dbname
bunx drizzle-kit pull --dialect=mssql --tablesFilter=‘user*’ url=mssql://user:password@host:port/dbname