import CodeTab from "@mdx/CodeTab.astro"; import CodeTabs from "@mdx/CodeTabs.astro"; import Section from "@mdx/Section.astro"; import Tab from "@mdx/Tab.astro"; import Tabs from "@mdx/Tabs.astro"; import Callout from "@mdx/Callout.astro"; import Prerequisites from "@mdx/Prerequisites.astro"; import Npx from "@mdx/Npx.astro"; # `drizzle-kit migrate` - Get started with Drizzle and `drizzle-kit` - [read here](/docs/get-started) - Drizzle schema fundamentals - [read here](/docs/sql-schema-declaration) - Database connection basics - [read here](/docs/connect-overview) - Drizzle migrations fundamentals - [read here](/docs/migrations) - Drizzle Kit [overview](/docs/kit-overview) and [config file](/docs/drizzle-config-file) - `drizzle-kit generate` command - [read here](/docs/drizzle-kit-generate)
`drizzle-kit migrate` lets you apply SQL migrations generated by [`drizzle-kit generate`](/docs/drizzle-kit-generate). It's designed to cover [code first(option 3)](/docs/migrations) approach of managing Drizzle migrations. Drizzle Kit `migrate` command triggers a sequence of events: 1. Reads through migration folder and read all `.sql` migration files 2. Connects to the database and fetches entries from drizzle migrations log table 3. Based on previously applied migrations it will decide which new migrations to run 4. Runs SQL migrations and logs applied migrations to drizzle migrations table

```plaintext ├ 📂 drizzle │ ├ 📂 _meta │ ├ 📜 0000_premium_mister_fear.sql │ └ 📜 0001_delicate_professor_xavie.sql └ … ``` ```plaintext ┌───────────────────────┐ │ $ drizzle-kit migrate │ └─┬─────────────────────┘ │ ┌──────────────────────────┐ └ 1. reads migration.sql files in migrations folder │ │ 2. fetch migration history from database -------------> │ │ ┌ 3. pick previously unapplied migrations <-------------- │ DATABASE │ └ 4. apply new migration to the database ---------------> │ │ │ │ └──────────────────────────┘ [✓] done! ```

`drizzle-kit migrate` command requires you to specify both `dialect` and database connection credentials, you can provide them either via [drizzle.config.ts](/docs/drizzle-config-file) config file or via CLI options

```ts {5,8} // drizzle.config.ts import { defineConfig } from "drizzle-kit"; export default defineConfig({ dialect: "postgresql", schema: "./src/schema.ts", dbCredentials: { url: "postgresql://user:password@host:port/dbname" }, }); ``` ```shell npx drizzle-kit migrate ```

```shell npx drizzle-kit migrate --dialect=postgresql --url=postgresql://user:password@host:port/dbname ``` ### Applied migrations log in the database Upon running migrations Drizzle Kit will persist records about successfully applied migrations in your database. It will store them in migrations log table named `__drizzle_migrations`. You can customise both **table** and **schema**(PostgreSQL only) of that table via drizzle config file: ```ts filename="drizzle.config.ts" {8-9} export default defineConfig({ dialect: "postgresql", schema: "./src/schema.ts", dbCredentials: { url: "postgresql://user:password@host:port/dbname" }, migrations: { table: 'my-migrations-table', // `__drizzle_migrations` by default schema: 'public', // used in PostgreSQL only, `drizzle` by default }, }); ``` ### 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 on the same project: drizzle-kit migrate --config=drizzle-dev.config.ts drizzle-kit migrate --config=drizzle-prod.config.ts ```plaintext {5-6} 📦 ├ 📂 drizzle ├ 📂 src ├ 📜 .env ├ 📜 drizzle-dev.config.ts ├ 📜 drizzle-prod.config.ts ├ 📜 package.json └ 📜 tsconfig.json ``` ### Extended example Let's generate SQL migration and apply it to our database using `drizzle-kit generate` and `drizzle-kit migrate` commands ```plaintext 📦 ├ 📂 drizzle ├ 📂 src │ ├ 📜 schema.ts │ └ 📜 index.ts ├ 📜 drizzle.config.ts └ … ``` ```ts import { defineConfig } from "drizzle-kit"; export default defineConfig({ dialect: "postgresql", schema: "./src/schema.ts", dbCredentials: { url: "postgresql://user:password@host:port/dbname" }, migrations: { table: 'journal', schema: 'drizzle', }, }); ``` ```ts import * as p from "drizzle-orm/pg-core"; export const users = p.pgTable("users", { id: p.serial().primaryKey(), name: p.text(), }) ``` Now let's run ```shell npx drizzle-kit generate --name=init ``` it will generate

```plaintext {5} 📦 ├ … ├ 📂 migrations │ ├ 📂 _meta │ └ 📜 0000_init.sql └ … ``` ```sql -- ./drizzle/0000_init.sql CREATE TABLE "users"( id serial primary key, name text ) ```

Now let's run ```shell npx drizzle-kit migrate ``` and our SQL migration is now successfully applied to the database ✅