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
  6b0776e5_d57e_483f_3a5b_2621d94ffd97["migrate()"]
  e9ef704a_94d2_fa38_eb96_a906671c8618["migrator.ts"]
  6b0776e5_d57e_483f_3a5b_2621d94ffd97 -->|defined in| e9ef704a_94d2_fa38_eb96_a906671c8618
  style 6b0776e5_d57e_483f_3a5b_2621d94ffd97 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

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

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