drizzle() — drizzle-orm Function Reference

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

Function typescript DrizzleORM QueryBuilders calls 1

Entity Profile

DrizzleORM→ QueryBuilders→ drizzle() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  cc35fc8b_de6d_fbec_70ef_d96b18bd07b4["drizzle()"]
  873bd06d_d5ad_ee33_9029_a6593dd73ae2["driver.ts"]
  cc35fc8b_de6d_fbec_70ef_d96b18bd07b4 -->|defined in| 873bd06d_d5ad_ee33_9029_a6593dd73ae2
  3b97aa02_cd8f_47ec_c581_509ac9cd7214["createSession()"]
  cc35fc8b_de6d_fbec_70ef_d96b18bd07b4 -->|calls| 3b97aa02_cd8f_47ec_c581_509ac9cd7214
  style cc35fc8b_de6d_fbec_70ef_d96b18bd07b4 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/xata-http/driver.ts lines 52–91

export function drizzle<TSchema extends Record<string, unknown> = Record<string, never>>(
	client: XataHttpClient,
	config: DrizzleConfig<TSchema> = {},
): XataHttpDatabase<TSchema> & {
	$client: XataHttpClient;
} {
	const dialect = new PgDialect({ casing: config.casing });
	let logger;
	if (config.logger === true) {
		logger = new DefaultLogger();
	} else if (config.logger !== false) {
		logger = config.logger;
	}

	let schema: RelationalSchemaConfig<TablesRelationalConfig> | undefined;
	if (config.schema) {
		const tablesConfig = extractTablesRelationalConfig(config.schema, createTableRelationsHelpers);
		schema = {
			fullSchema: config.schema,
			schema: tablesConfig.tables,
			tableNamesMap: tablesConfig.tableNamesMap,
		};
	}

	const driver = new XataHttpDriver(client, dialect, { logger, cache: config.cache });
	const session = driver.createSession(schema);

	const db = new XataHttpDatabase(
		dialect,
		session,
		schema as RelationalSchemaConfig<ExtractTablesWithRelations<TSchema>> | undefined,
	);
	(<any> db).$client = client;
	(<any> db).$cache = config.cache;
	if ((<any> db).$cache) {
		(<any> db).$cache['invalidate'] = config.cache?.onMutate;
	}

	return db as any;
}