migrator.ts — drizzle-orm Source File

Architecture documentation for migrator.ts, a typescript file in the drizzle-orm codebase. 2 imports, 0 dependents.

File typescript DrizzleORM DatabaseDrivers 2 imports 1 functions

Entity Profile

DrizzleORM→ DatabaseDrivers→ migrator.ts — drizzle-orm Source File

Dependency Diagram

graph LR
  ddd2412c_eedb_e4aa_abe8_44dd33a2c489["migrator.ts"]
  3f58c8f4_b305_acb0_933a_0541231c5109["node:crypto"]
  ddd2412c_eedb_e4aa_abe8_44dd33a2c489 --> 3f58c8f4_b305_acb0_933a_0541231c5109
  2d633401_942b_22be_b321_0596b127f739["node:fs"]
  ddd2412c_eedb_e4aa_abe8_44dd33a2c489 --> 2d633401_942b_22be_b321_0596b127f739
  style ddd2412c_eedb_e4aa_abe8_44dd33a2c489 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import crypto from 'node:crypto';
import fs from 'node:fs';

export interface KitConfig {
	out: string;
	schema: string;
}

export interface MigrationConfig {
	migrationsFolder: string;
	migrationsTable?: string;
	migrationsSchema?: string;
}

export interface MigrationMeta {
	sql: string[];
	folderMillis: number;
	hash: string;
	bps: boolean;
}

export function readMigrationFiles(config: MigrationConfig): MigrationMeta[] {
	const migrationFolderTo = config.migrationsFolder;

	const migrationQueries: MigrationMeta[] = [];

	const journalPath = `${migrationFolderTo}/meta/_journal.json`;
	if (!fs.existsSync(journalPath)) {
		throw new Error(`Can't find meta/_journal.json file`);
	}

	const journalAsString = fs.readFileSync(`${migrationFolderTo}/meta/_journal.json`).toString();

	const journal = JSON.parse(journalAsString) as {
		entries: { idx: number; when: number; tag: string; breakpoints: boolean }[];
	};

	for (const journalEntry of journal.entries) {
		const migrationPath = `${migrationFolderTo}/${journalEntry.tag}.sql`;

		try {
			const query = fs.readFileSync(`${migrationFolderTo}/${journalEntry.tag}.sql`).toString();

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

			migrationQueries.push({
				sql: result,
				bps: journalEntry.breakpoints,
				folderMillis: journalEntry.when,
				hash: crypto.createHash('sha256').update(query).digest('hex'),
			});
		} catch {
			throw new Error(`No file ${migrationPath} found in ${migrationFolderTo} folder`);
		}
	}

	return migrationQueries;
}