serializePg() — drizzle-orm Function Reference

Architecture documentation for the serializePg() function in index.ts from the drizzle-orm codebase.

Function typescript DrizzleKit SnapshotSerializer calls 1 called by 2

Entity Profile

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

Dependency Diagram

graph TD
  dd36a37c_7a7b_0f61_31c0_b6a9f9c621ef["serializePg()"]
  c3eb904f_5390_9c0d_4b12_54d182c5f8c9["index.ts"]
  dd36a37c_7a7b_0f61_31c0_b6a9f9c621ef -->|defined in| c3eb904f_5390_9c0d_4b12_54d182c5f8c9
  cb1339e8_8bfe_65f3_12db_e281fe574c88["preparePgDbPushSnapshot()"]
  cb1339e8_8bfe_65f3_12db_e281fe574c88 -->|calls| dd36a37c_7a7b_0f61_31c0_b6a9f9c621ef
  3311f44b_d157_63e7_4694_edf07b92c90e["preparePgMigrationSnapshot()"]
  3311f44b_d157_63e7_4694_edf07b92c90e -->|calls| dd36a37c_7a7b_0f61_31c0_b6a9f9c621ef
  d2a6d85b_7d3b_7d17_794c_d2cd77de724c["prepareFilenames()"]
  dd36a37c_7a7b_0f61_31c0_b6a9f9c621ef -->|calls| d2a6d85b_7d3b_7d17_794c_d2cd77de724c
  style dd36a37c_7a7b_0f61_31c0_b6a9f9c621ef fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/serializer/index.ts lines 28–43

export const serializePg = async (
	path: string | string[],
	casing: CasingType | undefined,
	schemaFilter?: string[],
): Promise<PgSchemaInternal> => {
	const filenames = prepareFilenames(path);

	const { prepareFromPgImports } = await import('./pgImports');
	const { generatePgSnapshot } = await import('./pgSerializer');

	const { tables, enums, schemas, sequences, views, matViews, roles, policies } = await prepareFromPgImports(
		filenames,
	);

	return generatePgSnapshot(tables, enums, schemas, sequences, roles, policies, views, matViews, casing, schemaFilter);
};