migrate() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects calls 1 called by 1

Entity Profile

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

Dependency Diagram

graph TD
  0539c249_2af2_9651_a840_2b54f8869212["migrate()"]
  7d4ff80f_0ea3_5189_875c_e681d73995cd["migrator.ts"]
  0539c249_2af2_9651_a840_2b54f8869212 -->|defined in| 7d4ff80f_0ea3_5189_875c_e681d73995cd
  e2806702_d7b1_7ed8_187b_8b73e80e8c0b["useMigrations()"]
  e2806702_d7b1_7ed8_187b_8b73e80e8c0b -->|calls| 0539c249_2af2_9651_a840_2b54f8869212
  bf9d2cae_85d0_b3bd_5d67_4100905c79f6["readMigrationFiles()"]
  0539c249_2af2_9651_a840_2b54f8869212 -->|calls| bf9d2cae_85d0_b3bd_5d67_4100905c79f6
  style 0539c249_2af2_9651_a840_2b54f8869212 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/op-sqlite/migrator.ts lines 41–47

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