readMigrationFiles() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects called by 1

Entity Profile

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

Dependency Diagram

graph TD
  7cddbd66_0608_0488_fc3b_32e74dc95354["readMigrationFiles()"]
  9968bfac_85c0_4a20_fc14_94b2593d793b["migrator.ts"]
  7cddbd66_0608_0488_fc3b_32e74dc95354 -->|defined in| 9968bfac_85c0_4a20_fc14_94b2593d793b
  0d623036_b199_8b3b_cb5f_f1302b90809e["migrate()"]
  0d623036_b199_8b3b_cb5f_f1302b90809e -->|calls| 7cddbd66_0608_0488_fc3b_32e74dc95354
  style 7cddbd66_0608_0488_fc3b_32e74dc95354 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/durable-sqlite/migrator.ts lines 12–39

function readMigrationFiles({ journal, migrations }: MigrationConfig): MigrationMeta[] {
	const migrationQueries: MigrationMeta[] = [];

	for (const journalEntry of journal.entries) {
		const query = migrations[`m${journalEntry.idx.toString().padStart(4, '0')}`];

		if (!query) {
			throw new Error(`Missing migration: ${journalEntry.tag}`);
		}

		try {
			const result = query.split('--> statement-breakpoint').map((it) => {
				return it;
			});

			migrationQueries.push({
				sql: result,
				bps: journalEntry.breakpoints,
				folderMillis: journalEntry.when,
				hash: '',
			});
		} catch {
			throw new Error(`Failed to parse migration: ${journalEntry.tag}`);
		}
	}

	return migrationQueries;
}