Drizzle Kit is a CLI tool for managing migrations
Drizzle Kit is a CLI tool for managing SQL database migrations with Drizzle.
drizzle-kit
19 notes, read out of this brain and free to use. Each one was extracted from a source and is re-checked against its exam.
Drizzle Kit commands overview
Drizzle Kit provides these commands: drizzle-kit generate (generates SQL migration files based on schema), drizzle-kit migrate (applies generated SQL migration files to database), drizzle-kit pull (introspects database schema and converts it to Drizzle schema), drizzle-kit push (pushes Drizzle schema to database), drizzle-kit studio (connects to database and spins up proxy server for Drizzle Studio), drizzle-kit check (checks for race conditions in generated migrations), and drizzle-kit up (upgrades snapshots of previously generated migrations).
Remove dialect prefixes from drizzle-kit commands
In drizzle-kit 0.21.0, the dialect prefix has been removed from CLI commands. Change commands from the old format like `drizzle-kit push:mysql` to the new format like `drizzle-kit push`. The dialect is now specified in the drizzle.config.ts file instead of on the command line.
MySQL schema support removed from drizzle-kit in 0.21.0
As of drizzle-kit 0.21.0, MySQL schemas and databases in the drizzle schema file are no longer supported. Drizzle Kit will not handle schema changes for additional schemas or databases in MySQL.
drizzle-kit architectural redesign from snapshots to DDL
The drizzle-kit has been architecturally redesigned to use DDL snapshots instead of database snapshots.
drizzle-kit v0.23.2 PostgreSQL schemaFilter enum detection bug
Fixed a bug in PostgreSQL with push and introspect commands where the schemaFilter object was passed. The bug caused enums to be detected even in schemas that were not defined in the schemaFilter.
drizzle-kit up command sequences release fix
Fixed the drizzle-kit up command to work as expected, starting from the sequences release.
Drizzle ORM v0.29.0 requires Drizzle Kit v0.20.0 minimum
Drizzle ORM version 0.29.0 requires a minimum Drizzle Kit version of 0.20.0, and vice versa. When upgrading to a newer version of Drizzle ORM, you must also upgrade Drizzle Kit. This may result in breaking changes throughout the versions, especially if you need to upgrade Drizzle Kit and your Drizzle ORM version is older than 0.28.0.
Drizzle Kit 0.20.0 features
Drizzle Kit 0.20.0 includes: new way to define drizzle.config using defineConfig function, possibility to access Cloudflare D1 with Drizzle Studio using wrangler.toml file, Drizzle Studio migrating to https://local.drizzle.studio/, bigint unsigned support, primaryKeys and foreignKeys can have custom names, environment variables are now automatically fetched, and various bug fixes and improvements.
drizzle-kit v0.22.0 compatibility requirement
Drizzle ORM v0.31.0 requires drizzle-kit v0.22.0 or higher. When running a Drizzle Kit command with v0.31.0, it will check and prompt for an upgrade if needed.
Upgrade requirement for new features in v0.32.0
To use new features in both queries and migrations in drizzle-orm v0.32.0, both drizzle-orm and drizzle-kit packages need to be upgraded. It is not mandatory to upgrade both packages if you do not need the new features.
drizzle-kit full rewrite in v1.0.0-beta.2
Drizzle v1.0.0-beta.2 includes a complete architecture rewrite of drizzle-kit addressing major kit and migration issues. Key improvements: migrated from database snapshots to database DDL snapshots, reworked architecture for detecting and applying diffs, added improvements for defaults, expressions, and types detection, reduced schema introspection time from 10 seconds to under 1 second, added query hints and explain support for push, and expanded test coverage with each test case running up to 6 different scenarios.
drizzle-kit check command purpose
The drizzle-kit check command lets you check consistency of your generated SQL migrations history. This is extremely useful when you have multiple developers working on the project and altering database schema on different branches.
drizzle-kit check requires dialect parameter
The drizzle-kit check command requires you to specify the dialect parameter. You can provide it either via the drizzle.config.ts config file or via CLI options.
drizzle-kit check basic usage with config file
To use drizzle-kit check with a config file, set the dialect in drizzle.config.ts (e.g., dialect: "mysql") and then run 'npx drizzle-kit check' from the command line.
drizzle-kit check basic usage with CLI options
To use drizzle-kit check with CLI options, run 'npx drizzle-kit check --dialect=mysql' from the command line.
drizzle-kit check multiple config files
You can have multiple config files in the project by using the --config flag. For example, 'npx drizzle-kit check --config=drizzle-dev.config.ts' and 'npx drizzle-kit check --config=drizzle-prod.config.ts' allow you to manage different database stages or multiple databases in the same project.
drizzle-kit check CLI configuration options
The drizzle-kit check command supports the following CLI options: dialect (required, database dialect being used, can be mysql, postgresql, sqlite, etc.), out (optional, migrations folder, default='./drizzle'), config (optional, configuration file path, default='drizzle.config.ts').
drizzle-kit check CLI example with out option
You can specify a custom migrations folder using the --out option, for example: 'npx drizzle-kit check --dialect=mysql --out=./migrations-folder'