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

Relationship Graph

Source Code

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

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

	for await (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;
}