`drizzle-kit pull`

This guide assumes familiarity with:

Get started with Drizzle and drizzle-kit - read here
Drizzle schema foundamentals - read here
Database connection basics - read here
Drizzle migrations foundamentals - read here
Drizzle Kit overview and config file docs

drizzle-kit pull lets you literally pull(introspect) your existing database schema and generate schema.ts drizzle schema file, it is designed to cover database first approach of Drizzle migrations.

How it works under the hood?

When you run Drizzle Kit pull command it will:

Pull database schema(DDL) from your existing database
Generate schema.ts drizzle schema file and save it to out folder

                                  ┌────────────────────────┐      ┌─────────────────────────┐ 
                                  │                        │ <---  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(), 
};

It is a great approach if you need to manage database schema outside of your TypeScript project or you’re using database, which is managed by somebody else.

drizzle-kit pull requires you to specify dialect and either database connection url or user:password@host:port/db params, you can provide them either via drizzle.config.ts config file or via CLI options:

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

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

Multiple configuration files in one project

You can have multiple config files in the project, it’s very useful when you have multiple database stages or multiple databases or different databases on the same project:

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

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

Specifying database driver

IMPORTANT

Expo SQLite and OP SQLite are on-device(per-user) databases, there’s no way to pull database schema from there.
For embedded databases Drizzle provides embedded migrations - check out our get started guide.

Drizzle Kit does not come with a pre-bundled database driver, it will automatically pick available database driver from your current project based on the dialect - see discussion.

Mostly all drivers of the same dialect share the same set of connection params, as for exceptions like aws-data-api, pglight and d1-http - you will have to explicitely specify driver param.

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

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "postgresql",
  driver: "pglite",
  dbCredentials: {
    // inmemory
    url: ":memory:"
    
    // or database folder
    url: "./database/"
  },
};

import { defineConfig } from "drizzle-kit";

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

Including tables, schemas and extensions

drizzle-kit push will by default manage all tables in public schema. You can configure list of tables, schemas and extensions via tablesFilters, schemaFilter and extensionFilters options.


`tablesFilter`	`glob` based table names filter, e.g. `["users", "user_info"]` or `"user"`. Default is `""`
`schemaFilter`	Schema names filter, e.g. `["public", "drizzle"]`. Default is `["public"]`
`extensionsFilters`	List of installed database extensions, e.g. `["postgis"]`. Default is `[]`

Let’s configure drizzle-kit to only operate with all tables in public schema and let drizzle-kit know that there’s a postgis extension installed, which creates it’s own tables in public schema, so drizzle can ignore them.

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

Extended list of configurations

We recommend configuring drizzle-kit through drizzle.config.ts file, yet you can provide all configuration options through CLI if necessary, e.g. in CI/CD pipelines, etc.


`dialect`	`required`	Database dialect, one of `postgresql` `mysql` `sqlite` `turso`
`driver`		Drivers exceptions `aws-data-api` `d1-http` `pglight`
`out`		Migrations output folder path, default is `./drizzle`
`url`		Database connection string
`user`		Database user
`password`		Database password
`host`		Host
`port`		Port
`database`		Database name
`config`		Config file path, default is `drizzle.config.ts`
`introspect-casing`		Strategy for JS keys creation in columns, tables, etc. `preserve` `camel`
`tablesFilter`		Table name filter
`schemaFilter`		Schema name filter. Default: `["public"]`
`extensionsFilters`		Database extensions internal database filters

npm

yarn

pnpm

bun

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

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

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

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