drizzle-kit pull

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.

                                  ┌────────────────────────┐      ┌─────────────────────────┐ 
                                  │                        │ <---  CREATE TABLE "users" (
┌──────────────────────────┐      │                        │        `id` int auto_increment primary key,
│ ~ drizzle-kit pull       │      │                        │        `name` varchar(255),
└─┬────────────────────────┘      │        DATABASE        │        `email` varchar(255) unique
  │                               │                        │       );
  └ Pull datatabase schema -----> │                        │
  ┌ Generate Drizzle       <----- │                        │
  │ schema TypeScript file        └────────────────────────┘
  │
  v

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

export const users = p.singlestoreTable("users", {
  id: p.int().primaryKey().autoincrement(),
  name: p.varchar({ length: 255 }),
  email: p.varchar({ length: 255 }).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:

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

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

npx drizzle-kit pull

npx drizzle-kit pull --dialect=singlestore --url=mysql://user:password@host:3306/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:

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

Specifying database driver

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

SingleStore uses MySQL-compatible connection parameters, so you usually only need to provide dbCredentials.

Initial pull

npm i drizzle-orm@rc
npm i drizzle-kit@rc -D

yarn add drizzle-orm@rc
yarn add drizzle-kit@rc -D

pnpm add drizzle-orm@rc
pnpm add drizzle-kit@rc -D

bun add drizzle-orm@rc
bun add drizzle-kit@rc -D

You can use the --init flag to mark the pulled schema as an applied migration in your database, so that all subsequent migrations are diffed against the initial one

npx drizzle-kit push --init

Including tables

drizzle-kit pull will introspect all SingleStore tables by default. You can configure the list of tables via tablesFilter.

Let’s configure drizzle-kit to introspect all tables in the connected SingleStore database.

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "singlestore",
  dbCredentials: {
    url: "mysql://user:password@host:3306/dbname",
  },
  tablesFilter: ["*"],
});

npx drizzle-kit pull

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.

npx drizzle-kit pull --dialect=singlestore --url=mysql://user:password@host:3306/dbname
npx drizzle-kit pull --dialect=singlestore --tablesFilter=‘user*’ url=mysql://user:password@host:3306/dbname

yarn drizzle-kit pull --dialect=singlestore --url=mysql://user:password@host:3306/dbname
yarn drizzle-kit pull --dialect=singlestore --tablesFilter=‘user*’ url=mysql://user:password@host:3306/dbname

pnpm drizzle-kit pull --dialect=singlestore --url=mysql://user:password@host:3306/dbname
pnpm drizzle-kit pull --dialect=singlestore --tablesFilter=‘user*’ url=mysql://user:password@host:3306/dbname

bunx drizzle-kit pull --dialect=singlestore --url=mysql://user:password@host:3306/dbname
bunx drizzle-kit pull --dialect=singlestore --tablesFilter=‘user*’ url=mysql://user:password@host:3306/dbname