# SelectQueryBuilder (/docs/core/reference/api/interfaces/SelectQueryBuilder)



[@kysoql/core](/docs/core/reference/api) / SelectQueryBuilder

Type-safe fluent builder for Salesforce SELECT queries.

## Type Parameters [#type-parameters]

| Type Parameter                                                                              | Default type                                                               |
| ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `DB`                                                                                        | -                                                                          |
| `TB` *extends* keyof `DB`                                                                   | -                                                                          |
| `O`                                                                                         | -                                                                          |
| `Mode` *extends* [`SelectQueryMode`](/docs/core/reference/api/type-aliases/SelectQueryMode) | [`SelectQueryMode`](/docs/core/reference/api/type-aliases/SelectQueryMode) |

## Methods [#methods]

<a id="api-call" />

### $call() [#call]

```ts
$call<T>(func): T;
```

Passes this builder to `func` and returns the callback result.

#### Type Parameters [#type-parameters-1]

| Type Parameter |
| -------------- |
| `T`            |

#### Parameters [#parameters]

| Parameter | Type          |
| --------- | ------------- |
| `func`    | (`qb`) => `T` |

#### Returns [#returns]

`T`

***

<a id="api-asserttype" />

### $assertType() [#asserttype]

```ts
$assertType<T>(): O extends T ? SelectQueryBuilder<DB, TB, T, Mode> : KysoqlTypeError<"$assertType() call failed: The type passed in is not equal to the output type of the query.">;
```

Asserts at compile time that the current query output exactly matches `T`.

#### Type Parameters [#type-parameters-2]

| Type Parameter |
| -------------- |
| `T`            |

#### Returns [#returns-1]

`O` *extends* `T` ? `SelectQueryBuilder`\<`DB`, `TB`, `T`, `Mode`> : [`KysoqlTypeError`](/docs/core/reference/api/interfaces/KysoqlTypeError)\<`"$assertType() call failed: The type passed in is not equal to the output type of the query."`>

***

<a id="api-castto" />

### $castTo() [#castto]

```ts
$castTo<C>(): SelectQueryBuilder<DB, TB, C, Mode>;
```

Changes only the TypeScript output type; the generated SOQL is unchanged.

#### Type Parameters [#type-parameters-3]

| Type Parameter |
| -------------- |
| `C`            |

#### Returns [#returns-2]

`SelectQueryBuilder`\<`DB`, `TB`, `C`, `Mode`>

***

<a id="api-narrowtype" />

### $narrowType() [#narrowtype]

```ts
$narrowType<T>(): SelectQueryBuilder<DB, TB, NarrowPartial<O, T>, Mode>;
```

Narrows selected output properties at the type level without changing SOQL.

#### Type Parameters [#type-parameters-4]

| Type Parameter |
| -------------- |
| `T`            |

#### Returns [#returns-3]

`SelectQueryBuilder`\<`DB`, `TB`, [`NarrowPartial`](/docs/core/reference/api/type-aliases/NarrowPartial)\<`O`, `T`>, `Mode`>

***

<a id="api-if" />

### $if() [#if]

```ts
$if<O2>(condition, func): SelectQueryBuilder<DB, TB, ConditionalOutput<O, O2>, Mode>;
```

Conditionally applies a builder callback; when false, the runtime query is unchanged.

#### Type Parameters [#type-parameters-5]

| Type Parameter |
| -------------- |
| `O2`           |

#### Parameters [#parameters-1]

| Parameter   | Type                                                            |
| ----------- | --------------------------------------------------------------- |
| `condition` | `boolean`                                                       |
| `func`      | (`qb`) => `SelectQueryBuilder`\<`DB`, `TB`, `O` & `O2`, `Mode`> |

#### Returns [#returns-4]

`SelectQueryBuilder`\<`DB`, `TB`, `ConditionalOutput`\<`O`, `O2`>, `Mode`>

***

<a id="api-clearlimit" />

### clearLimit() [#clearlimit]

