drizzleForMySQL() — drizzle-orm Function Reference

Architecture documentation for the drizzleForMySQL() function in studio.ts from the drizzle-orm codebase.

Function typescript DrizzleKit SnapshotSerializer calls 1 called by 2

Entity Profile

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

Dependency Diagram

graph TD
  faf342d9_5e62_6e76_b201_9e470cfbdaa4["drizzleForMySQL()"]
  82de12f8_a8ca_9d38_8da8_9ac945d81e01["studio.ts"]
  faf342d9_5e62_6e76_b201_9e470cfbdaa4 -->|defined in| 82de12f8_a8ca_9d38_8da8_9ac945d81e01
  b3c5d85a_69c9_7748_a2a0_342d6999a31e["startStudioMySQLServer()"]
  b3c5d85a_69c9_7748_a2a0_342d6999a31e -->|calls| faf342d9_5e62_6e76_b201_9e470cfbdaa4
  72630e5c_93c3_75d3_29f3_af0928ebe15c["studio.handler()"]
  72630e5c_93c3_75d3_29f3_af0928ebe15c -->|calls| faf342d9_5e62_6e76_b201_9e470cfbdaa4
  d7ecc303_7005_43ee_f3ad_fa9fa658b409["getCustomDefaults()"]
  faf342d9_5e62_6e76_b201_9e470cfbdaa4 -->|calls| d7ecc303_7005_43ee_f3ad_fa9fa658b409
  style faf342d9_5e62_6e76_b201_9e470cfbdaa4 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/serializer/studio.ts lines 327–363

export const drizzleForMySQL = async (
	credentials: MysqlCredentials,
	mysqlSchema: Record<string, Record<string, AnyMySqlTable>>,
	relations: Record<string, Relations>,
	schemaFiles?: SchemaFile[],
	casing?: CasingType,
): Promise<Setup> => {
	const { connectToMySQL } = await import('../cli/connections');
	const { proxy, transactionProxy, database, packageName } = await connectToMySQL(credentials);

	const customDefaults = getCustomDefaults(mysqlSchema, casing);

	let dbUrl: string;

	if ('url' in credentials) {
		dbUrl = credentials.url;
	} else {
		dbUrl =
			`mysql://${credentials.user}:${credentials.password}@${credentials.host}:${credentials.port}/${credentials.database}`;
	}

	const dbHash = createHash('sha256').update(dbUrl).digest('hex');

	return {
		dbHash,
		dialect: 'mysql',
		packageName,
		databaseName: database,
		proxy,
		transactionProxy,
		customDefaults,
		schema: mysqlSchema,
		relations,
		schemaFiles,
		casing,
	};
};