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
  226e224f_f0a8_06f1_40cc_c34d7ea89dfa["construct()"]
  e62c4bff_79fa_8bf4_2716_485f05b01506["driver.ts"]
  226e224f_f0a8_06f1_40cc_c34d7ea89dfa -->|defined in| e62c4bff_79fa_8bf4_2716_485f05b01506
  f5d5627d_de89_3e76_541b_1c3db01089a5["drizzle()"]
  f5d5627d_de89_3e76_541b_1c3db01089a5 -->|calls| 226e224f_f0a8_06f1_40cc_c34d7ea89dfa
  c5849a22_0539_9f75_525b_43480a230db9["mock()"]
  c5849a22_0539_9f75_525b_43480a230db9 -->|calls| 226e224f_f0a8_06f1_40cc_c34d7ea89dfa
  dcc73275_3c1a_7ddb_7b9b_1f63ec3d36e5["createSession()"]
  226e224f_f0a8_06f1_40cc_c34d7ea89dfa -->|calls| dcc73275_3c1a_7ddb_7b9b_1f63ec3d36e5
  style 226e224f_f0a8_06f1_40cc_c34d7ea89dfa fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/node-postgres/driver.ts lines 49–89

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