_prepare() — drizzle-orm Function Reference

Architecture documentation for the _prepare() function in select.ts from the drizzle-orm codebase.

Function typescript DrizzleORM QueryBuilders calls 1 called by 1

Entity Profile

DrizzleORM→ QueryBuilders→ _prepare() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  9dd6bce6_9088_19b3_bba2_b200527219e4["_prepare()"]
  0744f36d_5fd7_77df_bff6_b69b1cd81850["PgSelectBase"]
  9dd6bce6_9088_19b3_bba2_b200527219e4 -->|defined in| 0744f36d_5fd7_77df_bff6_b69b1cd81850
  eac614a9_354d_4cf6_d256_12c857672cf1["prepare()"]
  eac614a9_354d_4cf6_d256_12c857672cf1 -->|calls| 9dd6bce6_9088_19b3_bba2_b200527219e4
  f5ae4a94_1ac2_f45d_458e_2e4d05137160["setToken()"]
  9dd6bce6_9088_19b3_bba2_b200527219e4 -->|calls| f5ae4a94_1ac2_f45d_458e_2e4d05137160
  style 9dd6bce6_9088_19b3_bba2_b200527219e4 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/query-builders/select.ts lines 1078–1098

	_prepare(name?: string): PgSelectPrepare<this> {
		const { session, config, dialect, joinsNotNullableMap, authToken, cacheConfig, usedTables } = this;
		if (!session) {
			throw new Error('Cannot execute a query on a query builder. Please use a database instance instead.');
		}

		const { fields } = config;

		return tracer.startActiveSpan('drizzle.prepareQuery', () => {
			const fieldsList = orderSelectedFields<PgColumn>(fields);
			const query = session.prepareQuery<
				PreparedQueryConfig & { execute: TResult }
			>(dialect.sqlToQuery(this.getSQL()), fieldsList, name, true, undefined, {
				type: 'select',
				tables: [...usedTables],
			}, cacheConfig);
			query.joinsNotNullableMap = joinsNotNullableMap;

			return query.setToken(authToken);
		});
	}