drizzleForLibSQL() — drizzle-orm Function Reference

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

Function typescript DrizzleKit SnapshotSerializer calls 1 called by 1

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-kit/src/serializer/studio.ts lines 434–463

export const drizzleForLibSQL = async (
	credentials: LibSQLCredentials,
	sqliteSchema: Record<string, Record<string, AnySQLiteTable>>,
	relations: Record<string, Relations>,
	schemaFiles?: SchemaFile[],
	casing?: CasingType,
): Promise<Setup> => {
	const { connectToLibSQL } = await import('../cli/connections');

	const sqliteDB = await connectToLibSQL(credentials);
	const customDefaults = getCustomDefaults(sqliteSchema, casing);

	let dbUrl: string = `turso://${credentials.url}/${credentials.authToken}`;

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

	return {
		dbHash,
		dialect: 'sqlite',
		driver: undefined,
		packageName: sqliteDB.packageName,
		proxy: sqliteDB.proxy,
		transactionProxy: sqliteDB.transactionProxy,
		customDefaults,
		schema: sqliteSchema,
		relations,
		schemaFiles,
		casing,
	};
};