_prepare() — drizzle-orm Function Reference

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

Function typescript DrizzleORM QueryBuilders calls 1 called by 2

Entity Profile

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

Dependency Diagram

graph TD
  7200bba7_cfc4_9235_f1c5_3ba5546808f9["_prepare()"]
  1020167a_b256_b43e_d8d1_71bd293c5e55["PgRelationalQuery"]
  7200bba7_cfc4_9235_f1c5_3ba5546808f9 -->|defined in| 1020167a_b256_b43e_d8d1_71bd293c5e55
  9b49171c_da6e_db57_2dda_9dafb6091f73["prepare()"]
  9b49171c_da6e_db57_2dda_9dafb6091f73 -->|calls| 7200bba7_cfc4_9235_f1c5_3ba5546808f9
  5dd36ef9_8a2d_412a_8ed0_0808a622fa34["execute()"]
  5dd36ef9_8a2d_412a_8ed0_0808a622fa34 -->|calls| 7200bba7_cfc4_9235_f1c5_3ba5546808f9
  2b0b24a6_e5d7_1385_86d1_be24fe87feb9["_toSQL()"]
  7200bba7_cfc4_9235_f1c5_3ba5546808f9 -->|calls| 2b0b24a6_e5d7_1385_86d1_be24fe87feb9
  style 7200bba7_cfc4_9235_f1c5_3ba5546808f9 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/query-builders/query.ts lines 90–110

	_prepare(name?: string): PgPreparedQuery<PreparedQueryConfig & { execute: TResult }> {
		return tracer.startActiveSpan('drizzle.prepareQuery', () => {
			const { query, builtQuery } = this._toSQL();

			return this.session.prepareQuery<PreparedQueryConfig & { execute: TResult }>(
				builtQuery,
				undefined,
				name,
				true,
				(rawRows, mapColumnValue) => {
					const rows = rawRows.map((row) =>
						mapRelationalRow(this.schema, this.tableConfig, row, query.selection, mapColumnValue)
					);
					if (this.mode === 'first') {
						return rows[0] as TResult;
					}
					return rows as TResult;
				},
			);
		});
	}