```ts
clearLimit(): SelectQueryBuilder<DB, TB, O, Mode>;
```

Returns a builder with the `LIMIT` clause removed.

#### Returns [#returns-5]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-clearoffset" />

### clearOffset() [#clearoffset]

```ts
clearOffset(): SelectQueryBuilder<DB, TB, O, Mode>;
```

Returns a builder with the `OFFSET` clause removed.

#### Returns [#returns-6]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-clearorderby" />

### clearOrderBy() [#clearorderby]

```ts
clearOrderBy(): SelectQueryBuilder<DB, TB, O, Mode>;
```

Returns a builder with all `ORDER BY` items removed.

#### Returns [#returns-7]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-clearselect" />

### clearSelect() [#clearselect]

```ts
clearSelect(): SelectQueryBuilder<DB, TB, unknown, "plain">;
```

Returns a builder with all current selections removed.

#### Returns [#returns-8]

`SelectQueryBuilder`\<`DB`, `TB`, `unknown`, `"plain"`>

***

<a id="api-clearwhere" />

### clearWhere() [#clearwhere]

```ts
clearWhere(): SelectQueryBuilder<DB, TB, O, Mode>;
```

Returns a builder with the `WHERE` predicate removed.

#### Returns [#returns-9]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-compile" />

### compile() [#compile]

```ts
compile(): CompiledQuery<O>;
```

Compiles the current operation tree into a `CompiledQuery`.

#### Returns [#returns-10]

[`CompiledQuery`](/docs/core/reference/api/interfaces/CompiledQuery)\<`O`>

***

<a id="api-execute" />

### execute() [#execute]

```ts
execute(options?): Promise<readonly O[]>;
```

Compiles and executes the query with the configured executor.

#### Parameters [#parameters-2]

| Parameter  | Type                                                                                 |
| ---------- | ------------------------------------------------------------------------------------ |
| `options?` | [`AbortableQueryOptions`](/docs/core/reference/api/interfaces/AbortableQueryOptions) |

#### Returns [#returns-11]

`Promise`\<readonly `O`\[]>

***

<a id="api-executetakefirst" />

### executeTakeFirst() [#executetakefirst]

```ts
executeTakeFirst(options?): Promise<O | undefined>;
```

Executes the query and returns the first row, or `undefined` when no rows match.

#### Parameters [#parameters-3]

| Parameter  | Type                                                                                 |
| ---------- | ------------------------------------------------------------------------------------ |
| `options?` | [`AbortableQueryOptions`](/docs/core/reference/api/interfaces/AbortableQueryOptions) |

#### Returns [#returns-12]

`Promise`\<`O` | `undefined`>

***

<a id="api-executetakefirstorthrow" />

### executeTakeFirstOrThrow() [#executetakefirstorthrow]

```ts
executeTakeFirstOrThrow(options?): Promise<O>;
```

Executes the query and returns the first row, throwing when no rows match.

#### Parameters [#parameters-4]

| Parameter  | Type                                                                                                                                                                                                                               |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `options?` | \| [`ExecuteTakeFirstOrThrowOptions`](/docs/core/reference/api/interfaces/ExecuteTakeFirstOrThrowOptions) \| [`NoResultErrorConstructor`](/docs/core/reference/api/type-aliases/NoResultErrorConstructor) \| ((`node`) => `Error`) |

#### Returns [#returns-13]

`Promise`\<`O`>

***

<a id="api-executeall" />

### executeAll() [#executeall]

```ts
executeAll(options?): Promise<readonly O[]>;
```

Executes with the executor's Salesforce query-all semantics.

#### Parameters [#parameters-5]

| Parameter  | Type                                                                                 |
| ---------- | ------------------------------------------------------------------------------------ |
| `options?` | [`AbortableQueryOptions`](/docs/core/reference/api/interfaces/AbortableQueryOptions) |

#### Returns [#returns-14]

`Promise`\<readonly `O`\[]>

***

<a id="api-apex" />

