construct() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers calls 1 called by 2

Entity Profile

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

Dependency Diagram

graph TD
  1979ab42_37b3_68cb_c787_e9fd797c7e1f["construct()"]
  4900d433_b74f_ced2_6f6d_410f252d1ff8["driver.ts"]
  1979ab42_37b3_68cb_c787_e9fd797c7e1f -->|defined in| 4900d433_b74f_ced2_6f6d_410f252d1ff8
  e09c9fbe_d3d3_f26e_ac98_045d8721ece5["drizzle()"]
  e09c9fbe_d3d3_f26e_ac98_045d8721ece5 -->|calls| 1979ab42_37b3_68cb_c787_e9fd797c7e1f
  0972a2cd_5905_4f83_a2c2_edcf29131cb3["mock()"]
  0972a2cd_5905_4f83_a2c2_edcf29131cb3 -->|calls| 1979ab42_37b3_68cb_c787_e9fd797c7e1f
  0ac40a46_5a26_7aca_7a55_5278c42e693c["createSession()"]
  1979ab42_37b3_68cb_c787_e9fd797c7e1f -->|calls| 0ac40a46_5a26_7aca_7a55_5278c42e693c
  style 1979ab42_37b3_68cb_c787_e9fd797c7e1f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/vercel-postgres/driver.ts lines 48–85

function construct<TSchema extends Record<string, unknown> = Record<string, never>>(
	client: VercelPgClient,
	config: DrizzleConfig<TSchema> = {},
): VercelPgDatabase<TSchema> & {
	$client: VercelPgClient;
} {
	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 VercelPgDriver(client, dialect, { logger, cache: config.cache });
	const session = driver.createSession(schema);
	const db = new VercelPgDatabase(dialect, session, schema as any) as VercelPgDatabase<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;
}