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

PgSelectJoinFn Type — drizzle-orm Architecture

Architecture documentation for the PgSelectJoinFn type/interface in select.types.ts from the drizzle-orm codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  812796b9_7dc1_180d_56dd_9dcbc25aee47["PgSelectJoinFn"]
  65d45edf_0d8a_b7f0_1780_573c12d9a0e6["select.types.ts"]
  812796b9_7dc1_180d_56dd_9dcbc25aee47 -->|defined in| 65d45edf_0d8a_b7f0_1780_573c12d9a0e6
  style 812796b9_7dc1_180d_56dd_9dcbc25aee47 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/query-builders/select.types.ts lines 115–129

export type PgSelectJoinFn<
	T extends AnyPgSelectQueryBuilder,
	TDynamic extends boolean,
	TJoinType extends JoinType,
	TIsLateral extends boolean,
> = <
	TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : PgTable | Subquery | PgViewBase | SQL),
	TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
>(
	table: TableLikeHasEmptySelection<TJoinedTable> extends true ? DrizzleTypeError<
			"Cannot reference a data-modifying statement subquery if it doesn't contain a `returning` clause"
		>
		: TJoinedTable,
	on: ((aliases: T['_']['selection']) => SQL | undefined) | SQL | undefined,
) => PgSelectJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>;

Defined In

Source

Frequently Asked Questions

What is the PgSelectJoinFn type?
PgSelectJoinFn is a type/interface in the drizzle-orm codebase, defined in drizzle-orm/src/pg-core/query-builders/select.types.ts.
Where is PgSelectJoinFn defined?
PgSelectJoinFn is defined in drizzle-orm/src/pg-core/query-builders/select.types.ts at line 115.

Analyze Your Own Codebase

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

Try Supermodel Free