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

Relationship Graph

Source Code

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

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