drizzle-kit

157 notes in this subject, read out of this brain and free to use. This is page 1 of 3.

Enable verbose logging with drizzle-kit studio --verbose

You can enable logging of every SQL statement executed by drizzle-kit studio by providing the --verbose flag.

drizzle-kit studio requires database credentials in drizzle.config.ts

The drizzle-kit studio command requires you to specify database connection credentials via the drizzle.config.ts config file. The dbCredentials section must include a url property with the database connection string.

drizzle-kit studio command starts server on 127.0.0.1:4983

The drizzle-kit studio command spins up a server for Drizzle Studio hosted on local.drizzle.studio. By default it starts a Drizzle Studio server on 127.0.0.1:4983.

Drizzle Studio chrome extension supports PlanetScale, Cloudflare D1, and Vercel Postgres

The Drizzle Studio chrome extension lets you browse your PlanetScale, Cloudflare D1, and Vercel Postgres serverless databases directly in their vendor admin panels.

Drizzle Studio is not open source

Drizzle ORM and Drizzle Kit are fully open sourced, but Drizzle Studio is not. The hosted version for local development is free to use forever, but open sourcing it would break the ability to provide B2B offerings and monetize it.

Configure drizzle-kit studio host and port via CLI options

The drizzle-kit studio command supports --host and --port CLI options to configure the server address. Examples: drizzle-kit studio --port=3000, drizzle-kit studio --host=0.0.0.0, drizzle-kit studio --host=0.0.0.0 --port=3000.

Safari and Brave require mkcert for localhost access to drizzle-kit studio

Safari and Brave block access to localhost by default. To use drizzle-kit studio with these browsers, install mkcert, run mkcert -install to generate self-signed certificates, then restart drizzle-kit studio.

drizzle-kit up with custom config file

To use a custom config file with drizzle-kit up, use the --config option: npx drizzle-kit up --config=drizzle-dev.config.ts. The default config file is drizzle.config.ts.

Multiple config files for multiple database stages

You can have multiple configuration files in a project for different database stages or multiple databases. For example, you can create drizzle-dev.config.ts and drizzle-prod.config.ts in the project root, then run drizzle-kit up --config=drizzle-dev.config.ts or drizzle-kit up --config=drizzle-prod.config.ts respectively.

drizzle-kit up with custom migrations folder

To specify a custom migrations folder for drizzle-kit up, use the --out option: npx drizzle-kit up --dialect=mysql --out=./migrations-folder. The default migrations folder is ./drizzle.

Generated columns push command limitations in Drizzle Kit

Drizzle Kit's push command has two limitations for generated columns: (1) You cannot change the generated constraint expression and type using push because the schema expression is modified and reformatted by the database during introspection, making it impossible to determine if you changed it or the database did. To change a generated column, you must drop the column, push, then add a new column with the new expression. (2) The generate command has no limitations.

Filter tables in drizzle-kit with tablesFilter

Use the tablesFilter option in drizzle-kit config to filter which tables to include when using multi-project schema. Support multiple filters with 'or' logic. Example: tablesFilter: ["project1_*", "project2_*"]

Drizzle Kit CLI commands overview

Drizzle Kit is a CLI tool for managing SQL database migrations with Drizzle. The main commands are: drizzle-kit generate (generate SQL migration files), drizzle-kit migrate (apply generated migrations to database), drizzle-kit push (push Drizzle schema to database), drizzle-kit pull (introspect database schema and convert to Drizzle schema), drizzle-kit check (check for race conditions in migrations), drizzle-kit up (upgrade migration snapshots), drizzle-kit studio (connect to database and spin up Drizzle Studio proxy server), and drizzle-kit export (convert TypeScript schema to raw SQL DDL).

drizzle-kit migrate command

The drizzle-kit migrate command lets you apply generated SQL migration files to your database.

Multiple Drizzle Kit config files with CLI

You can specify different Drizzle Kit config files via the --config CLI parameter, which is useful when you have multiple database stages or multiple databases. For example: drizzle-kit push --config=drizzle-dev.config or drizzle-kit push --config=drizzle-prod.config.

Drizzle Kit extended configuration options

Extended drizzle.config.ts configuration can include: out (output directory for migrations, default './drizzle'), dialect ('mysql'), schema (path to schema file), dbCredentials (database connection details including url), tablesFilter (filter for tables, accepts '*' for all), introspect (with casing option like 'camel'), migrations (with table option for migration history table, default '__drizzle_migrations__'), breakpoints (boolean), and verbose (boolean).

Drizzle Kit minimal configuration

The minimal drizzle.config.ts configuration requires: dialect set to 'mysql' and schema pointing to the path of your schema file, for example schema: './src/schema.ts'.

drizzle-kit up command

The drizzle-kit up command is used to upgrade snapshots of previously generated migrations.

drizzle-kit check command

The drizzle-kit check command walks through all generated migrations and checks for any race conditions (collisions) of generated migrations.

