PgUpdateBase Type — drizzle-orm Architecture

Architecture documentation for the PgUpdateBase type/interface in update.ts from the drizzle-orm codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  44882cbf_eb6d_8b01_11f9_13bb348a41c6["PgUpdateBase"]
  ebf76db1_7804_287b_622a_ab94e9efc196["update.ts"]
  44882cbf_eb6d_8b01_11f9_13bb348a41c6 -->|defined in| ebf76db1_7804_287b_622a_ab94e9efc196
  style 44882cbf_eb6d_8b01_11f9_13bb348a41c6 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/query-builders/update.ts lines 307–339

export interface PgUpdateBase<
	TTable extends PgTable,
	TQueryResult extends PgQueryResultHKT,
	TFrom extends PgTable | Subquery | PgViewBase | SQL | undefined = undefined,
	TSelectedFields extends ColumnsSelection | undefined = undefined,
	TReturning extends Record<string, unknown> | undefined = undefined,
	TNullabilityMap extends Record<string, JoinNullability> = Record<TTable['_']['name'], 'not-null'>,
	TJoins extends Join[] = [],
	TDynamic extends boolean = false,
	TExcludedMethods extends string = never,
> extends
	TypedQueryBuilder<
		TSelectedFields,
		TReturning extends undefined ? PgQueryResultKind<TQueryResult, never> : TReturning[]
	>,
	QueryPromise<TReturning extends undefined ? PgQueryResultKind<TQueryResult, never> : TReturning[]>,
	RunnableQuery<TReturning extends undefined ? PgQueryResultKind<TQueryResult, never> : TReturning[], 'pg'>,
	SQLWrapper
{
	readonly _: {
		readonly dialect: 'pg';
		readonly table: TTable;
		readonly joins: TJoins;
		readonly nullabilityMap: TNullabilityMap;
		readonly queryResult: TQueryResult;
		readonly from: TFrom;
		readonly selectedFields: TSelectedFields;
		readonly returning: TReturning;
		readonly dynamic: TDynamic;
		readonly excludedMethods: TExcludedMethods;
		readonly result: TReturning extends undefined ? PgQueryResultKind<TQueryResult, never> : TReturning[];
	};
}

Defined In

drizzle-orm/src/pg-core/query-builders/update.ts

Source

View on GitHub

Frequently Asked Questions

What is the PgUpdateBase type?

PgUpdateBase is a type/interface in the drizzle-orm codebase, defined in drizzle-orm/src/pg-core/query-builders/update.ts.

Where is PgUpdateBase defined?

PgUpdateBase is defined in drizzle-orm/src/pg-core/query-builders/update.ts at line 307.

Analyze Your Own Codebase

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

Try Supermodel Free