drizzle-kit

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

drizzle-kit check with custom migrations folder example

To run drizzle-kit check with a custom migrations folder, use: npx drizzle-kit check --dialect=postgresql --out=./migrations-folder

drizzle-kit check CLI configuration options

The drizzle-kit check command accepts the following CLI options: dialect (required) - database dialect being used; out - migrations folder path, default is ./drizzle; config - configuration file path, default is drizzle.config.ts.

drizzle-kit check with CLI dialect option

To run drizzle-kit check with CLI options, use: npx drizzle-kit check --dialect=postgresql

drizzle-kit check command purpose

The drizzle-kit check command checks consistency of generated SQL migrations history. It is useful when multiple developers work on a project and alter database schema on different branches.

drizzle-kit check with config file example

To run drizzle-kit check with a config file, define the dialect in drizzle.config.ts (e.g., dialect: "postgresql") and run npx drizzle-kit check without additional options.

drizzle-kit check requires dialect configuration

The drizzle-kit check command requires the dialect to be specified either via drizzle.config.ts config file or via CLI options.

drizzle-kit export how it works

The drizzle-kit export command triggers a sequence of events: 1) It reads through the Drizzle schema file(s) and composes a JSON snapshot of the schema, 2) Based on the current JSON snapshot it generates SQL DDL statements, 3) It outputs the SQL DDL statements to console.

drizzle-kit export PostgreSQL example

Example of exporting a Drizzle schema to console: Config file (drizzle.config.ts): ```ts import { defineConfig } from "drizzle-kit"; export default defineConfig({ dialect: "postgresql", schema: "./src/schema.ts", }); ``` Schema file (schema.ts): ```ts import { pgTable, serial, text } from 'drizzle-orm/pg-core' export const users = pgTable('users', { id: serial('id').primaryKey(), email: text('email').notNull(), name: text('name') }); ``` Running: npx drizzle-kit export --config=./configs/drizzle.config.ts Output: ```sql CREATE TABLE "users" ( "id" serial PRIMARY KEY, "email" text NOT NULL, "name" text ); ```

drizzle-kit export CLI options reference

drizzle-kit export required options

The drizzle-kit export command requires both dialect and schema path options. These can be set either via drizzle.config.ts config file or via CLI options.

drizzle-kit export with config file example

To use drizzle-kit export with a config file, define dialect and schema in drizzle.config.ts and run: npx drizzle-kit export Example config: ```ts import { defineConfig } from "drizzle-kit"; export default defineConfig({ dialect: "postgresql", schema: "./src/schema.ts", }); ```

drizzle-kit export with CLI options example

To use drizzle-kit export with CLI options directly: npx drizzle-kit export --dialect=postgresql --schema=./src/schema.ts

drizzle-kit export command purpose

The drizzle-kit export command lets you export the SQL representation of a Drizzle schema and print the SQL DDL representation to console. It is designed to cover the codebase first approach of managing Drizzle migrations.

drizzle-kit migrate with config file example

Example: drizzle.config.ts with dialect set to 'postgresql', schema path set to './src/schema.ts', and dbCredentials.url set to 'postgresql://user:password@host:port/dbname'. Run with: `npx drizzle-kit migrate`

customize drizzle migrations log table and schema

Both the table name and schema of the migrations log can be customized via the drizzle config file using the `migrations` object with `table` and `schema` properties. Example: `migrations: { table: 'my-migrations-table', schema: 'public' }`

drizzle-kit migrations log table

Upon running migrations, Drizzle Kit persists records about successfully applied migrations in a table named `__drizzle_migrations` in the `drizzle` schema by default.

drizzle-kit migrate with CLI options example

Example command: `npx drizzle-kit migrate --dialect=postgresql --url=postgresql://user:password@host:port/dbname`

drizzle-kit migrate command purpose

The `drizzle-kit migrate` command applies SQL migrations generated by `drizzle-kit generate`. It is designed to support the code-first approach (option 3) of managing Drizzle migrations.

drizzle-kit migrate execution sequence

The `drizzle-kit migrate` command performs these steps: (1) reads all .sql migration files from the migration folder, (2) connects to the database and fetches entries from the drizzle migrations log table, (3) determines which new migrations have not yet been applied based on the migration history, and (4) runs the SQL migrations and logs the applied migrations to the drizzle migrations table.

drizzle-kit migrate required configuration

The `drizzle-kit migrate` command requires both `dialect` and database connection credentials. These can be provided either via the drizzle.config.ts config file or via CLI options.

drizzle-kit generate example with custom config

