migrate() — drizzle-orm Function Reference

Architecture documentation for the migrate() function in migrator.ts from the drizzle-orm codebase.

Function typescript DrizzleORM DatabaseDrivers

Entity Profile

DrizzleORM→ DatabaseDrivers→ migrate() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  063ead87_b5c3_36a2_a586_07c7a740f9ce["migrate()"]
  79b7744e_cd60_beff_1893_365cc454b4a2["migrator.ts"]
  063ead87_b5c3_36a2_a586_07c7a740f9ce -->|defined in| 79b7744e_cd60_beff_1893_365cc454b4a2
  style 063ead87_b5c3_36a2_a586_07c7a740f9ce fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/node-postgres/migrator.ts lines 5–11

export async function migrate<TSchema extends Record<string, unknown>>(
	db: NodePgDatabase<TSchema>,
	config: MigrationConfig,
) {
	const migrations = readMigrationFiles(config);
	await db.dialect.migrate(migrations, db.session, config);
}