index.ts — drizzle-orm Source File

Architecture documentation for index.ts, a typescript file in the drizzle-orm codebase. 4 imports, 0 dependents.

File typescript DrizzleORM SchemaDefinitions 4 imports 2 functions

Entity Profile

DrizzleORM→ SchemaDefinitions→ index.ts — drizzle-orm Source File

Dependency Diagram

graph LR
  b649761f_3353_938a_f019_5ceeb2d996fb["index.ts"]
  e3ae5b13_82ea_5605_6ffb_0726b1b8fbca["driver-core.ts"]
  b649761f_3353_938a_f019_5ceeb2d996fb --> e3ae5b13_82ea_5605_6ffb_0726b1b8fbca
  fa543535_6d4f_661a_3ebc_bbf2d910a800["construct"]
  b649761f_3353_938a_f019_5ceeb2d996fb --> fa543535_6d4f_661a_3ebc_bbf2d910a800
  90d29e1a_a2df_6da8_225c_88e230237dbc["ws"]
  b649761f_3353_938a_f019_5ceeb2d996fb --> 90d29e1a_a2df_6da8_225c_88e230237dbc
  75901f99_b0fe_057b_6268_cf00202bd6f8["utils.ts"]
  b649761f_3353_938a_f019_5ceeb2d996fb --> 75901f99_b0fe_057b_6268_cf00202bd6f8
  style b649761f_3353_938a_f019_5ceeb2d996fb fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { type Client, type Config, createClient } from '@libsql/client/ws';
import { type DrizzleConfig, isConfig } from '~/utils.ts';
import { construct, type LibSQLDatabase } from '../driver-core.ts';

export function drizzle<
	TSchema extends Record<string, unknown> = Record<string, never>,
	TClient extends Client = Client,
>(
	...params: [
		TClient | string,
	] | [
		TClient | string,
		DrizzleConfig<TSchema>,
	] | [
		(
			& DrizzleConfig<TSchema>
			& ({
				connection: string | Config;
			} | {
				client: TClient;
			})
		),
	]
): LibSQLDatabase<TSchema> & {
	$client: TClient;
} {
	if (typeof params[0] === 'string') {
		const instance = createClient({
			url: params[0],
		});

		return construct(instance, params[1]) as any;
	}

	if (isConfig(params[0])) {
		const { connection, client, ...drizzleConfig } = params[0] as
			& { connection?: Config; client?: TClient }
			& DrizzleConfig<TSchema>;

		if (client) return construct(client, drizzleConfig) as any;

		const instance = typeof connection === 'string' ? createClient({ url: connection }) : createClient(connection!);

		return construct(instance, drizzleConfig) as any;
	}

	return construct(params[0] as TClient, params[1] as DrizzleConfig<TSchema> | undefined) as any;
}

export namespace drizzle {
	export function mock<TSchema extends Record<string, unknown> = Record<string, never>>(
		config?: DrizzleConfig<TSchema>,
	): LibSQLDatabase<TSchema> & {
		$client: '$client is not available on drizzle.mock()';
	} {
		return construct({} as any, config) as any;
	}
}