### apex() [#apex]

```ts
apex(): ApexSelectQueryBuilder<DB, TB, O, Mode, "static">;
```

Switches to the static Apex builder for the current query.

#### Returns [#returns-15]

[`ApexSelectQueryBuilder`](/docs/core/reference/api/interfaces/ApexSelectQueryBuilder)\<`DB`, `TB`, `O`, `Mode`, `"static"`>

***

<a id="api-dynamicapex" />

### dynamicApex() [#dynamicapex]

```ts
dynamicApex(): ApexSelectQueryBuilder<DB, TB, O, Mode, "dynamic">;
```

Switches to the dynamic Apex builder for the current query.

#### Returns [#returns-16]

[`ApexSelectQueryBuilder`](/docs/core/reference/api/interfaces/ApexSelectQueryBuilder)\<`DB`, `TB`, `O`, `Mode`, `"dynamic"`>

***

<a id="api-limit" />

### limit() [#limit]

```ts
limit(limit): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds or replaces the SOQL `LIMIT` clause.

#### Parameters [#parameters-6]

| Parameter | Type     |
| --------- | -------- |
| `limit`   | `number` |

#### Returns [#returns-17]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-offset" />

### offset() [#offset]

```ts
offset(offset): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds or replaces the SOQL `OFFSET` clause.

#### Parameters [#parameters-7]

| Parameter | Type     |
| --------- | -------- |
| `offset`  | `number` |

#### Returns [#returns-18]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-groupby" />

### groupBy() [#groupby]

#### Call Signature [#call-signature]

```ts
groupBy<GE>(field): AggregateSelectQueryBuilder<DB, TB, O, GE, "ordinary", 0>;
```

Adds a `GROUP BY` expression and enters aggregate-query mode.

##### Type Parameters [#type-parameters-6]

| Type Parameter          |
| ----------------------- |
| `GE` *extends* `string` |

##### Parameters [#parameters-8]

| Parameter | Type                                                                   |
| --------- | ---------------------------------------------------------------------- |
| `field`   | `UnselectedOnly`\<`O`, `GE` & `GroupableFieldName`\<`DB`, `TB`, `GE`>> |

##### Returns [#returns-19]

[`AggregateSelectQueryBuilder`](/docs/core/reference/api/interfaces/AggregateSelectQueryBuilder)\<`DB`, `TB`, `O`, `GE`, `"ordinary"`, `0`>

#### Call Signature [#call-signature-1]

```ts
groupBy<GE>(fields): AggregateSelectQueryBuilder<DB, TB, O, GE, "ordinary", 0>;
```

Adds a `GROUP BY` expression and enters aggregate-query mode.

##### Type Parameters [#type-parameters-7]

| Type Parameter          |
| ----------------------- |
| `GE` *extends* `string` |

##### Parameters [#parameters-9]

| Parameter | Type                                                                               |
| --------- | ---------------------------------------------------------------------------------- |
| `fields`  | `UnselectedOnly`\<`O`, readonly `GE` & `GroupableFieldName`\<`DB`, `TB`, `GE`>\[]> |

##### Returns [#returns-20]

[`AggregateSelectQueryBuilder`](/docs/core/reference/api/interfaces/AggregateSelectQueryBuilder)\<`DB`, `TB`, `O`, `GE`, `"ordinary"`, `0`>

#### Call Signature [#call-signature-2]

```ts
groupBy<Expression>(expression): AggregateSelectQueryBuilder<DB, TB, O, DateFunctionIdentityOf<Expression>, "ordinary", 0>;
```

Adds a `GROUP BY` expression and enters aggregate-query mode.

##### Type Parameters [#type-parameters-8]

