construct() — drizzle-orm Function Reference

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

Function typescript DrizzleORM RelationalQuery calls 1 called by 2

Entity Profile

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

Dependency Diagram

graph TD
  ff209639_b46d_95bc_ccdb_6ec0819cea71["construct()"]
  612dbe90_48c8_5f9e_1685_3ec048012649["driver.ts"]
  ff209639_b46d_95bc_ccdb_6ec0819cea71 -->|defined in| 612dbe90_48c8_5f9e_1685_3ec048012649
  375b0bf0_2dc3_e4f1_61d7_3c127f88f970["drizzle()"]
  375b0bf0_2dc3_e4f1_61d7_3c127f88f970 -->|calls| ff209639_b46d_95bc_ccdb_6ec0819cea71
  d054debc_bee6_bef5_eef6_30cc2e19e981["mock()"]
  d054debc_bee6_bef5_eef6_30cc2e19e981 -->|calls| ff209639_b46d_95bc_ccdb_6ec0819cea71
  cc9b2a5b_2214_09d1_ead9_b5335b86eeee["createSession()"]
  ff209639_b46d_95bc_ccdb_6ec0819cea71 -->|calls| cc9b2a5b_2214_09d1_ead9_b5335b86eeee
  style ff209639_b46d_95bc_ccdb_6ec0819cea71 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/gel/driver.ts lines 49–86

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