generateDrizzleJson() — drizzle-orm Function Reference

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

Function typescript DrizzleKit Snapshots calls 1 called by 1

Entity Profile

DrizzleKit→ Snapshots→ generateDrizzleJson() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  f72b2c33_0cab_95fe_0055_40c03fa412ef["generateDrizzleJson()"]
  99bb8ad0_8387_1b07_7f3d_2450cd045f27["api.ts"]
  f72b2c33_0cab_95fe_0055_40c03fa412ef -->|defined in| 99bb8ad0_8387_1b07_7f3d_2450cd045f27
  52c3c13e_4679_a62f_6db0_92c8626d2645["pushSchema()"]
  52c3c13e_4679_a62f_6db0_92c8626d2645 -->|calls| f72b2c33_0cab_95fe_0055_40c03fa412ef
  6eee20c7_2551_d78b_a6cb_61bcb3174195["prepareFromExports()"]
  f72b2c33_0cab_95fe_0055_40c03fa412ef -->|calls| 6eee20c7_2551_d78b_a6cb_61bcb3174195
  style f72b2c33_0cab_95fe_0055_40c03fa412ef fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/api.ts lines 64–92

export const generateDrizzleJson = (
	imports: Record<string, unknown>,
	prevId?: string,
	schemaFilters?: string[],
	casing?: CasingType,
): PgSchemaKit => {
	const prepared = prepareFromExports(imports);

	const id = randomUUID();

	const snapshot = generatePgSnapshot(
		prepared.tables,
		prepared.enums,
		prepared.schemas,
		prepared.sequences,
		prepared.roles,
		prepared.policies,
		prepared.views,
		prepared.matViews,
		casing,
		schemaFilters,
	);

	return {
		...snapshot,
		id,
		prevId: prevId ?? originUUID,
	};
};