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

PgSelectConfig Type — drizzle-orm Architecture

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

Type typescript

Entity Profile

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/src/pg-core/query-builders/select.types.ts lines 52–80

export interface PgSelectConfig {
	withList?: Subquery[];
	// Either fields or fieldsFlat must be defined
	fields: Record<string, unknown>;
	fieldsFlat?: SelectedFieldsOrdered;
	where?: SQL;
	having?: SQL;
	table: PgTable | Subquery | PgViewBase | SQL;
	limit?: number | Placeholder;
	offset?: number | Placeholder;
	joins?: PgSelectJoinConfig[];
	orderBy?: (PgColumn | SQL | SQL.Aliased)[];
	groupBy?: (PgColumn | SQL | SQL.Aliased)[];
	lockingClause?: {
		strength: LockStrength;
		config: LockConfig;
	};
	distinct?: boolean | {
		on: (PgColumn | SQLWrapper)[];
	};
	setOperators: {
		rightSelect: TypedQueryBuilder<any, any>;
		type: SetOperator;
		isAll: boolean;
		orderBy?: (PgColumn | SQL | SQL.Aliased)[];
		limit?: number | Placeholder;
		offset?: number | Placeholder;
	}[];
}

Defined In

Source

Frequently Asked Questions

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

Analyze Your Own Codebase

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

Try Supermodel Free