migrator.ts — drizzle-orm Source File

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

File typescript DrizzleORM DatabaseDrivers 3 imports 2 functions

Entity Profile

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

Dependency Diagram

graph LR
  66b88352_79db_3eb3_b594_8072321c5f6b["migrator.ts"]
  04633f6c_35dc_bba1_868c_c1d9d27cf52d["driver.ts"]
  66b88352_79db_3eb3_b594_8072321c5f6b --> 04633f6c_35dc_bba1_868c_c1d9d27cf52d
  e5e6906d_5758_78e9_01f9_fe38ab11030b["migrator.ts"]
  66b88352_79db_3eb3_b594_8072321c5f6b --> e5e6906d_5758_78e9_01f9_fe38ab11030b
  be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd["sql.ts"]
  66b88352_79db_3eb3_b594_8072321c5f6b --> be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd
  style 66b88352_79db_3eb3_b594_8072321c5f6b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { MigrationConfig } from '~/migrator.ts';
import { readMigrationFiles } from '~/migrator.ts';
import { sql } from '~/sql/sql.ts';
import type { PgRemoteDatabase } from './driver.ts';

export type ProxyMigrator = (migrationQueries: string[]) => Promise<void>;

export async function migrate<TSchema extends Record<string, unknown>>(
	db: PgRemoteDatabase<TSchema>,
	callback: ProxyMigrator,
	config: MigrationConfig,
) {
	const migrations = readMigrationFiles(config);

	const migrationTableCreate = sql`
		CREATE TABLE IF NOT EXISTS "drizzle"."__drizzle_migrations" (
			id SERIAL PRIMARY KEY,
			hash text NOT NULL,
			created_at numeric
		)
	`;

	await db.execute(sql`CREATE SCHEMA IF NOT EXISTS "drizzle"`);
	await db.execute(migrationTableCreate);

	const dbMigrations = await db.execute<{
		id: number;
		hash: string;
		created_at: string;
	}>(
		sql`SELECT id, hash, created_at FROM "drizzle"."__drizzle_migrations" ORDER BY created_at DESC LIMIT 1`,
	);

	const lastDbMigration = dbMigrations[0] ?? undefined;

	const queriesToRun: string[] = [];

	for (const migration of migrations) {
		if (
			!lastDbMigration
			|| Number(lastDbMigration.created_at)! < migration.folderMillis
		) {
			queriesToRun.push(
				...migration.sql,
				`INSERT INTO "drizzle"."__drizzle_migrations" ("hash", "created_at") VALUES('${migration.hash}', '${migration.folderMillis}')`,
			);
		}
	}

	await callback(queriesToRun);
}