Example: npx drizzle-kit generate --config=./configs/drizzle.config.ts --name=seed-users --custom generates a custom empty migration file named 0001_seed-users with configuration from ./configs/drizzle.config.ts, schema from ./src/schema.ts, and output to ./migrations folder.

drizzle-kit generate with CLI options example

Example using CLI options: npx drizzle-kit generate --dialect=postgresql --schema=./src/schema.ts

drizzle-kit generate required options

The drizzle-kit generate command requires two options: dialect (database dialect such as postgresql) and schema (path to TypeScript schema file(s) or folder(s) with multiple schema files). These can be set via drizzle.config.ts or as CLI options.

drizzle-kit generate process steps

The drizzle-kit generate command executes the following steps: 1. Reads through Drizzle schema file(s) and composes a JSON snapshot of the schema. 2. Reads through previous migrations folders and compares the current JSON snapshot to the most recent one. 3. Based on JSON differences, generates SQL migrations. 4. Saves migration.sql and snapshot.json in a migration folder under the current timestamp.

drizzle-kit generate schema file paths with globs

You can have a single schema.ts file or multiple schema files spread across the project. Drizzle Kit requires you to specify path(s) to them using glob patterns via the schema configuration option.

drizzle-kit generate custom migration file names

You can set custom migration file names by providing the --name CLI option. For example, npx drizzle-kit generate --name=init will create a migration folder named with a timestamp prefix followed by _init (e.g., 20242409125510_init).

drizzle-kit generate multiple configuration files

You can have multiple config files in the project for different database stages or multiple databases. Use the --config option to specify which configuration file to use, for example: drizzle-kit generate --config=drizzle-dev.config.ts or drizzle-kit generate --config=drizzle-prod.config.ts.

drizzle-kit generate --ignore-conflicts option

The --ignore-conflicts option skips commutativity checks and allows the generate command to bypass conflict detection. Default is false. Use this only if necessary; if needed frequently, it may indicate a bug in drizzle-kit that should be reported.

drizzle-kit generate CLI options

drizzle-kit generate has the following CLI-only options: 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 configuration options table

Configuration options for drizzle-kit generate: dialect (required, database dialect like postgresql), schema (required, path to TypeScript schema file(s) or folder(s)), driver (optional, one of aws-data-api or pglite), out (optional, migrations output folder, default is ./drizzle), config (optional, configuration file path, default is drizzle.config.ts), breakpoints (optional, SQL statements breakpoints, default is true).

drizzle-kit pull example with config file

Example drizzle.config.ts for drizzle-kit pull: import { defineConfig } from 'drizzle-kit'; export default defineConfig({ dialect: 'postgresql', dbCredentials: { url: 'postgresql://user:password@host:port/dbname' } }); Then run: npx drizzle-kit pull

drizzle-kit pull command purpose

The drizzle-kit pull command introspects an existing database schema and generates a schema.ts Drizzle schema file. It is designed to support the database-first approach to migrations.

drizzle-kit pull workflow

When you run drizzle-kit pull, it performs two steps: first, it pulls the database schema (DDL) from your existing database; second, it generates a schema.ts Drizzle schema file and saves it to the out folder.

drizzle-kit pull required parameters

The drizzle-kit pull command requires you to specify dialect and either a database connection url or user:password@host:port/db params. These can be provided via drizzle.config.ts config file or CLI options.

drizzle-kit pull --init flag

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. Command: npx drizzle-kit pull --init

drizzle-kit pull filter options

By default, drizzle-kit pull manages all tables in all schemas. You can configure filtering with tablesFilter, schemaFilter, and extensionsFilters options. tablesFilter accepts glob-based table name filters with default '*'. schemaFilter accepts glob-based schema name filters with default '*'. extensionsFilters is a list of installed database extensions with default empty list.

drizzle-kit pull CLI options reference

The following CLI options are available for drizzle-kit pull: dialect (required), driver (optional), out (default ./drizzle), url, user, password, host, port, database, config (default drizzle.config.ts), introspect-casing (preserve or camel), tablesFilter, schemaFilter (default ['*']), extensionsFilters.

drizzle-kit pull example with CLI options

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

drizzle-kit pull AWS Data API configuration

Example drizzle.config.ts for AWS Data API: import { defineConfig } from 'drizzle-kit'; export default defineConfig({ dialect: 'postgresql', driver: 'aws-data-api', dbCredentials: { database: 'database', resourceArn: 'resourceArn', secretArn: 'secretArn' } });

drizzle-kit pull PGLite configuration

