generateSingleStoreMigration() — drizzle-orm Function Reference

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

Function typescript DrizzleKit CLIWorkflow calls 1

Entity Profile

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

Dependency Diagram

graph TD
  c7ed0a8e_f5a3_d4ae_2295_c3e128cc59d1["generateSingleStoreMigration()"]
  e668bfef_9125_1ef0_2f94_a0f9605584bd["api.ts"]
  c7ed0a8e_f5a3_d4ae_2295_c3e128cc59d1 -->|defined in| e668bfef_9125_1ef0_2f94_a0f9605584bd
  8b30b0b0_f854_4a9f_f8d2_9f42f47b3c3a["squashSingleStoreScheme()"]
  c7ed0a8e_f5a3_d4ae_2295_c3e128cc59d1 -->|calls| 8b30b0b0_f854_4a9f_f8d2_9f42f47b3c3a
  style c7ed0a8e_f5a3_d4ae_2295_c3e128cc59d1 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/api.ts lines 519–543

export const generateSingleStoreMigration = async (
	prev: DrizzleSingleStoreSnapshotJSON,
	cur: DrizzleSingleStoreSnapshotJSON,
) => {
	const { applySingleStoreSnapshotsDiff } = await import('./snapshotsDiffer');

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

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

	const { sqlStatements } = await applySingleStoreSnapshotsDiff(
		squashedPrev,
		squashedCur,
		tablesResolver,
		columnsResolver,
		/* singleStoreViewsResolver, */
		validatedPrev,
		validatedCur,
		'push',
	);

	return sqlStatements;
};