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

Relationship Graph

Source Code

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

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