startStudioMySQLServer() — drizzle-orm Function Reference

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

Function typescript DrizzleKit CLIWorkflow calls 2

Entity Profile

DrizzleKit→ CLIWorkflow→ startStudioMySQLServer() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  b3c5d85a_69c9_7748_a2a0_342d6999a31e["startStudioMySQLServer()"]
  e668bfef_9125_1ef0_2f94_a0f9605584bd["api.ts"]
  b3c5d85a_69c9_7748_a2a0_342d6999a31e -->|defined in| e668bfef_9125_1ef0_2f94_a0f9605584bd
  faf342d9_5e62_6e76_b201_9e470cfbdaa4["drizzleForMySQL()"]
  b3c5d85a_69c9_7748_a2a0_342d6999a31e -->|calls| faf342d9_5e62_6e76_b201_9e470cfbdaa4
  4989a948_cacf_e4b2_7283_c9335d2b7983["startServerFromSetup()"]
  b3c5d85a_69c9_7748_a2a0_342d6999a31e -->|calls| 4989a948_cacf_e4b2_7283_c9335d2b7983
  style b3c5d85a_69c9_7748_a2a0_342d6999a31e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/api.ts lines 467–495

export const startStudioMySQLServer = async (
	imports: Record<string, unknown>,
	credentials: MysqlCredentials,
	options?: {
		host?: string;
		port?: number;
		casing?: CasingType;
	},
) => {
	const { drizzleForMySQL } = await import('./serializer/studio');

	const mysqlSchema: Record<string, Record<string, AnyMySqlTable>> = {};
	const relations: Record<string, Relations> = {};

	Object.entries(imports).forEach(([k, t]) => {
		if (is(t, MySqlTable)) {
			const schema = mysqlTableConfig(t).schema || 'public';
			mysqlSchema[schema] = mysqlSchema[schema] || {};
			mysqlSchema[schema][k] = t;
		}

		if (is(t, Relations)) {
			relations[k] = t;
		}
	});

	const setup = await drizzleForMySQL(credentials, mysqlSchema, relations, [], options?.casing);
	await startServerFromSetup(setup, options);
};