drizzle-kit studio command

The drizzle-kit studio command connects to your database and spins up a proxy server for Drizzle Studio, which you can use for convenient database browsing.

drizzle-kit export command

The drizzle-kit export command is used for converting TypeScript schema into raw SQL DDL and printing it out.

Drizzle Kit configuration requirements

Drizzle Kit is configured through a drizzle.config.ts configuration file or via CLI parameters. It requires at least two pieces of information to generate migrations: the SQL dialect and the schema path.

drizzle-kit pull command

The drizzle-kit pull command lets you pull (introspect) database schema, convert it to Drizzle schema format, and save it to your codebase.

drizzle-kit push command

The drizzle-kit push command lets you push your Drizzle schema to database either upon initial declaration or on subsequent schema changes.

Drizzle Kit CLI commands for migrations

Drizzle Kit provides these CLI commands for managing migrations: drizzle-kit migrate, drizzle-kit generate, drizzle-kit push, drizzle-kit pull, and drizzle-kit export. It is designed to let you choose your migration approach based on current business demands.

Migration application process steps

When using `drizzle-kit migrate`, the process follows these steps: 1) read migration.sql files in migrations folder, 2) fetch migration history from database, 3) pick previously unapplied migrations, 4) apply new migrations to the database.

Option 6: Export SQL with drizzle-kit export

For codebase first approach where you want Drizzle to output the SQL representation of your schema to the console for use with external tools like Atlas: use `drizzle-kit export`. This reads your Drizzle schema, generates SQL representation, and outputs to console. You can then apply the SQL via Atlas or other external SQL migration tools.

Migration generation process steps

When using `drizzle-kit generate`, the process follows these steps: 1) read previous migration folders, 2) find diff between current and previous schema, 3) prompt developer for renames if necessary, 4) generate SQL migration and persist to file. Generated migrations are stored in a timestamped folder containing snapshot.json and migration.sql files.

drizzle-kit pull generates v2 relations syntax

drizzle-kit pull command now supports pulling relations.ts file in the new v2 syntax. Generated file includes import of all tables from schema and uses defineRelations(). May need to adjust imports if schema is split across multiple files.

Schema file organization for Drizzle Kit

When using Drizzle Kit for migrations, all schema models (tables, enums, sequences, etc.) must be exported from their files so Drizzle Kit can import them for the migration diff process. You can organize schemas in a single `schema.ts` file or spread them across multiple files in a folder structure. In `drizzle.config.ts`, set the `schema` property to either a single file path or a folder path.

Drizzle v1 drizzle-kit architectural changes

The drizzle-kit has been architecturally redesigned, migrating from database snapshots to DDL snapshots. Commutativity checks were added to detect non-commutative migrations across branches.

Drizzle v1 upgrade step 1: run drizzle-kit up

To migrate from the old migration folder structure to the new one, run the command: drizzle-kit up. This command handles the migration automatically.

drizzle-kit rewrite with DDL snapshots

drizzle-kit has been architecturally redesigned: migrated from database snapshots to DDL snapshots, reworked diff detection and application, reduced schema introspection from ~10s to <1s, and added query hints and explain support for push.

drizzle-kit push --strict deprecated

The --strict flag is removed from drizzle-kit push. The behavior is now default: drizzle-kit push always prompts for confirmation for data-loss statements unless the --force flag is passed. Use drizzle-kit push --explain to preview SQL before executing.

Schema file processing extensions

Only schema files with extensions .js, .mjs, .cjs, .jsx, .ts, .mts, .cts, .tsx are processed by drizzle-kit. All other file types are ignored.

drizzle-kit build system improvements

drizzle-kit build system improvements include: migration from esbuild-register to tsx loader for seamless ESM and CJS support, and native Bun and Deno launch support.

Top-level await in drizzle config files

Top-level await is now supported in drizzle.config.ts and schema files on Node.js.

drizzle-kit check commutativity detection

drizzle-kit check detects non-commutative migrations across branches by building a DAG from snapshot prevIds, finding fork points, computing DDL diffs, and checking conflicts using a footprint map. It reports exactly which migrations on which branches are incompatible and which statements collide.

drizzle-kit push --explain command

drizzle-kit push --explain shows the SQL that would be executed without actually running it, allowing preview of migration changes.

drizzle-kit pull --init command

drizzle-kit pull --init creates the drizzle migration table and marks the first pulled migration as applied.

drizzle-kit generate ignore-conflicts option

The --ignore-conflicts option allows you to skip commutativity checks in the generate command. Use it with caution as its use typically indicates a bug in drizzle-kit. Example: `drizzle-kit generate --ignore-conflicts`

drizzle-kit generate CLI options reference

drizzle-kit generate with CLI options example

You can provide configuration options directly via CLI: ```shell npx drizzle-kit generate --dialect=cockroach --schema=./src/schema.ts ```

drizzle-kit generate with config file example

