dropMigration() — drizzle-orm Function Reference

Architecture documentation for the dropMigration() function in drop.ts from the drizzle-orm codebase.

Function typescript DrizzleKit CLIWorkflow calls 1 called by 1

Entity Profile

DrizzleKit→ CLIWorkflow→ dropMigration() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  9db4762b_73d0_9f4c_0b4a_81e3441cd04e["dropMigration()"]
  abecef96_5a79_62f4_9fa7_4cac90f0bb61["drop.ts"]
  9db4762b_73d0_9f4c_0b4a_81e3441cd04e -->|defined in| abecef96_5a79_62f4_9fa7_4cac90f0bb61
  c0a6d9e9_7fc7_f2f9_8914_70f0c4f8233f["drop.handler()"]
  c0a6d9e9_7fc7_f2f9_8914_70f0c4f8233f -->|calls| 9db4762b_73d0_9f4c_0b4a_81e3441cd04e
  a11e5277_29c6_14fc_5eda_d9fa4ed1ddc8["embeddedMigrations()"]
  9db4762b_73d0_9f4c_0b4a_81e3441cd04e -->|calls| a11e5277_29c6_14fc_5eda_d9fa4ed1ddc8
  style 9db4762b_73d0_9f4c_0b4a_81e3441cd04e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/cli/commands/drop.ts lines 10–60

export const dropMigration = async ({
	out,
	bundle,
}: {
	out: string;
	bundle: boolean;
}) => {
	const metaFilePath = join(out, 'meta', '_journal.json');
	const journal = JSON.parse(readFileSync(metaFilePath, 'utf-8')) as Journal;

	if (journal.entries.length === 0) {
		console.log(
			`[${chalk.blue('i')}] no migration entries found in ${metaFilePath}`,
		);
		return;
	}

	const result = await render(new DropMigrationView(journal.entries));
	if (result.status === 'aborted') return;

	delete journal.entries[journal.entries.indexOf(result.data!)];

	const resultJournal: Journal = {
		...journal,
		entries: journal.entries.filter(Boolean),
	};
	const sqlFilePath = join(out, `${result.data.tag}.sql`);
	const snapshotFilePath = join(
		out,
		'meta',
		`${result.data.tag.split('_')[0]}_snapshot.json`,
	);
	rmSync(sqlFilePath);
	rmSync(snapshotFilePath);
	writeFileSync(metaFilePath, JSON.stringify(resultJournal, null, 2));

	if (bundle) {
		fs.writeFileSync(
			join(out, `migrations.js`),
			embeddedMigrations(resultJournal),
		);
	}

	console.log(
		`[${chalk.green('✓')}] ${
			chalk.bold(
				result.data.tag,
			)
		} migration successfully dropped`,
	);
};