construct() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers called by 2

Entity Profile

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

Dependency Diagram

graph TD
  b434e2e8_087d_9e43_af9c_ade269dae37f["construct()"]
  3ae74e9d_9ef5_2553_ca81_fae936d635ca["driver.ts"]
  b434e2e8_087d_9e43_af9c_ade269dae37f -->|defined in| 3ae74e9d_9ef5_2553_ca81_fae936d635ca
  a18e6277_2e27_13c8_d134_b8e84e43fa8c["drizzle()"]
  a18e6277_2e27_13c8_d134_b8e84e43fa8c -->|calls| b434e2e8_087d_9e43_af9c_ade269dae37f
  9509f40e_bed6_5462_f373_2a7d1ed01e60["mock()"]
  9509f40e_bed6_5462_f373_2a7d1ed01e60 -->|calls| b434e2e8_087d_9e43_af9c_ade269dae37f
  style b434e2e8_087d_9e43_af9c_ade269dae37f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/tidb-serverless/driver.ts lines 28–64

function construct<TSchema extends Record<string, unknown> = Record<string, never>>(
	client: Connection,
	config: DrizzleConfig<TSchema> = {},
): TiDBServerlessDatabase<TSchema> & {
	$client: Connection;
} {
	const dialect = new MySqlDialect({ 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 TiDBServerlessSession(client, dialect, undefined, schema, { logger, cache: config.cache });
	const db = new TiDBServerlessDatabase(dialect, session, schema as any, 'default') as TiDBServerlessDatabase<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;
}