generateMigration() — drizzle-orm Function Reference

Architecture documentation for the generateMigration() function in api.ts from the drizzle-orm codebase.

Function typescript DrizzleKit CLIWorkflow calls 1

Entity Profile

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

Dependency Diagram

graph TD
  9be8a94f_0ac5_3586_c117_3bc214e2beff["generateMigration()"]
  e668bfef_9125_1ef0_2f94_a0f9605584bd["api.ts"]
  9be8a94f_0ac5_3586_c117_3bc214e2beff -->|defined in| e668bfef_9125_1ef0_2f94_a0f9605584bd
  60cccf3e_0a08_14d7_0d22_dfaeb6777eb0["squashPgScheme()"]
  9be8a94f_0ac5_3586_c117_3bc214e2beff -->|calls| 60cccf3e_0a08_14d7_0d22_dfaeb6777eb0
  style 9be8a94f_0ac5_3586_c117_3bc214e2beff fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/api.ts lines 94–123

export const generateMigration = async (
	prev: DrizzleSnapshotJSON,
	cur: DrizzleSnapshotJSON,
) => {
	const { applyPgSnapshotsDiff } = await import('./snapshotsDiffer');

	const validatedPrev = pgSchema.parse(prev);
	const validatedCur = pgSchema.parse(cur);

	const squashedPrev = squashPgScheme(validatedPrev);
	const squashedCur = squashPgScheme(validatedCur);

	const { sqlStatements, _meta } = await applyPgSnapshotsDiff(
		squashedPrev,
		squashedCur,
		schemasResolver,
		enumsResolver,
		sequencesResolver,
		policyResolver,
		indPolicyResolver,
		roleResolver,
		tablesResolver,
		columnsResolver,
		viewsResolver,
		validatedPrev,
		validatedCur,
	);

	return sqlStatements;
};