| Type Parameter                                                                                                                                                                                                                   |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Expression` *extends* [`DateFunctionExpression`](/docs/core/reference/api/interfaces/DateFunctionExpression)\<`unknown`, `unknown`, [`ComparisonOperator`](/docs/core/reference/api/type-aliases/ComparisonOperator), `string`> |

##### Parameters [#parameters-10]

| Parameter    | Type                                           |
| ------------ | ---------------------------------------------- |
| `expression` | `UnselectedOnly`\<`O`, (`eb`) => `Expression`> |

##### Returns [#returns-21]

[`AggregateSelectQueryBuilder`](/docs/core/reference/api/interfaces/AggregateSelectQueryBuilder)\<`DB`, `TB`, `O`, `DateFunctionIdentityOf`\<`Expression`>, `"ordinary"`, `0`>

***

<a id="api-forview" />

### forView() [#forview]

```ts
forView(..._mruCheck): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds `FOR VIEW`; available only for MRU-enabled objects.

#### Parameters [#parameters-11]

| Parameter      | Type                                                                                                                                                                  |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ...`_mruCheck` | [`SalesforceObjectMruEnabled`](/docs/core/reference/api/type-aliases/SalesforceObjectMruEnabled)\<`DB`\[`TB`]> *extends* `false` ? readonly \[`never`] : readonly \[] |

#### Returns [#returns-22]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-forreference" />

### forReference() [#forreference]

```ts
forReference(..._mruCheck): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds `FOR REFERENCE`; available only for MRU-enabled objects.

#### Parameters [#parameters-12]

| Parameter      | Type                                                                                                                                                                  |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ...`_mruCheck` | [`SalesforceObjectMruEnabled`](/docs/core/reference/api/type-aliases/SalesforceObjectMruEnabled)\<`DB`\[`TB`]> *extends* `false` ? readonly \[`never`] : readonly \[] |

#### Returns [#returns-23]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-updatetracking" />

### updateTracking() [#updatetracking]

```ts
updateTracking(..._knowledgeArticleCheck): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds the KnowledgeArticle `UPDATE TRACKING` clause.

#### Parameters [#parameters-13]

| Parameter                   | Type                                 |
| --------------------------- | ------------------------------------ |
| ...`_knowledgeArticleCheck` | `KnowledgeArticleUpdateCheck`\<`TB`> |

#### Returns [#returns-24]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-updateviewstat" />

### updateViewstat() [#updateviewstat]

```ts
updateViewstat(..._knowledgeArticleCheck): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds the KnowledgeArticle `UPDATE VIEWSTAT` clause.

#### Parameters [#parameters-14]

| Parameter                   | Type                                 |
| --------------------------- | ------------------------------------ |
| ...`_knowledgeArticleCheck` | `KnowledgeArticleUpdateCheck`\<`TB`> |

#### Returns [#returns-25]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-usingscope" />

### usingScope() [#usingscope]

```ts
usingScope(scope): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds a Salesforce `USING SCOPE` clause validated against schema metadata.

#### Parameters [#parameters-15]

| Parameter | Type                                                                                                                   |
| --------- | ---------------------------------------------------------------------------------------------------------------------- |
| `scope`   | [`SalesforceObjectSupportedScope`](/docs/core/reference/api/type-aliases/SalesforceObjectSupportedScope)\<`DB`\[`TB`]> |

#### Returns [#returns-26]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-withuserid" />

### withUserId() [#withuserid]

```ts
withUserId(userId, ..._userProfileFeedCheck): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds the UserProfileFeed `WITH USER_ID` clause.

#### Parameters [#parameters-16]

| Parameter                  | Type                                    |
| -------------------------- | --------------------------------------- |
| `userId`                   | `string`                                |
| ...`_userProfileFeedCheck` | `UserProfileFeedWithUserIdCheck`\<`TB`> |

#### Returns [#returns-27]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-withrecordvisibilitycontext" />

### withRecordVisibilityContext() [#withrecordvisibilitycontext]

```ts
withRecordVisibilityContext(parameters): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds `WITH RECORD_VISIBILITY_CONTEXT` options.

#### Parameters [#parameters-17]

