serializeMySql() — drizzle-orm Function Reference

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

Function typescript DrizzleKit SnapshotSerializer calls 1 called by 2

Entity Profile

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

Dependency Diagram

graph TD
  28658aa5_a9ca_196c_cf25_5227ba3e8e36["serializeMySql()"]
  c3eb904f_5390_9c0d_4b12_54d182c5f8c9["index.ts"]
  28658aa5_a9ca_196c_cf25_5227ba3e8e36 -->|defined in| c3eb904f_5390_9c0d_4b12_54d182c5f8c9
  205531e5_bccd_7be7_bb95_69ddeac3a4a2["prepareMySqlDbPushSnapshot()"]
  205531e5_bccd_7be7_bb95_69ddeac3a4a2 -->|calls| 28658aa5_a9ca_196c_cf25_5227ba3e8e36
  3c058e8d_cc3e_dc1b_7c24_3f79a601ef9d["prepareMySqlMigrationSnapshot()"]
  3c058e8d_cc3e_dc1b_7c24_3f79a601ef9d -->|calls| 28658aa5_a9ca_196c_cf25_5227ba3e8e36
  d2a6d85b_7d3b_7d17_794c_d2cd77de724c["prepareFilenames()"]
  28658aa5_a9ca_196c_cf25_5227ba3e8e36 -->|calls| d2a6d85b_7d3b_7d17_794c_d2cd77de724c
  style 28658aa5_a9ca_196c_cf25_5227ba3e8e36 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/serializer/index.ts lines 12–26

export const serializeMySql = async (
	path: string | string[],
	casing: CasingType | undefined,
): Promise<MySqlSchemaInternal> => {
	const filenames = prepareFilenames(path);

	console.log(chalk.gray(`Reading schema files:\n${filenames.join('\n')}\n`));

	const { prepareFromMySqlImports } = await import('./mysqlImports');
	const { generateMySqlSnapshot } = await import('./mysqlSerializer');

	const { tables, views } = await prepareFromMySqlImports(filenames);

	return generateMySqlSnapshot(tables, views, casing);
};