drizzle-orm Architecture Docs
Home / Type/ PgUpdateJoinFn Type — drizzle-orm Architecture

PgUpdateJoinFn Type — drizzle-orm Architecture

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

Type typescript

Entity Profile

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/src/pg-core/query-builders/update.ts lines 148–170

export type PgUpdateJoinFn<
	T extends AnyPgUpdate,
	TDynamic extends boolean,
	TJoinType extends JoinType,
> = <
	TJoinedTable extends PgTable | Subquery | PgViewBase | SQL,
>(
	table: TableLikeHasEmptySelection<TJoinedTable> extends true ? DrizzleTypeError<
			"Cannot reference a data-modifying statement subquery if it doesn't contain a `returning` clause"
		>
		: TJoinedTable,
	on:
		| (
			(
				updateTable: T['_']['table']['_']['columns'],
				from: T['_']['from'] extends PgTable ? T['_']['from']['_']['columns']
					: T['_']['from'] extends Subquery | PgViewBase ? T['_']['from']['_']['selectedFields']
					: never,
			) => SQL | undefined
		)
		| SQL
		| undefined,
) => PgUpdateJoin<T, TDynamic, TJoinType, TJoinedTable>;

Defined In

Source

Frequently Asked Questions

What is the PgUpdateJoinFn type?
PgUpdateJoinFn is a type/interface in the drizzle-orm codebase, defined in drizzle-orm/src/pg-core/query-builders/update.ts.
Where is PgUpdateJoinFn defined?
PgUpdateJoinFn is defined in drizzle-orm/src/pg-core/query-builders/update.ts at line 148.

Analyze Your Own Codebase

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

Try Supermodel Free