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

Relationship Graph

Source Code

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

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