preparePgDbPushSnapshot() — drizzle-orm Function Reference

Architecture documentation for the preparePgDbPushSnapshot() function in migrationPreparator.ts from the drizzle-orm codebase.

Function typescript DrizzleKit SnapshotSerializer calls 1

Entity Profile

DrizzleKit→ SnapshotSerializer→ preparePgDbPushSnapshot() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  cb1339e8_8bfe_65f3_12db_e281fe574c88["preparePgDbPushSnapshot()"]
  4078709f_3fc0_5514_7728_8f28a7b0e807["migrationPreparator.ts"]
  cb1339e8_8bfe_65f3_12db_e281fe574c88 -->|defined in| 4078709f_3fc0_5514_7728_8f28a7b0e807
  dd36a37c_7a7b_0f61_31c0_b6a9f9c621ef["serializePg()"]
  cb1339e8_8bfe_65f3_12db_e281fe574c88 -->|calls| dd36a37c_7a7b_0f61_31c0_b6a9f9c621ef
  style cb1339e8_8bfe_65f3_12db_e281fe574c88 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/migrationPreparator.ts lines 64–79

export const preparePgDbPushSnapshot = async (
	prev: PgSchema,
	schemaPath: string | string[],
	casing: CasingType | undefined,
	schemaFilter: string[] = ['public'],
): Promise<{ prev: PgSchema; cur: PgSchema }> => {
	const serialized = await serializePg(schemaPath, casing, schemaFilter);

	const id = randomUUID();
	const idPrev = prev.id;

	const { version, dialect, ...rest } = serialized;
	const result: PgSchema = { version, dialect, id, prevId: idPrev, ...rest };

	return { prev, cur: result };
};