prepareSQLiteDbPushSnapshot() — drizzle-orm Function Reference

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

Function typescript DrizzleKit SnapshotSerializer calls 1 called by 2

Entity Profile

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

Dependency Diagram

graph TD
  f28864cc_bfe5_d841_4b4d_7469a00327d0["prepareSQLiteDbPushSnapshot()"]
  4078709f_3fc0_5514_7728_8f28a7b0e807["migrationPreparator.ts"]
  f28864cc_bfe5_d841_4b4d_7469a00327d0 -->|defined in| 4078709f_3fc0_5514_7728_8f28a7b0e807
  2ca89631_0f00_005d_5d76_39522f9fdfff["prepareSQLitePush()"]
  2ca89631_0f00_005d_5d76_39522f9fdfff -->|calls| f28864cc_bfe5_d841_4b4d_7469a00327d0
  bc8e732d_406a_2bba_c78e_33845d67094a["prepareLibSQLPush()"]
  bc8e732d_406a_2bba_c78e_33845d67094a -->|calls| f28864cc_bfe5_d841_4b4d_7469a00327d0
  635252db_7a68_131f_350d_60c2806f943d["serializeSQLite()"]
  f28864cc_bfe5_d841_4b4d_7469a00327d0 -->|calls| 635252db_7a68_131f_350d_60c2806f943d
  style f28864cc_bfe5_d841_4b4d_7469a00327d0 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/migrationPreparator.ts lines 42–62

export const prepareSQLiteDbPushSnapshot = async (
	prev: SQLiteSchema,
	schemaPath: string | string[],
	casing: CasingType | undefined,
): Promise<{ prev: SQLiteSchema; cur: SQLiteSchema }> => {
	const serialized = await serializeSQLite(schemaPath, casing);

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

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

	return { prev, cur: result };
};