migrate() — drizzle-orm Function Reference

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

Function typescript DrizzleORM RelationalQuery

Entity Profile

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

Dependency Diagram

graph TD
  7f81ddd7_9981_c04e_7371_8ab9d28c1fab["migrate()"]
  0b7b7bce_5997_3526_337c_899ad430a0cd["migrator.ts"]
  7f81ddd7_9981_c04e_7371_8ab9d28c1fab -->|defined in| 0b7b7bce_5997_3526_337c_899ad430a0cd
  style 7f81ddd7_9981_c04e_7371_8ab9d28c1fab fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/planetscale-serverless/migrator.ts lines 5–12

export async function migrate<TSchema extends Record<string, unknown>>(
	db: PlanetScaleDatabase<TSchema>,
	config: MigrationConfig,
) {
	const migrations = readMigrationFiles(config);

	await db.dialect.migrate(migrations, db.session, config);
}