| Parameter    | Type                                                                                                     |
| ------------ | -------------------------------------------------------------------------------------------------------- |
| `parameters` | [`RecordVisibilityContextOptions`](/docs/core/reference/api/type-aliases/RecordVisibilityContextOptions) |

#### Returns [#returns-28]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-setoptions" />

### setOptions() [#setoptions]

```ts
setOptions(options): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds object-specific Salesforce `SET OPTIONS` values.

#### Parameters [#parameters-18]

| Parameter | Type                                                                                               |
| --------- | -------------------------------------------------------------------------------------------------- |
| `options` | [`Data360SetOptionsFor`](/docs/core/reference/api/type-aliases/Data360SetOptionsFor)\<`DB`\[`TB`]> |

#### Returns [#returns-29]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-withdatacategory" />

### withDataCategory() [#withdatacategory]

```ts
withDataCategory<Group>(
   group,
   selector,
   categories
): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds a typed `WITH DATA CATEGORY` filter.

#### Type Parameters [#type-parameters-9]

| Type Parameter            |
| ------------------------- |
| `Group` *extends* `never` |

#### Parameters [#parameters-19]

| Parameter    | Type                                                                                                                                                                                                         |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `group`      | `Group`                                                                                                                                                                                                      |
| `selector`   | [`DataCategorySelector`](/docs/core/reference/api/type-aliases/DataCategorySelector)                                                                                                                         |
| `categories` | [`DataCategoryInput`](/docs/core/reference/api/type-aliases/DataCategoryInput)\<[`SalesforceObjectDataCategory`](/docs/core/reference/api/type-aliases/SalesforceObjectDataCategory)\<`DB`\[`TB`], `Group`>> |

#### Returns [#returns-30]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-orderby" />

### orderBy() [#orderby]

#### Call Signature [#call-signature-3]

```ts
orderBy(
   expression,
   direction?,
   nulls?
): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds a typed `ORDER BY` item.

##### Parameters [#parameters-20]

| Parameter    | Type                                                                         |
| ------------ | ---------------------------------------------------------------------------- |
| `expression` | [`SoqlRawBuilder`](/docs/core/reference/api/interfaces/SoqlRawBuilder)       |
| `direction?` | [`OrderByDirection`](/docs/core/reference/api/type-aliases/OrderByDirection) |
| `nulls?`     | [`OrderByNulls`](/docs/core/reference/api/type-aliases/OrderByNulls)         |

##### Returns [#returns-31]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

#### Call Signature [#call-signature-4]

```ts
orderBy(
   expression,
   direction?,
   nulls?
): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds a typed `ORDER BY` item.

##### Parameters [#parameters-21]

| Parameter    | Type                                                                         |
| ------------ | ---------------------------------------------------------------------------- |
| `expression` | `DistanceOrderByFactory`\<`DB`, `TB`>                                        |
| `direction?` | [`OrderByDirection`](/docs/core/reference/api/type-aliases/OrderByDirection) |
| `nulls?`     | [`OrderByNulls`](/docs/core/reference/api/type-aliases/OrderByNulls)         |

##### Returns [#returns-32]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

#### Call Signature [#call-signature-5]

```ts
orderBy<OE>(
   field,
   direction?,
   nulls?
): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds a typed `ORDER BY` item.

##### Type Parameters [#type-parameters-10]

| Type Parameter          |
| ----------------------- |
| `OE` *extends* `string` |

##### Parameters [#parameters-22]

| Parameter    | Type                                                                         |
| ------------ | ---------------------------------------------------------------------------- |
| `field`      | `OE` & `SortableFieldName`\<`DB`, `TB`, `OE`>                                |
| `direction?` | [`OrderByDirection`](/docs/core/reference/api/type-aliases/OrderByDirection) |
| `nulls?`     | `OrderByNullsForReference`\<`DB`, `TB`, `OE`>                                |

##### Returns [#returns-33]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-where" />

### where() [#where]

#### Call Signature [#call-signature-6]

```ts
where(expression): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds a typed `WHERE` predicate and combines it with any existing predicate using `AND`.

