construct() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects called by 2

Entity Profile

DrizzleORM→ SQLDialects→ construct() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  368e6c67_d9ba_9a79_058d_3e77198ecbf9["construct()"]
  053b47f2_f302_5369_9ab2_7667cbadf49f["driver.ts"]
  368e6c67_d9ba_9a79_058d_3e77198ecbf9 -->|defined in| 053b47f2_f302_5369_9ab2_7667cbadf49f
  780a45cc_231e_c73e_4099_81954c63cedc["drizzle()"]
  780a45cc_231e_c73e_4099_81954c63cedc -->|calls| 368e6c67_d9ba_9a79_058d_3e77198ecbf9
  32f43b83_6945_8409_625a_a92e1b5c9313["mock()"]
  32f43b83_6945_8409_625a_a92e1b5c9313 -->|calls| 368e6c67_d9ba_9a79_058d_3e77198ecbf9
  style 368e6c67_d9ba_9a79_058d_3e77198ecbf9 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/bun-sql/driver.ts lines 25–61

function construct<TSchema extends Record<string, unknown> = Record<string, never>>(
	client: SQL,
	config: DrizzleConfig<TSchema> = {},
): BunSQLDatabase<TSchema> & {
	$client: SQL;
} {
	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 session = new BunSQLSession(client, dialect, schema, { logger, cache: config.cache });
	const db = new BunSQLDatabase(dialect, session, schema as any) as BunSQLDatabase<TSchema>;
	(<any> db).$client = client;
	(<any> db).$cache = config.cache;
	if ((<any> db).$cache) {
		(<any> db).$cache['invalidate'] = config.cache?.onMutate;
	}

	return db as any;
}