KysoqlApexAggregateSelectQueryBuilder
Generated API reference for ApexAggregateSelectQueryBuilder in @kysoql/core.
@kysoql/core / ApexAggregateSelectQueryBuilder
Apex rendering wrapper for an aggregate SELECT query.
Type Parameters
| Type Parameter | Default type |
|---|---|
DB | - |
TB extends keyof DB | - |
O | - |
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(condition, func): this;Conditionally applies a builder callback; when false, the runtime query is unchanged.
Parameters
| Parameter | Type |
|---|---|
condition | boolean |
func | (qb) => this |
Returns
this
clearGroupBy()
clearGroupBy(): ApexAggregateSelectQueryBuilder<DB, TB, O, Context>;Returns a builder with the GROUP BY clause removed.
Returns
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
clearLimit()
clearLimit(): ApexAggregateSelectQueryBuilder<DB, TB, O, Context>;Returns a builder with the LIMIT clause removed.
Returns
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
clearOffset()
clearOffset(): ApexAggregateSelectQueryBuilder<DB, TB, O, Context>;Returns a builder with the OFFSET clause removed.
Returns
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
clearOrderBy()
clearOrderBy(): ApexAggregateSelectQueryBuilder<DB, TB, O, Context>;Returns a builder with all ORDER BY items removed.
Returns
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
clearWhere()
clearWhere(): ApexAggregateSelectQueryBuilder<DB, TB, O, Context>;Returns a builder with the WHERE predicate removed.
Returns
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
compile()
compile(): CompiledQuery<O>;Compiles the current operation tree into a CompiledQuery.
Returns
allRows()
allRows(): ApexAggregateSelectQueryBuilder<DB, TB, O, Context>;Adds the Apex ALL ROWS clause.
Returns
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
limit()
limit(limit): ApexAggregateSelectQueryBuilder<DB, TB, O, Context>;Adds or replaces the SOQL LIMIT clause.
Parameters
| Parameter | Type |
|---|---|
limit | number | ApexBindExpression<number> |
Returns
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
offset()
offset(offset): ApexAggregateSelectQueryBuilder<DB, TB, O, Context>;Adds or replaces the SOQL OFFSET clause.
Parameters
| Parameter | Type |
|---|---|
offset | number | ApexBindExpression<number> |
Returns
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
where()
Call Signature
where(expression): ApexAggregateSelectQueryBuilder<DB, TB, O, Context>;Adds a typed WHERE predicate and combines it with any existing predicate using AND.
Parameters
| Parameter | Type |
|---|---|
expression | SoqlRawBuilder |
Returns
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
Call Signature
where(expression): ApexAggregateSelectQueryBuilder<DB, TB, O, Context>;Adds a typed WHERE predicate and combines it with any existing predicate using AND.
Parameters
| Parameter | Type |
|---|---|
expression | ApexWhereExpressionFactory<DB, TB> |
Returns
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
Call Signature
where(
lhs,
op,
rhs
): ApexAggregateSelectQueryBuilder<DB, TB, O, 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
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
Call Signature
where<RE, OP>(
lhs,
op,
rhs
): ApexAggregateSelectQueryBuilder<DB, TB, O, 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
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
setOptions()
setOptions(options): ApexAggregateSelectQueryBuilder<DB, TB, O, Context>;Adds dynamic Apex SET OPTIONS from a bound Database.QueryOptions variable.
Parameters
| Parameter | Type |
|---|---|
options | DynamicApexOnly<Context, ApexBindExpression<ApexDatabaseQueryOptions>> |
Returns
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
withSystemMode()
withSystemMode(): ApexAggregateSelectQueryBuilder<DB, TB, O, Context>;Compiles the Apex query with WITH SYSTEM_MODE.
Returns
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
withUserMode()
withUserMode(): ApexAggregateSelectQueryBuilder<DB, TB, O, Context>;Compiles the Apex query with WITH USER_MODE.
Returns
ApexAggregateSelectQueryBuilder<DB, TB, O, Context>
toOperationNode()
toOperationNode(): SelectQueryNode;Returns the immutable operation node represented by this builder.