Example configuration using drizzle.config.ts: ```ts // drizzle.config.ts import { defineConfig } from "drizzle-kit"; export default defineConfig({ dialect: "cockroach", schema: "./src/schema.ts", }); ``` Then run: `npx drizzle-kit generate`

drizzle-kit generate command purpose

The drizzle-kit generate command generates SQL migrations based on your Drizzle schema upon declaration or on subsequent schema changes. It is designed to cover the code-first approach of managing Drizzle migrations.

drizzle-kit generate extended example with custom config location

Example of generating a custom cockroach migration file named `0001_seed-users.sql` with Drizzle schema in `./src/schema.ts` and migrations folder at `./migrations`: Create drizzle.config.ts in ./configs: ```ts import { defineConfig } from "drizzle-kit"; export default defineConfig({ dialect: "cockroach", schema: "./src/schema.ts", out: "./migrations", }); ``` Then run: ```shell npx drizzle-kit generate --config=./configs/drizzle.config.ts --name=seed-users --custom ``` This creates a migration file at ./migrations/20242409125510_seed-users/migration.sql

D1 HTTP API configuration example

import { defineConfig } from 'drizzle-kit'; export default defineConfig({ schema: './src/schema.ts', out: './migrations', dialect: 'sqlite', driver: 'd1-http', dbCredentials: { accountId: process.env.CLOUDFLARE_ACCOUNT_ID!, databaseId: process.env.CLOUDFLARE_DATABASE_ID!, token: process.env.CLOUDFLARE_D1_TOKEN!, }, });

D1 HTTP API driver configuration in drizzle.config.ts

To use Drizzle Kit with Cloudflare D1 HTTP API, set the dialect to 'sqlite' and driver to 'd1-http' in drizzle.config.ts. The dbCredentials object requires three fields: accountId (Cloudflare Account ID), databaseId (D1 Database ID), and token (API token with D1 edit permissions).

Finding Cloudflare D1 credentials

To find accountId: navigate to Workers & Pages -> Overview and copy Account ID from the right sidebar. To find databaseId: open the D1 database and copy Database ID. To find token: go to My profile -> API Tokens and create a token with D1 edit permissions.

Drizzle Chrome Extension for D1

The Drizzle Chrome Extension can be used to browse Cloudflare D1 databases directly in the Cloudflare admin panel.

D1 HTTP API supported Drizzle Kit commands

After configuring drizzle.config.ts with d1-http driver, Drizzle Kit supports running migrate, push, introspect, and studio commands using Cloudflare D1 HTTP API.

drizzle-kit generate ignore conflicts flag

The --ignore-conflicts flag skips commutativity checks in the generate command. This should rarely be needed; if you find yourself using it, there may be a bug in drizzle-kit that should be reported.

drizzle-kit generate configuration parameters

Configuration parameters for drizzle-kit generate: dialect (required - database dialect), schema (required - path to TypeScript schema file(s) or folder(s)), out (migrations output folder, default is ./drizzle), config (configuration file path, default is drizzle.config.ts), breakpoints (SQL statements breakpoints, default is true).

drizzle-kit generate CLI options reference

Available CLI-only options for drizzle-kit generate: custom (generate empty SQL for custom migration), name (generate migration with custom name), ignore-conflicts (skip commutativity conflict checks, default is false).

drizzle-kit generate required options

The drizzle-kit generate command requires two configuration options: dialect (database dialect, one of the supported dialects) and schema (path to TypeScript schema file(s) or folder(s) with multiple schema files). These can be provided via drizzle.config.ts file or as CLI options.

drizzle-kit generate custom migrations

You can generate empty migration files to write custom SQL migrations for DDL alterations not yet supported by Drizzle Kit or for data seeding. Use the --custom flag: drizzle-kit generate --custom --name=seed-users

drizzle-kit generate custom migration file names

You can set a custom migration file name by providing the --name CLI option when running drizzle-kit generate. For example, npx drizzle-kit generate --name=init will create a migration folder with the name 20242409125510_init instead of using the default naming convention.

drizzle-kit generate example with custom config path

Example command: npx drizzle-kit generate --config=./configs/drizzle.config.ts --name=seed-users --custom. This generates a custom empty migration file named seed-users using a config file located at ./configs/drizzle.config.ts instead of the default location.

drizzle-kit generate command overview

The drizzle-kit generate command generates SQL migrations based on your Drizzle schema. It reads your Drizzle schema files, composes a JSON snapshot of the schema, compares it to the most recent migration snapshot, generates SQL migrations based on differences, and saves migration.sql and snapshot.json in a migration folder with a timestamp.

Basic drizzle.config.ts structure for CockroachDB

A basic Drizzle Kit configuration file for CockroachDB requires three fields: dialect set to "cockroach", schema pointing to the schema file path (e.g., "./src/schema.ts"), and out specifying the migrations output folder (e.g., "./drizzle").

Give your agent this brain