##### Parameters [#parameters-23]

| Parameter    | Type                                                                   |
| ------------ | ---------------------------------------------------------------------- |
| `expression` | [`SoqlRawBuilder`](/docs/core/reference/api/interfaces/SoqlRawBuilder) |

##### Returns [#returns-34]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

#### Call Signature [#call-signature-7]

```ts
where(expression): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds a typed `WHERE` predicate and combines it with any existing predicate using `AND`.

##### Parameters [#parameters-24]

| Parameter    | Type                                                                                                  |
| ------------ | ----------------------------------------------------------------------------------------------------- |
| `expression` | [`WhereExpressionFactory`](/docs/core/reference/api/type-aliases/WhereExpressionFactory)\<`DB`, `TB`> |

##### Returns [#returns-35]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

#### Call Signature [#call-signature-8]

```ts
where<RE, OP, RHS>(
   lhs,
   op,
   rhs
): SelectQueryBuilder<DB, TB, O, Mode>;
```

Adds a typed `WHERE` predicate and combines it with any existing predicate using `AND`.

##### Type Parameters [#type-parameters-11]

| Type Parameter                                                                                                                                                                                                                                                                    |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `RE` *extends* `string`                                                                                                                                                                                                                                                           |
| `OP` *extends* \| `"="` \| `"!="` \| [`OrderedComparisonOperator`](/docs/core/reference/api/type-aliases/OrderedComparisonOperator) \| `"in"` \| `"not in"` \| [`MultiSelectComparisonOperator`](/docs/core/reference/api/type-aliases/MultiSelectComparisonOperator) \| `"like"` |
| `RHS`                                                                                                                                                                                                                                                                             |

##### Parameters [#parameters-25]

| Parameter | Type                                            |
| --------- | ----------------------------------------------- |
| `lhs`     | `RE` & `FilterableFieldName`\<`DB`, `TB`, `RE`> |
| `op`      | `OP`                                            |
| `rhs`     | `RHS`                                           |

##### Returns [#returns-36]

`SelectQueryBuilder`\<`DB`, `TB`, `O`, `Mode`>

***

<a id="api-select" />

### select() [#select]

#### Call Signature [#call-signature-9]

```ts
select<RawOutput>(selection): SelectQueryBuilder<DB, TB, O & RawOutput, Mode>;
```

Adds one or more typed selections to the query output.

##### Type Parameters [#type-parameters-12]

| Type Parameter |
| -------------- |
| `RawOutput`    |

##### Parameters [#parameters-26]

| Parameter   | Type                                                                                 |
| ----------- | ------------------------------------------------------------------------------------ |
| `selection` | [`SoqlRawBuilder`](/docs/core/reference/api/interfaces/SoqlRawBuilder)\<`RawOutput`> |

##### Returns [#returns-37]

`SelectQueryBuilder`\<`DB`, `TB`, `O` & `RawOutput`, `Mode`>

#### Call Signature [#call-signature-10]

```ts
select(selection): CountQueryBuilder<DB, TB>;
```

Adds one or more typed selections to the query output.

##### Parameters [#parameters-27]

| Parameter   | Type                                                         |
| ----------- | ------------------------------------------------------------ |
| `selection` | `UnselectedOnly`\<`O`, `CountSelectionFactory`\<`DB`, `TB`>> |

##### Returns [#returns-38]

[`CountQueryBuilder`](/docs/core/reference/api/interfaces/CountQueryBuilder)\<`DB`, `TB`>

#### Call Signature [#call-signature-11]

```ts
select<FunctionSelection>(selection): SelectQueryBuilder<DB, TB, O & SelectFunctionSelection<FunctionSelection>, AfterSelectFunctionMode<Mode>>;
```

Adds one or more typed selections to the query output.

##### Type Parameters [#type-parameters-13]

| Type Parameter                                             |
| ---------------------------------------------------------- |
| `FunctionSelection` *extends* `SelectFunctionSelectionArg` |

##### Parameters [#parameters-28]

| Parameter   | Type                                                                                                        |
| ----------- | ----------------------------------------------------------------------------------------------------------- |
| `selection` | `SelectFunctionFactoryForMode`\<`Mode`, `SelectFunctionSelectionFactory`\<`DB`, `TB`, `FunctionSelection`>> |

##### Returns [#returns-39]

`SelectQueryBuilder`\<`DB`, `TB`, `O` & `SelectFunctionSelection`\<`FunctionSelection`>, `AfterSelectFunctionMode`\<`Mode`>>

#### Call Signature [#call-signature-12]

```ts
select<Aggregate>(selection): AggregateSelectQueryBuilder<DB, TB, AggregateSelection<Aggregate>>;
```

Adds one or more typed selections to the query output.

##### Type Parameters [#type-parameters-14]

| Type Parameter                                |
| --------------------------------------------- |
| `Aggregate` *extends* `AggregateSelectionArg` |

##### Parameters [#parameters-29]

| Parameter   | Type                                                                          |
| ----------- | ----------------------------------------------------------------------------- |
| `selection` | `UnselectedOnly`\<`O`, `AggregateSelectionFactory`\<`DB`, `TB`, `Aggregate`>> |

##### Returns [#returns-40]

[`AggregateSelectQueryBuilder`](/docs/core/reference/api/interfaces/AggregateSelectQueryBuilder)\<`DB`, `TB`, `AggregateSelection`\<`Aggregate`>>

#### Call Signature [#call-signature-13]

```ts
select<Selections>(selections): SelectQueryBuilder<DB, TB, O & Selection<DB, TB, Selections[number]>, Mode>;
```

Adds one or more typed selections to the query output.

##### Type Parameters [#type-parameters-15]

| Type Parameter                              |
| ------------------------------------------- |
| `Selections` *extends* readonly `string`\[] |

##### Parameters [#parameters-30]

| Parameter    | Type                                                                         |
| ------------ | ---------------------------------------------------------------------------- |
| `selections` | `Selections` & `CheckedSelectExpressionList`\<`DB`, `TB`, `O`, `Selections`> |

##### Returns [#returns-41]

`SelectQueryBuilder`\<`DB`, `TB`, `O` & `Selection`\<`DB`, `TB`, `Selections`\[`number`]>, `Mode`>

#### Call Signature [#call-signature-14]

```ts
select<SE>(selection): SelectQueryBuilder<DB, TB, O & Selection<DB, TB, SE>, Mode>;
```

Adds one or more typed selections to the query output.

##### Type Parameters [#type-parameters-16]

| Type Parameter          |
| ----------------------- |
| `SE` *extends* `string` |

##### Parameters [#parameters-31]

| Parameter   | Type                                                                                               |
| ----------- | -------------------------------------------------------------------------------------------------- |
| `selection` | `SE` & `SelectExpression`\<`DB`, `TB`, `SE`> & `AvailableSelectExpression`\<`DB`, `TB`, `O`, `SE`> |

##### Returns [#returns-42]

`SelectQueryBuilder`\<`DB`, `TB`, `O` & `Selection`\<`DB`, `TB`, `SE`>, `Mode`>

***

<a id="api-selectfields" />

### selectFields() [#selectfields]

```ts
selectFields<Selector>(selector, ...check): SelectQueryBuilder<DB, TB, O & FieldsSelection<DB, TB, Selector>, Mode>;
```

Select a server-expanded group; unavailable on field-filtered schemas.

#### Type Parameters [#type-parameters-17]

| Type Parameter                                                                                |
| --------------------------------------------------------------------------------------------- |
| `Selector` *extends* [`FieldsSelector`](/docs/core/reference/api/type-aliases/FieldsSelector) |

#### Parameters [#parameters-32]

| Parameter  | Type                                                 |
| ---------- | ---------------------------------------------------- |
| `selector` | `Selector`                                           |
| ...`check` | `FieldsSelectionCheck`\<`DB`, `TB`, `O`, `Selector`> |

#### Returns [#returns-43]

`SelectQueryBuilder`\<`DB`, `TB`, `O` & `FieldsSelection`\<`DB`, `TB`, `Selector`>, `Mode`>

***

<a id="api-selecttypeof" />

### selectTypeOf() [#selecttypeof]

```ts
selectTypeOf<Reference, Builder>(
   reference,
   callback,
   ..._modeCheck
): SelectQueryBuilder<DB, TB, O & TypeOfSelection<DB, TB, Reference, TypeOfValue<PolymorphicRelationshipTargets<DB, TB, Reference>, Builder>>, AfterTypeOfMode<Mode>>;
```

Adds a typed `TYPEOF` selection for a polymorphic relationship.

#### Type Parameters [#type-parameters-18]

| Type Parameter                               |
| -------------------------------------------- |
| `Reference` *extends* `string`               |
| `Builder` *extends* `CompletedTypeOfBuilder` |

#### Parameters [#parameters-33]

| Parameter       | Type                                                                                                                       |
| --------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `reference`     | `Reference` & `PolymorphicRelationshipReference`\<`DB`, `TB`, `Reference`> & `AvailableTypeOfReference`\<`O`, `Reference`> |
| `callback`      | (`typeOf`) => `Builder`                                                                                                    |
| ...`_modeCheck` | `TypeOfModeCheck`\<`Mode`>                                                                                                 |

#### Returns [#returns-44]

`SelectQueryBuilder`\<`DB`, `TB`, `O` & `TypeOfSelection`\<`DB`, `TB`, `Reference`, `TypeOfValue`\<`PolymorphicRelationshipTargets`\<`DB`, `TB`, `Reference`>, `Builder`>>, `AfterTypeOfMode`\<`Mode`>>

***

<a id="api-selectsubquery" />

### selectSubquery() [#selectsubquery]

```ts
selectSubquery<Relationship, SubqueryOutput, SubqueryFunctionMode>(relationship, callback): SelectQueryBuilder<DB, TB, O & { readonly [Key in string]: SalesforceQueryResult<Simplify<SubqueryOutput>> }, AfterSubqueryMode<Mode, SubqueryFunctionMode>>;
```

Adds a typed child-relationship subquery selection.

#### Type Parameters [#type-parameters-19]

| Type Parameter                                                            |
| ------------------------------------------------------------------------- |
| `Relationship` *extends* `string`                                         |
| `SubqueryOutput`                                                          |
| `SubqueryFunctionMode` *extends* `"none"` \| `"present"` \| `"forbidden"` |

#### Parameters [#parameters-34]

| Parameter      | Type                                                                                                                                                                                                                                                                                    |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `relationship` | `Relationship` & `ChildRelationshipReference`\<`DB`, `TB`, `Relationship`>                                                                                                                                                                                                              |
| `callback`     | (`query`) => [`RelationshipSubqueryBuilder`](/docs/core/reference/api/interfaces/RelationshipSubqueryBuilder)\<`DB`, `ChildObjectName`\<`DB`, `TB`, `Extract`\<`Relationship`, `ChildRelationshipName`\<`DB`, `TB`>>>, `SubqueryOutput`, readonly \[`unknown`], `SubqueryFunctionMode`> |

#### Returns [#returns-45]

`SelectQueryBuilder`\<`DB`, `TB`, `O` & `{ readonly [Key in string]: SalesforceQueryResult<Simplify<SubqueryOutput>> }`, `AfterSubqueryMode`\<`Mode`, `SubqueryFunctionMode`>>

***

<a id="api-tooperationnode" />

### toOperationNode() [#tooperationnode]

```ts
toOperationNode(): SelectQueryNode;
```

Returns the immutable operation node represented by this builder.

#### Returns [#returns-46]

[`SelectQueryNode`](/docs/core/reference/api/type-aliases/SelectQueryNode)