startStudioSQLiteServer() — drizzle-orm Function Reference

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

Function typescript DrizzleKit SchemaDiffer calls 2

Entity Profile

DrizzleKit→ SchemaDiffer→ startStudioSQLiteServer() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  a3bd30a5_eb46_2554_e473_0327928a9aaf["startStudioSQLiteServer()"]
  e668bfef_9125_1ef0_2f94_a0f9605584bd["api.ts"]
  a3bd30a5_eb46_2554_e473_0327928a9aaf -->|defined in| e668bfef_9125_1ef0_2f94_a0f9605584bd
  1a968317_891c_454b_77a6_20e6f61521b5["drizzleForSQLite()"]
  a3bd30a5_eb46_2554_e473_0327928a9aaf -->|calls| 1a968317_891c_454b_77a6_20e6f61521b5
  4989a948_cacf_e4b2_7283_c9335d2b7983["startServerFromSetup()"]
  a3bd30a5_eb46_2554_e473_0327928a9aaf -->|calls| 4989a948_cacf_e4b2_7283_c9335d2b7983
  style a3bd30a5_eb46_2554_e473_0327928a9aaf fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/api.ts lines 329–360

export const startStudioSQLiteServer = async (
	imports: Record<string, unknown>,
	credentials: SqliteCredentials | {
		driver: 'd1';
		binding: D1Database;
	},
	options?: {
		host?: string;
		port?: number;
		casing?: CasingType;
	},
) => {
	const { drizzleForSQLite } = await import('./serializer/studio');

	const sqliteSchema: Record<string, Record<string, AnySQLiteTable>> = {};
	const relations: Record<string, Relations> = {};

	Object.entries(imports).forEach(([k, t]) => {
		if (is(t, SQLiteTable)) {
			const schema = 'public'; // sqlite does not have schemas
			sqliteSchema[schema] = sqliteSchema[schema] || {};
			sqliteSchema[schema][k] = t;
		}

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

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