drizzle-kit generate extended example cockroach
Example demonstrating how to create a custom CockroachDB migration file named '0001_seed-users.sql' with Drizzle schema in './src/schema.ts' and migrations folder in './migrations' instead of the default './drizzle'. The config file is placed in './configs/drizzle.config.ts' with dialect set to 'cockroach', schema path as './src/schema.ts', and out path as './migrations'. Run: 'npx drizzle-kit generate --config=./configs/drizzle.config.ts --name=seed-users --custom'
drizzle-kit migrate with config file syntax
To run drizzle-kit migrate with a config file, define drizzle.config.ts with dialect (set to 'cockroach'), schema, and dbCredentials.url, then run: npx drizzle-kit migrate
drizzle-kit migrate command purpose
The drizzle-kit migrate command applies SQL migrations generated by drizzle-kit generate. It is designed to cover the code-first approach of managing Drizzle migrations.
drizzle-kit migrate workflow steps
The drizzle-kit migrate command performs these steps: 1. Reads through migration folder and reads all .sql migration files. 2. Connects to the database and fetches entries from drizzle migrations log table. 3. Based on previously applied migrations, it decides which new migrations to run. 4. Runs SQL migrations and logs applied migrations to drizzle migrations table.
drizzle-kit migrate requires dialect and database credentials
The drizzle-kit migrate command requires you to specify both dialect and database connection credentials. You can provide them either via drizzle.config.ts config file or via CLI options.
drizzle-kit migrate with CLI options syntax
To run drizzle-kit migrate with CLI options, use: npx drizzle-kit migrate --dialect=cockroach --url=postgresql://user:password@host:port/dbname
drizzle migrations log table name and schema
When migrations are applied, Drizzle Kit stores records about successfully applied migrations in a migrations log table named __drizzle_migrations in the drizzle schema by default. Both the table name and schema can be customized via the drizzle.config.ts file using migrations.table and migrations.schema properties.
drizzle-kit migrate with custom migrations table configuration
To customize the migrations log table in drizzle.config.ts, use the migrations object with table and schema properties: migrations: { table: 'my-migrations-table', schema: 'public' }. The default table is __drizzle_migrations and default schema is drizzle.
drizzle-kit migrate with multiple config files
You can have multiple config files in a project for different database stages or multiple databases. Use the --config option to specify which config file to use: npx drizzle-kit migrate --config=drizzle-dev.config.ts or npx drizzle-kit migrate --config=drizzle-prod.config.ts
drizzle-kit generate and migrate workflow example
The typical workflow is: 1. Define schema in src/schema.ts with tables using drizzle-orm/cockroach-core. 2. Configure drizzle.config.ts with dialect, schema path, and dbCredentials. 3. Run npx drizzle-kit generate --name=init to generate migration files in the drizzle folder. 4. Run npx drizzle-kit migrate to apply the generated SQL migrations to the database.
drizzle-kit pull command introspects existing database schema
The drizzle-kit pull command lets you introspect your existing database schema and generate a schema.ts drizzle schema file. It pulls the database schema (DDL) from your existing database and generates a TypeScript Drizzle schema file saved to the out folder. This approach is designed to cover the database-first approach of Drizzle migrations.
drizzle-kit pull requires dialect and database connection parameters
The drizzle-kit pull command requires you to specify the dialect and either a database connection url or user:password@host:port/db parameters. These can be provided via the drizzle.config.ts config file or via CLI options.
drizzle-kit pull configuration with config file
Example drizzle.config.ts configuration: dialect is set to the database type (e.g., 'cockroach'), and dbCredentials contains the url property with the database connection string in the format postgresql://user:password@host:port/dbname. Then run: npx drizzle-kit pull
drizzle-kit pull CLI options syntax
Example CLI command: npx drizzle-kit pull --dialect=cockroach --url=postgresql://user:password@host:port/dbname. This allows you to specify all configuration via command line instead of a config file.
drizzle-kit pull --init flag marks schema as applied migration
You can use the --init flag with drizzle-kit pull to mark the pulled schema as an applied migration in your database. This ensures that all subsequent migrations are diffed against the initial one. Command: npx drizzle-kit pull --init
drizzle-kit pull filtering: tablesFilter, schemaFilter, extensionFilters
The drizzle-kit pull command by default manages all tables in all schemas. You can configure filtering via: tablesFilter (glob-based table names filter, e.g. ['users', 'user_info'] or 'user*', defaults to '*'), schemaFilter (glob-based schema names filter, e.g. ['public', 'drizzle'] or 'drizzle*', defaults to '*'), and extensionFilters (for managing extensions).
drizzle-kit pull configuration file example with filters
Example drizzle.config.ts with schema and table filters: import { defineConfig } from 'drizzle-kit'; export default defineConfig({ dialect: 'cockroach', schema: './src/schema.ts', dbCredentials: { url: 'postgresql://user:password@host:port/dbname' }, schemaFilter: ['public'], tablesFilter: ['*'] });
drizzle-kit pull CLI options reference table
Configuration options for drizzle-kit pull: dialect (required) - Database dialect; driver - Drivers exceptions; out - Migrations output folder path, default './drizzle'; 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'; introspect-casing - Strategy for JS keys creation in columns/tables, options: preserve, camel; tablesFilter - Table name filter; schemaFilter - Schema name filter, default ['*']
drizzle-kit pull CLI examples
CLI usage examples: npx drizzle-kit pull --dialect=cockroach --url=postgresql://user:password@host:port/dbname; npx drizzle-kit pull --dialect=cockroach --driver=pglite url=database/; npx drizzle-kit pull --dialect=cockroach --tablesFilter='user*' url=postgresql://user:password@host:port/dbname
drizzle-kit push CLI-only options
drizzle-kit push has three CLI-only options: verbose (print all SQL statements prior to execution), explain (print the planned SQL changes without applying them, dry run), and force (auto-accept all data-loss statements).
drizzle-kit push configuration parameters
Configuration parameters for drizzle-kit push: dialect (required, one of the supported database dialects), schema (required, path to TypeScript schema file(s) or folder(s) with multiple schema files), tablesFilter (optional, table name filter), schemaFilter (optional, schema name filter, default is ["*"]), url (optional, database connection string), user (optional, database user), password (optional, database password), host (optional, host), port (optional, port), database (optional, database name), config (optional, configuration file path, default is drizzle.config.ts).
drizzle-kit push with CLI options example
Configuration via CLI options: `npx drizzle-kit push --dialect=cockroach --schema=./src/schema.ts --url=postgresql://user:password@host:port/dbname`
drizzle-kit push CLI configuration examples
Examples of drizzle-kit push with CLI parameters:
```
npx drizzle-kit push dialect=cockroach schema=src/schema.ts url=postgresql://user:password@host:port/dbname
npx drizzle-kit push dialect=cockroach schema=src/schema.ts driver=pglite url=database/
npx drizzle-kit push dialect=cockroach schema=src/schema.ts --tablesFilter='user*' url=postgresql://user:password@host:port/dbname
```
Schema file paths in drizzle-kit push
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 as a glob via the schema configuration option.
Multiple configuration files in one project
You can have multiple config files in the project, which is useful when you have multiple database stages, multiple databases, or different databases on the same project. Use the --config option to specify which config file to use: `npx drizzle-kit push --config=drizzle-dev.config.ts`
drizzle-kit push command overview
The drizzle-kit push command lets you push your schema and subsequent schema changes directly to the database while omitting SQL files generation. It is designed to cover a code-first approach of Drizzle migrations. This command is the best approach for rapid prototyping and works well with blue/green deployment strategy and serverless databases like Planetscale, Neon, and Turso.
drizzle-kit push process under the hood
When you run drizzle-kit push, it performs four 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 schema snapshot and database schema, and (4) applies SQL migrations to the database.
drizzle-kit push required configuration
drizzle-kit push requires you to specify: dialect, path to schema file(s), and either database connection url or individual user:password@host:port/db params. You can provide these via drizzle.config.ts config file or via CLI options.
drizzle-kit push with config file example
Configuration via drizzle.config.ts:
```ts
import { defineConfig } from "drizzle-kit";
export default defineConfig({
dialect: "cockroach",
schema: "./src/schema.ts",
dbCredentials: {
url: "postgresql://user:password@host:port/dbname",
},
});
```
Then run: `npx drizzle-kit push`
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 specified in the configuration.
drizzle-kit push table and schema filtering
drizzle-kit push will manage all tables and schemas by default. You can configure list of tables and schemas via tablesFilter and schemaFilter options. tablesFilter uses glob-based table name filtering (e.g., ["users", "user_info"] or "user*", default is "*"). schemaFilter filters schema names (e.g., ["public", "drizzle"], default is "*").
drizzle-kit studio default host and port
The drizzle-kit studio command starts a Drizzle Studio server on 127.0.0.1:4983 by default.
Configure drizzle-kit studio host and port via CLI
You can configure the host and port for drizzle-kit studio using CLI options: --port=3000 to set the port, --host=0.0.0.0 to set the host, or both together.
Enable verbose logging in drizzle-kit studio
You can enable logging of every SQL statement in drizzle-kit studio by providing the --verbose flag when running the command.
Safari and Brave localhost access limitation
Safari and Brave block access to localhost by default. To work around this, you need to install mkcert, run mkcert -install, and then restart drizzle-kit studio.
drizzle-kit studio requires database connection credentials
The drizzle-kit studio command requires database connection credentials to be specified via the drizzle.config.ts config file using the dbCredentials property.
Drizzle Studio hosted version limitations
The hosted version of Drizzle Studio is meant for local development only and is not meant to be used on remote servers (VPS, etc). For remote deployment, Drizzle Studio Gateway is available as an alpha version.
Drizzle Studio chrome extension supported databases
The Drizzle Studio chrome extension lets you browse PlanetScale, Cloudflare D1, and Vercel Postgres serverless databases directly in their vendor admin panels.
drizzle-kit up with custom config file
When using multiple config files in a project, the drizzle-kit up command accepts a --config parameter to specify which config file to use. Example: npx drizzle-kit up --config=drizzle-prod.config.ts.
drizzle-kit up configuration options
The drizzle-kit up command supports the following configuration options: dialect (required, database dialect being used), out (optional, migrations folder, default ./drizzle), config (optional, configuration file path, default drizzle.config.ts).
drizzle-kit up required parameters
The drizzle-kit up command requires the dialect parameter to be specified. The dialect can be provided either via the drizzle.config.ts config file or via CLI options.
Multiple drizzle-kit config files in one project
You can have multiple config files in a project by creating separate config files like drizzle-dev.config.ts and drizzle-prod.config.ts. This is useful when you have multiple database stages or multiple databases in the same project. Specify which config to use with the --config parameter.
drizzle-kit up with config file
To use drizzle-kit up with a config file, define the dialect in drizzle.config.ts using defineConfig({ dialect: "cockroach" }) and then run npx drizzle-kit up.
drizzle-kit up with CLI options
The drizzle-kit up command can be run with CLI options: npx drizzle-kit up --dialect=cockroach.
drizzle-kit up with custom migrations folder
The drizzle-kit up command accepts an --out parameter to specify a custom migrations folder. Example: npx drizzle-kit up --dialect=cockroach --out=./migrations-folder.
drizzle-kit up command purpose
The drizzle-kit up command upgrades drizzle schema snapshots to a newer version. It is required whenever breaking changes are introduced to the JSON snapshots of the schema and the internal version is updated.
PGLite dbCredentials configuration
For PGLite, use dialect 'postgresql' with driver 'pglite'. dbCredentials.url should be a database folder path, e.g., './database/'.
migrations configuration option
The `migrations` option controls where Drizzle records successfully applied migrations. It accepts an object with `table` (string) and `schema` (string) properties. Default is { table: '__drizzle_migrations', schema: 'drizzle' }. Schema is used in PostgreSQL only. It is used by commands: migrate, push, pull.
introspect configuration option
The `introspect` option configures behavior of `drizzle-kit pull` command. It accepts an object with `casing` property which can be 'preserve' or 'camel'. Default is { casing: 'camel' }. The casing property determines how database column names are converted to TypeScript object keys.
introspect casing camel mode
When introspect.casing is set to 'camel', database column names like 'first-name', 'LastName', and 'phone_number' are converted to camelCase TypeScript keys: firstName, lastName, and phoneNumber respectively.
introspect casing preserve mode
When introspect.casing is set to 'preserve', database column names are kept exactly as they appear in the database. A column named 'first-name' remains 'first-name', 'LastName' remains 'LastName', and 'phone_number' remains 'phone_number' in the TypeScript schema.
tablesFilter configuration option
The `tablesFilter` option uses glob-based patterns to specify which tables are managed by `drizzle-kit push` and `drizzle-kit pull`. It accepts string or string array, e.g., ['users', 'user_info'] or 'user*'. It has no default value. It is used by commands: push, pull.
schemaFilter configuration option
The `schemaFilter` option uses glob-based patterns to specify which schemas are managed by `drizzle-kit push` and `drizzle-kit pull`. It accepts string array, e.g., ['public', 'auth'] or ['tenant_*']. By default, all schemas are managed. It is used by commands: push, pull.
extensionsFilters configuration option
The `extensionsFilters` option declares a list of installed database extensions (e.g., ['postgis']) that Drizzle Kit should ignore when managing schema. This prevents extension-created tables from being managed by push or pull. Default is empty array. It is used by commands: push, pull.
entities.roles configuration option
The `entities.roles` option controls role management in Drizzle Kit. It accepts boolean or an object with properties: provider ('neon' or 'supabase'), include (string array), and exclude (string array). Default is false (roles not managed). It is used by commands: push, pull, generate. When true, all roles are managed; with exclude, specific roles are skipped; with include, only specific roles are managed; with provider, platform-specific roles are automatically excluded.
verbose configuration option
The `verbose` option enables printing of all SQL statements during `drizzle-kit push` command execution. It accepts boolean. Default is true. It is used by commands: generate, pull.
breakpoints configuration option
The `breakpoints` option controls whether Drizzle Kit embeds '--> statement-breakpoint' into generated SQL migration files. This is necessary for databases like MySQL and SQLite that do not support multiple DDL alteration statements in one transaction. It accepts boolean. Default is true. It is used by commands: generate, pull.
migrations folder structure
The migrations folder (specified by the 'out' option) contains migration files organized by timestamp-named subdirectories (e.g., '20242409125510_premium_mister_fear') which contain .sql migration files generated by drizzle-kit.
multiple configuration files in one project
You can have multiple Drizzle Kit configuration files in a single project for managing multiple databases or database stages. Use the --config flag when running drizzle-kit commands, e.g., 'drizzle-kit generate --config=drizzle-dev.config.ts' or 'drizzle-kit generate --config=drizzle-prod.config.ts'.
drizzle.config.ts basic structure
A Drizzle Kit configuration file is created at the project root and uses TypeScript or JavaScript. It is exported via `defineConfig()` from 'drizzle-kit'. The minimal configuration requires three properties: `dialect` (the database type), `schema` (path to schema files), and `out` (migrations folder output directory).