prepareFromPgImports() — drizzle-orm Function Reference

Architecture documentation for the prepareFromPgImports() function in pgImports.ts from the drizzle-orm codebase.

Function typescript DrizzleKit SnapshotSerializer calls 2

Entity Profile

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

Dependency Diagram

graph TD
  45914515_4337_cc32_8d5b_61b066c6f08a["prepareFromPgImports()"]
  04ea3fca_c22c_3db0_5ecd_ef1de68ce128["pgImports.ts"]
  45914515_4337_cc32_8d5b_61b066c6f08a -->|defined in| 04ea3fca_c22c_3db0_5ecd_ef1de68ce128
  54221957_c725_0bfe_4345_4f3837d39296["safeRegister()"]
  45914515_4337_cc32_8d5b_61b066c6f08a -->|calls| 54221957_c725_0bfe_4345_4f3837d39296
  8a27a37e_77c2_8cae_2be7_4372b0f5b7a7["prepareFromExports()"]
  45914515_4337_cc32_8d5b_61b066c6f08a -->|calls| 8a27a37e_77c2_8cae_2be7_4372b0f5b7a7
  style 45914515_4337_cc32_8d5b_61b066c6f08a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/serializer/pgImports.ts lines 73–114

export const prepareFromPgImports = async (imports: string[]) => {
	const tables: AnyPgTable[] = [];
	const enums: PgEnum<any>[] = [];
	const schemas: PgSchema[] = [];
	const sequences: PgSequence[] = [];
	const views: PgView[] = [];
	const roles: PgRole[] = [];
	const policies: PgPolicy[] = [];
	const matViews: PgMaterializedView[] = [];
	const relations: Relations[] = [];

	const { unregister } = await safeRegister();
	for (let i = 0; i < imports.length; i++) {
		const it = imports[i];

		const i0: Record<string, unknown> = require(`${it}`);
		const prepared = prepareFromExports(i0);

		tables.push(...prepared.tables);
		enums.push(...prepared.enums);
		schemas.push(...prepared.schemas);
		sequences.push(...prepared.sequences);
		views.push(...prepared.views);
		matViews.push(...prepared.matViews);
		roles.push(...prepared.roles);
		policies.push(...prepared.policies);
		relations.push(...prepared.relations);
	}
	unregister();

	return {
		tables: Array.from(new Set(tables)),
		enums,
		schemas,
		sequences,
		views,
		matViews,
		roles,
		policies,
		relations,
	};
};