KysoqlApexSelectQueryBuilder
Generated API reference for ApexSelectQueryBuilder in @kysoql/core.
@kysoql/core / ApexSelectQueryBuilder
Apex rendering wrapper for a typed SELECT query.
Type Parameters
| Type Parameter | Default type |
|---|---|
DB | - |
TB extends keyof DB | - |
O | - |
Mode extends SelectQueryMode | SelectQueryMode |
Context extends ApexQueryContext | "static" |
Methods
$call()
$call<T>(func): T;Passes this builder to func and returns the callback result.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
func | (qb) => T |
Returns
T
$if()
$if<O2>(condition, func): ApexSelectQueryBuilder<DB, TB, ConditionalOutput<O, O2>, Mode, Context>;Conditionally applies a builder callback; when false, the runtime query is unchanged.
Type Parameters
| Type Parameter |
|---|
O2 |
Parameters
| Parameter | Type |
|---|---|
condition | boolean |
func | (qb) => ApexSelectQueryBuilder<DB, TB, O & O2, Mode, Context> |
Returns
ApexSelectQueryBuilder<DB, TB, ConditionalOutput<O, O2>, Mode, Context>
clearLimit()
clearLimit(): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Returns a builder with the LIMIT clause removed.
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
clearOffset()
clearOffset(): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Returns a builder with the OFFSET clause removed.
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
clearOrderBy()
clearOrderBy(): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Returns a builder with all ORDER BY items removed.
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
clearWhere()
clearWhere(): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Returns a builder with the WHERE predicate removed.
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
compile()
compile(): CompiledQuery<O>;Compiles the current operation tree into a CompiledQuery.
Returns
allRows()
allRows(): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Adds the Apex ALL ROWS clause.
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
forUpdate()
forUpdate(): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Adds FOR UPDATE so Salesforce locks the selected records.
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
limit()
limit(limit): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Adds or replaces the SOQL LIMIT clause.
Parameters
| Parameter | Type |
|---|---|
limit | number | ApexBindExpression<number> |
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
offset()
offset(offset): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Adds or replaces the SOQL OFFSET clause.
Parameters
| Parameter | Type |
|---|---|
offset | number | ApexBindExpression<number> |
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
selectSubquery()
selectSubquery<Relationship, SubqueryOutput, SubqueryFunctionMode>(relationship, callback): ApexSelectQueryBuilder<DB, TB, O & { readonly [Key in string]: SalesforceQueryResult<Simplify<SubqueryOutput>> }, AfterSubqueryMode<Mode, SubqueryFunctionMode>, Context>;Adds a typed child-relationship subquery selection.
Type Parameters
| Type Parameter |
|---|
Relationship extends string |
SubqueryOutput |
SubqueryFunctionMode extends "none" | "present" | "forbidden" |
Parameters
| Parameter | Type |
|---|---|
relationship | Relationship & ChildRelationshipReference<DB, TB, Relationship> |
callback | (query) => RelationshipSubqueryBuilder<DB, ChildObjectName<DB, TB, Extract<Relationship, ChildRelationshipName<DB, TB>>>, SubqueryOutput, readonly [unknown], SubqueryFunctionMode, true> |
Returns
ApexSelectQueryBuilder<DB, TB, O & { readonly [Key in string]: SalesforceQueryResult<Simplify<SubqueryOutput>> }, AfterSubqueryMode<Mode, SubqueryFunctionMode>, Context>
where()
Call Signature
where(expression): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Adds a typed WHERE predicate and combines it with any existing predicate using AND.
Parameters
| Parameter | Type |
|---|---|
expression | SoqlRawBuilder |
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
Call Signature
where(expression): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Adds a typed WHERE predicate and combines it with any existing predicate using AND.
Parameters
| Parameter | Type |
|---|---|
expression | ApexWhereExpressionFactory<DB, TB> |
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
Call Signature
where(
lhs,
op,
rhs
): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Adds a typed WHERE predicate and combines it with any existing predicate using AND.
Parameters
| Parameter | Type |
|---|---|
lhs | ApexBindExpression<string> |
op | "includes" |
rhs | readonly string[] |
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
Call Signature
where<RE, OP>(
lhs,
op,
rhs
): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Adds a typed WHERE predicate and combines it with any existing predicate using AND.
Type Parameters
| Type Parameter |
|---|
RE extends string |
OP extends | "=" | "!=" | OrderedComparisonOperator | "in" | "not in" | MultiSelectComparisonOperator | "like" |
Parameters
| Parameter | Type |
|---|---|
lhs | RE extends FilterableFieldName<DB, TB, RE> ? RE : never |
op | OP |
rhs | ApexOperandValueExpression<DB, TB, NoInfer<RE>, NoInfer<OP>> |
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
setOptions()
setOptions(options): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Adds dynamic Apex SET OPTIONS from a bound Database.QueryOptions variable.
Parameters
| Parameter | Type |
|---|---|
options | DynamicApexOnly<Context, ApexBindExpression<ApexDatabaseQueryOptions>> |
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
withSystemMode()
withSystemMode(): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Compiles the Apex query with WITH SYSTEM_MODE.
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
withUserMode()
withUserMode(): ApexSelectQueryBuilder<DB, TB, O, Mode, Context>;Compiles the Apex query with WITH USER_MODE.
Returns
ApexSelectQueryBuilder<DB, TB, O, Mode, Context>
toOperationNode()
toOperationNode(): SelectQueryNode;Returns the immutable operation node represented by this builder.