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

Relationship Graph

Source Code

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

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