drizzle-orm Architecture Docs
Home / Class/ PgRaw Class — drizzle-orm Architecture

PgRaw Class — drizzle-orm Architecture

Architecture documentation for the PgRaw class in raw.ts from the drizzle-orm codebase.

Class typescript DrizzleORM

Entity Profile

Dependency Diagram

graph TD
  3b6afbb8_a1c2_74f3_5dc8_51664d26724a["PgRaw"]
  880c509a_a5b7_154e_3e50_e0d899de78b5["raw.ts"]
  3b6afbb8_a1c2_74f3_5dc8_51664d26724a -->|defined in| 880c509a_a5b7_154e_3e50_e0d899de78b5
  c1f019fd_0f65_4a96_499f_8fc8276eb413["constructor()"]
  3b6afbb8_a1c2_74f3_5dc8_51664d26724a -->|method| c1f019fd_0f65_4a96_499f_8fc8276eb413
  3a239526_4d6f_6197_9901_ab0e6dd8caff["getSQL()"]
  3b6afbb8_a1c2_74f3_5dc8_51664d26724a -->|method| 3a239526_4d6f_6197_9901_ab0e6dd8caff
  57043acb_1948_151d_2432_ab598b2ede0b["getQuery()"]
  3b6afbb8_a1c2_74f3_5dc8_51664d26724a -->|method| 57043acb_1948_151d_2432_ab598b2ede0b
  81878863_fd6d_6366_1fb8_8798e3a5c9cb["mapResult()"]
  3b6afbb8_a1c2_74f3_5dc8_51664d26724a -->|method| 81878863_fd6d_6366_1fb8_8798e3a5c9cb
  0d4ad2e0_327c_2ec3_22e6_4ca2a7d27ef7["_prepare()"]
  3b6afbb8_a1c2_74f3_5dc8_51664d26724a -->|method| 0d4ad2e0_327c_2ec3_22e6_4ca2a7d27ef7
  2a61aa61_c6c3_f30a_645c_fde94d4bf489["isResponseInArrayMode()"]
  3b6afbb8_a1c2_74f3_5dc8_51664d26724a -->|method| 2a61aa61_c6c3_f30a_645c_fde94d4bf489

Relationship Graph

Source Code

drizzle-orm/src/pg-core/query-builders/raw.ts lines 9–49

export class PgRaw<TResult> extends QueryPromise<TResult>
	implements RunnableQuery<TResult, 'pg'>, SQLWrapper, PreparedQuery
{
	static override readonly [entityKind]: string = 'PgRaw';

	declare readonly _: {
		readonly dialect: 'pg';
		readonly result: TResult;
	};

	constructor(
		public execute: () => Promise<TResult>,
		private sql: SQL,
		private query: Query,
		private mapBatchResult: (result: unknown) => unknown,
	) {
		super();
	}

	/** @internal */
	getSQL() {
		return this.sql;
	}

	getQuery() {
		return this.query;
	}

	mapResult(result: unknown, isFromBatch?: boolean) {
		return isFromBatch ? this.mapBatchResult(result) : result;
	}

	_prepare(): PreparedQuery {
		return this;
	}

	/** @internal */
	isResponseInArrayMode() {
		return false;
	}
}

Domain

Defined In

Source

Frequently Asked Questions

What is the PgRaw class?
PgRaw is a class in the drizzle-orm codebase, defined in drizzle-orm/src/pg-core/query-builders/raw.ts.
Where is PgRaw defined?
PgRaw is defined in drizzle-orm/src/pg-core/query-builders/raw.ts at line 9.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free