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

PgUpdateBuilder Class — drizzle-orm Architecture

Architecture documentation for the PgUpdateBuilder class in update.ts from the drizzle-orm codebase.

Class typescript DrizzleORM

Entity Profile

Dependency Diagram

graph TD
  a7964556_2b11_e8a5_5dfa_159ccd39ade2["PgUpdateBuilder"]
  ebf76db1_7804_287b_622a_ab94e9efc196["update.ts"]
  a7964556_2b11_e8a5_5dfa_159ccd39ade2 -->|defined in| ebf76db1_7804_287b_622a_ab94e9efc196
  55576350_9554_88f3_742f_3fddd8931816["constructor()"]
  a7964556_2b11_e8a5_5dfa_159ccd39ade2 -->|method| 55576350_9554_88f3_742f_3fddd8931816
  6675c3e8_5cf2_d594_8837_847aa0d1fef5["setToken()"]
  a7964556_2b11_e8a5_5dfa_159ccd39ade2 -->|method| 6675c3e8_5cf2_d594_8837_847aa0d1fef5
  724dbf07_463d_5e96_4dae_7ed4d5d063db["set()"]
  a7964556_2b11_e8a5_5dfa_159ccd39ade2 -->|method| 724dbf07_463d_5e96_4dae_7ed4d5d063db

Relationship Graph

Source Code

drizzle-orm/src/pg-core/query-builders/update.ts lines 73–104

export class PgUpdateBuilder<TTable extends PgTable, TQueryResult extends PgQueryResultHKT> {
	static readonly [entityKind]: string = 'PgUpdateBuilder';

	declare readonly _: {
		readonly table: TTable;
	};

	constructor(
		private table: TTable,
		private session: PgSession,
		private dialect: PgDialect,
		private withList?: Subquery[],
	) {}

	private authToken?: NeonAuthToken;
	setToken(token: NeonAuthToken) {
		this.authToken = token;
		return this;
	}

	set(
		values: PgUpdateSetSource<TTable>,
	): PgUpdateWithout<PgUpdateBase<TTable, TQueryResult>, false, 'leftJoin' | 'rightJoin' | 'innerJoin' | 'fullJoin'> {
		return new PgUpdateBase<TTable, TQueryResult>(
			this.table,
			mapUpdateSet(this.table, values),
			this.session,
			this.dialect,
			this.withList,
		).setToken(this.authToken);
	}
}

Domain

Defined In

Source

Frequently Asked Questions

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

Analyze Your Own Codebase

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

Try Supermodel Free