Example drizzle.config.ts for PGLite: import { defineConfig } from 'drizzle-kit'; export default defineConfig({ dialect: 'postgresql', driver: 'pglite', dbCredentials: { url: ':memory:' } }); For database folder use: url: './database/'

drizzle-kit pull schema filtering example

Example drizzle.config.ts with filters: 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: ['*'] }); Then run: npx drizzle-kit pull

drizzle-kit database driver selection

Drizzle Kit does not come with a pre-bundled database driver. It will automatically pick an available database driver from your current project based on the dialect. Exceptions like aws-data-api, pglite, and d1-http require explicitly specifying the driver param.

drizzle-kit multiple config files

You can have multiple config files in one project by specifying different config file paths with the --config option. This is useful when you have multiple database stages or multiple databases in the same project, for example drizzle-kit push --config=drizzle-dev.config.ts and drizzle-kit push --config=drizzle-prod.config.ts.

drizzle-kit push how it works

When you run drizzle-kit push it performs the following steps: (1) reads through your Drizzle schema file(s) and composes a JSON snapshot of your schema, (2) pulls (introspects) the database schema, (3) generates SQL migrations based on differences between the two schemas, and (4) applies the SQL migrations to the database.

drizzle-kit push command purpose

The drizzle-kit push command lets you push your schema and subsequent schema changes directly to the database while omitting SQL file generation. It is designed to cover the code-first approach of Drizzle migrations.

drizzle-kit push example with config file

Example drizzle.config.ts file: import { defineConfig } from 'drizzle-kit'; export default defineConfig({ dialect: 'postgresql', schema: './src/schema.ts', dbCredentials: { url: 'postgresql://user:password@host:port/dbname' } }); Run with: npx drizzle-kit push

drizzle-kit push schema files configuration

You can have a single schema.ts file or multiple schema files spread across the project. The schema option requires you to specify path(s) to them as a glob pattern.

drizzle-kit push use cases

drizzle-kit push is the best approach for rapid prototyping. It pairs exceptionally well with blue/green deployment strategy and serverless databases like Planetscale, Neon, and Turso.

drizzle-kit push example with schema and extensions

drizzle-kit push all configuration parameters

Configuration parameters for drizzle-kit push: dialect (required, database dialect), schema (required, path to typescript schema file(s) or folder(s)), driver (drivers exceptions like aws-data-api, pglite), tablesFilter (table name filter), schemaFilter (schema name filter, default ['*']), extensionsFilters (database extensions internal database filters), url (database connection string), user (database user), password (database password), host (host), port (port), database (database name), config (configuration file path, default='drizzle.config.ts').

drizzle-kit push CLI-only options

drizzle-kit push has the following CLI-only options: verbose (print all SQL statements prior to execution), explain (print the planned SQL changes without applying them, a dry run), and force (auto-accept all data-loss statements).

drizzle-kit push filtering options

drizzle-kit push will manage all tables and schemas by default. You can configure this via tablesFilter (glob-based table names filter, default '*'), schemaFilter (schema names filter, default ['*']), and extensionsFilters (list of installed database extensions, default []).

drizzle-kit push required configuration

drizzle-kit push requires you to specify dialect, path to schema file(s), and either a database connection url or user:password@host:port/db params. These can be provided via drizzle.config.ts config file or via CLI options.

drizzle-kit studio default server address

By default, the drizzle-kit studio command starts a Drizzle Studio server on 127.0.0.1:4983.

drizzle-kit studio command basic setup

The drizzle-kit studio command spins up a server for Drizzle Studio hosted on local.drizzle.studio. It requires database connection credentials specified in a drizzle.config.ts file with dialect set to 'postgresql' and dbCredentials containing a PostgreSQL connection URL.

drizzle-kit studio --port and --host CLI options

The drizzle-kit studio command accepts --port and --host 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'.

drizzle-kit studio --verbose flag

The drizzle-kit studio command accepts a --verbose flag to enable logging of every SQL statement executed.

Safari and Brave localhost access with 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' following the mkcert installation steps, and then restart the drizzle-kit studio server.

Drizzle Studio chrome extension database support

A Drizzle Studio chrome extension is available that lets you browse PlanetScale, Cloudflare D1, and Vercel Postgres serverless databases directly in their vendor admin panels.

Drizzle Studio hosted version limitations

The hosted version of Drizzle Studio is meant to be used for local development only and is not meant to be used on remote servers (VPS, etc). For deploying Drizzle Studio to a VPS, an alpha version of Drizzle Studio Gateway is available at gateway.drizzle.team.

Give your agent this brain