Kysoql
ReferenceAPI referenceInterfaces

AggregateSelectQueryBuilder

Generated API reference for AggregateSelectQueryBuilder in @kysoql/core.

@kysoql/core / AggregateSelectQueryBuilder

Type-safe builder for grouped and aggregate Salesforce SELECT queries.

Type Parameters

Type ParameterDefault type
DB-
TB extends keyof DB-
O-
GroupedBy extends stringnever
GroupMode extends AggregateGroupMode"none"
AdvancedFieldCount extends AdvancedGroupFieldCount0

Methods

$call()

$call<T>(func): T;

Passes this builder to func and returns the callback result.

Type Parameters

Type Parameter
T

Parameters

ParameterType
func(qb) => T

Returns

T

$assertType()

$assertType<T>(): O extends T ? AggregateSelectQueryBuilder<DB, TB, T, GroupedBy, GroupMode, AdvancedFieldCount> : 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 Parameter
T

Returns

O extends T ? AggregateSelectQueryBuilder<DB, TB, T, GroupedBy, GroupMode, AdvancedFieldCount> : KysoqlTypeError<"$assertType() call failed: The type passed in is not equal to the output type of the query.">

$castTo()

$castTo<C>(): AggregateSelectQueryBuilder<DB, TB, C, GroupedBy, GroupMode, AdvancedFieldCount>;

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

Type Parameters

Type Parameter
C

Returns

AggregateSelectQueryBuilder<DB, TB, C, GroupedBy, GroupMode, AdvancedFieldCount>

$narrowType()

$narrowType<T>(): AggregateSelectQueryBuilder<DB, TB, NarrowPartial<O, T>, GroupedBy, GroupMode, AdvancedFieldCount>;

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

Type Parameters

Type Parameter
T

Returns

AggregateSelectQueryBuilder<DB, TB, NarrowPartial<O, T>, GroupedBy, GroupMode, AdvancedFieldCount>

$if()

$if<O2>(condition, func): AggregateSelectQueryBuilder<DB, TB, ConditionalOutput<O, O2>, GroupedBy, GroupMode, AdvancedFieldCount>;

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

Type Parameters

Type Parameter
O2

Parameters

ParameterType
conditionboolean
func(qb) => AggregateSelectQueryBuilder<DB, TB, O & O2, GroupedBy, GroupMode, AdvancedFieldCount>

Returns

AggregateSelectQueryBuilder<DB, TB, ConditionalOutput<O, O2>, GroupedBy, GroupMode, AdvancedFieldCount>

clearGroupBy()

clearGroupBy(): AggregateSelectQueryBuilder<DB, TB, O, never, "none", 0>;

Returns a builder with the GROUP BY clause removed.

Returns

AggregateSelectQueryBuilder<DB, TB, O, never, "none", 0>

clearLimit()

clearLimit(): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Returns a builder with the LIMIT clause removed.

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

clearOffset()

clearOffset(): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Returns a builder with the OFFSET clause removed.

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

clearOrderBy()

clearOrderBy(): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Returns a builder with all ORDER BY items removed.

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

clearSelect()

clearSelect(): AggregateSelectQueryBuilder<DB, TB, unknown, GroupedBy, GroupMode, AdvancedFieldCount>;

Returns a builder with all current selections removed.

Returns

AggregateSelectQueryBuilder<DB, TB, unknown, GroupedBy, GroupMode, AdvancedFieldCount>

clearWhere()

clearWhere(): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Returns a builder with the WHERE predicate removed.

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

compile()

compile(): CompiledQuery<O>;

Compiles the current operation tree into a CompiledQuery.

Returns

CompiledQuery<O>

execute()

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

Compiles and executes the query with the configured executor.

Parameters

ParameterType
options?AbortableQueryOptions

Returns

Promise<readonly O[]>

executeTakeFirst()

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

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

Parameters

ParameterType
options?AbortableQueryOptions

Returns

Promise<O | undefined>

executeTakeFirstOrThrow()

executeTakeFirstOrThrow(options?): Promise<O>;

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

Parameters

ParameterType
options?| ExecuteTakeFirstOrThrowOptions | NoResultErrorConstructor | ((node) => Error)

Returns

Promise<O>

executeAll()

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

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

Parameters

ParameterType
options?AbortableQueryOptions

Returns

Promise<readonly O[]>

apex()

apex(): ApexAggregateSelectQueryBuilder<DB, TB, O, "static">;

Switches to the static Apex builder for the current query.

Returns

ApexAggregateSelectQueryBuilder<DB, TB, O, "static">

dynamicApex()

dynamicApex(): ApexAggregateSelectQueryBuilder<DB, TB, O, "dynamic">;

Switches to the dynamic Apex builder for the current query.

Returns

ApexAggregateSelectQueryBuilder<DB, TB, O, "dynamic">

forView()

forView(..._mruCheck): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

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

Parameters

ParameterType
..._mruCheckSalesforceObjectMruEnabled<DB[TB]> extends false ? readonly [never] : readonly []

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

forReference()

forReference(..._mruCheck): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

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

Parameters

ParameterType
..._mruCheckSalesforceObjectMruEnabled<DB[TB]> extends false ? readonly [never] : readonly []

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

updateTracking()

updateTracking(..._knowledgeArticleCheck): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds the KnowledgeArticle UPDATE TRACKING clause.

Parameters

ParameterType
..._knowledgeArticleCheckKnowledgeArticleUpdateCheck<TB>

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

updateViewstat()

updateViewstat(..._knowledgeArticleCheck): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds the KnowledgeArticle UPDATE VIEWSTAT clause.

Parameters

ParameterType
..._knowledgeArticleCheckKnowledgeArticleUpdateCheck<TB>

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

usingScope()

usingScope(scope): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds a Salesforce USING SCOPE clause validated against schema metadata.

Parameters

ParameterType
scopeSalesforceObjectSupportedScope<DB[TB]>

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

withUserId()

withUserId(userId, ..._userProfileFeedCheck): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds the UserProfileFeed WITH USER_ID clause.

Parameters

ParameterType
userIdstring
..._userProfileFeedCheckUserProfileFeedWithUserIdCheck<TB>

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

withRecordVisibilityContext()

withRecordVisibilityContext(parameters): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds WITH RECORD_VISIBILITY_CONTEXT options.

Parameters

ParameterType
parametersRecordVisibilityContextOptions

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

setOptions()

setOptions(options): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds object-specific Salesforce SET OPTIONS values.

Parameters

ParameterType
optionsData360AggregateSetOptionsFor<DB[TB]>

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

withDataCategory()

withDataCategory<Group>(
   group,
   selector,
   categories
): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds a typed WITH DATA CATEGORY filter.

Type Parameters

Type Parameter
Group extends never

Parameters

ParameterType
groupGroup
selectorDataCategorySelector
categoriesDataCategoryInput<SalesforceObjectDataCategory<DB[TB], Group>>

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

groupBy()

Call Signature

groupBy<GE>(field): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy | GE, NextGroupMode<GroupMode, "ordinary">, AdvancedFieldCount>;

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

Type Parameters
Type Parameter
GE extends string
Parameters
ParameterType
fieldGroupModeOnly<GroupMode, "ordinary", GE & GroupableFieldName<DB, TB, GE>>
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy | GE, NextGroupMode<GroupMode, "ordinary">, AdvancedFieldCount>

Call Signature

groupBy<Expression>(expression): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy | DateFunctionIdentityOf<Expression>, NextGroupMode<GroupMode, "ordinary">, AdvancedFieldCount>;

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

Type Parameters
Type Parameter
Expression extends DateFunctionExpression<unknown, unknown, ComparisonOperator, string>
Parameters
ParameterType
expressionGroupModeOnly<GroupMode, "ordinary", (eb) => Expression>
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy | DateFunctionIdentityOf<Expression>, NextGroupMode<GroupMode, "ordinary">, AdvancedFieldCount>

Call Signature

groupBy<GE>(fields): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy | GE, NextGroupMode<GroupMode, "ordinary">, AdvancedFieldCount>;

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

Type Parameters
Type Parameter
GE extends string
Parameters
ParameterType
fieldsGroupModeOnly<GroupMode, "ordinary", readonly GE & GroupableFieldName<DB, TB, GE>[]>
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy | GE, NextGroupMode<GroupMode, "ordinary">, AdvancedFieldCount>

groupByRollup()

groupByRollup<Input>(fields): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy | AdvancedGroupByField<Input>, NextGroupMode<GroupMode, "rollup">, AddAdvancedGroupFieldCount<AdvancedFieldCount, AdvancedGroupByInputCount<Input>>>;

Adds a GROUP BY ROLLUP expression.

Type Parameters

Type Parameter
Input extends AdvancedGroupByInput

Parameters

ParameterType
fieldsGroupModeOnly<GroupMode, "rollup", AdvancedGroupByArgument<DB, TB, AdvancedFieldCount, Input>>

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy | AdvancedGroupByField<Input>, NextGroupMode<GroupMode, "rollup">, AddAdvancedGroupFieldCount<AdvancedFieldCount, AdvancedGroupByInputCount<Input>>>

groupByCube()

groupByCube<Input>(fields): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy | AdvancedGroupByField<Input>, NextGroupMode<GroupMode, "cube">, AddAdvancedGroupFieldCount<AdvancedFieldCount, AdvancedGroupByInputCount<Input>>>;

Adds a GROUP BY CUBE expression.

Type Parameters

Type Parameter
Input extends AdvancedGroupByInput

Parameters

ParameterType
fieldsGroupModeOnly<GroupMode, "cube", AdvancedGroupByArgument<DB, TB, AdvancedFieldCount, Input>>

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy | AdvancedGroupByField<Input>, NextGroupMode<GroupMode, "cube">, AddAdvancedGroupFieldCount<AdvancedFieldCount, AdvancedGroupByInputCount<Input>>>

having()

Call Signature

having(expression): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds a typed HAVING predicate to the aggregate query.

Parameters
ParameterType
expressionGroupedOnly<GroupedBy, SoqlRawBuilder<unknown>>
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

Call Signature

having(expression): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds a typed HAVING predicate to the aggregate query.

Parameters
ParameterType
expressionGroupedOnly<GroupedBy, HavingExpressionFactory<DB, TB, GroupedBy, AdvancedGroupingFields<GroupedBy, GroupMode>>>
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

Call Signature

having<RE, OP, RHS>(
   lhs,
   op,
   rhs
): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds a typed HAVING predicate to the aggregate query.

Type Parameters
Type Parameter
RE extends string
OP extends | "=" | "!=" | OrderedComparisonOperator | "in" | "not in" | MultiSelectComparisonOperator | "like"
RHS
Parameters
ParameterType
lhsRE & GroupedOnly<GroupedBy, GroupedHavingFieldName<DB, TB, GroupedBy, RE>>
opOP
rhsRHS
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

limit()

limit(limit): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds or replaces the SOQL LIMIT clause.

Parameters

ParameterType
limitGroupedOnly<GroupedBy, number>

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

offset()

offset(offset): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds or replaces the SOQL OFFSET clause.

Parameters

ParameterType
offsetGroupedOnly<GroupedBy, number>

Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

orderBy()

Call Signature

orderBy(
   expression,
   direction?,
   nulls?
): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds a typed ORDER BY item.

Parameters
ParameterType
expressionGroupedOnly<GroupedBy, SoqlRawBuilder<unknown>>
direction?OrderByDirection
nulls?OrderByNulls
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

Call Signature

orderBy<OE>(
   field,
   direction?,
   nulls?
): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds a typed ORDER BY item.

Type Parameters
Type Parameter
OE extends string
Parameters
ParameterType
fieldOE & GroupedOnly<GroupedBy, GroupedSortableFieldName<DB, TB, GroupedBy, OE>>
direction?OrderByDirection
nulls?OrderByNullsForReference<DB, TB, OE>
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

Call Signature

orderBy(expression, direction?): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds a typed ORDER BY item.

Parameters
ParameterType
expressionAdvancedGroupingOnly<GroupMode, GroupingOrderByExpressionFactory<DB, TB, GroupedBy>>
direction?OrderByDirection
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

Call Signature

orderBy<Output, Value, Operator>(
   expression,
   direction?,
   nulls?
): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds a typed ORDER BY item.

Type Parameters
Type Parameter
Output
Value
Operator extends ComparisonOperator
Parameters
ParameterType
expressionGroupedOnly<GroupedBy, (eb) => AggregateFunctionBuilder<Output, Value, Operator>>
direction?OrderByDirection
nulls?OrderByNulls
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

Call Signature

orderBy<Output, Value, Operator, Identity>(expression, direction?): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds a typed ORDER BY item.

Type Parameters
Type Parameter
Output
Value
Operator extends ComparisonOperator
Identity extends string
Parameters
ParameterType
expressionGroupedOnly<GroupedBy, (eb) => DateFunctionExpression<Output, Value, Operator, Identity>>
direction?OrderByDirection
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

select()

Call Signature

select<RawOutput>(selection): AggregateSelectQueryBuilder<DB, TB, O & RawOutput, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds one or more typed selections to the query output.

Type Parameters
Type Parameter
RawOutput
Parameters
ParameterType
selectionSoqlRawBuilder<RawOutput>
Returns

AggregateSelectQueryBuilder<DB, TB, O & RawOutput, GroupedBy, GroupMode, AdvancedFieldCount>

Call Signature

select<Aggregate>(selection): AggregateSelectQueryBuilder<DB, TB, O & AggregateSelection<Aggregate>, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds one or more typed selections to the query output.

Type Parameters
Type Parameter
Aggregate extends AggregateSelectionArg
Parameters
ParameterType
selection(eb) => Aggregate
Returns

AggregateSelectQueryBuilder<DB, TB, O & AggregateSelection<Aggregate>, GroupedBy, GroupMode, AdvancedFieldCount>

Call Signature

select<Selection>(selection): AggregateSelectQueryBuilder<DB, TB, O & AggregateSelection<Selection>, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds one or more typed selections to the query output.

Type Parameters
Type Parameter
Selection extends GroupedSelectionArg
Parameters
ParameterType
selection(eb) => Selection & GroupedFunctionSelection<DB, TB, Selection, GroupedBy, GroupMode>
Returns

AggregateSelectQueryBuilder<DB, TB, O & AggregateSelection<Selection>, GroupedBy, GroupMode, AdvancedFieldCount>

Call Signature

select<Selections>(selections): AggregateSelectQueryBuilder<DB, TB, O & DrainOuterGeneric<{ [K in string]: ({ readonly [Field in string]: (GroupMode extends AdvancedGroupByMode ? true : false) extends true ? SalesforceFieldValue<FieldDefinition<(...), (...), (...)>> | null : SalesforceFieldValue<FieldDefinition<DB, TB, Field>> } & ParentSelection<DB, TB, Exclude<Selections[number], `${string} as ${string}`>, GroupMode extends AdvancedGroupByMode ? true : false> & AliasedSelection<DB, TB, Selections[number], GroupMode extends AdvancedGroupByMode ? true : false>)[K] }>, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds one or more typed selections to the query output.

Type Parameters
Type Parameter
Selections extends readonly string[]
Parameters
ParameterType
selectionsSelections & GroupedSelectExpressionList<DB, TB, GroupedBy, Selections>
Returns

AggregateSelectQueryBuilder<DB, TB, O & DrainOuterGeneric<{ [K in string]: ({ readonly [Field in string]: (GroupMode extends AdvancedGroupByMode ? true : false) extends true ? SalesforceFieldValue<FieldDefinition<(...), (...), (...)>> | null : SalesforceFieldValue<FieldDefinition<DB, TB, Field>> } & ParentSelection<DB, TB, Exclude<Selections[number], `${string} as ${string}`>, GroupMode extends AdvancedGroupByMode ? true : false> & AliasedSelection<DB, TB, Selections[number], GroupMode extends AdvancedGroupByMode ? true : false>)[K] }>, GroupedBy, GroupMode, AdvancedFieldCount>

Call Signature

select<SE>(selection): AggregateSelectQueryBuilder<DB, TB, O & DrainOuterGeneric<{ [K in string]: ({ readonly [Field in string]: (GroupMode extends AdvancedGroupByMode ? true : false) extends true ? SalesforceFieldValue<FieldDefinition<(...), (...), (...)>> | null : SalesforceFieldValue<FieldDefinition<DB, TB, Field>> } & ParentSelection<DB, TB, Exclude<SE, `${string} as ${string}`>, GroupMode extends AdvancedGroupByMode ? true : false> & AliasedSelection<DB, TB, SE, GroupMode extends AdvancedGroupByMode ? true : false>)[K] }>, GroupedBy, GroupMode, AdvancedFieldCount>;

Adds one or more typed selections to the query output.

Type Parameters
Type Parameter
SE extends string
Parameters
ParameterType
selectionSE & GroupedSelectExpression<DB, TB, GroupedBy, SE>
Returns

AggregateSelectQueryBuilder<DB, TB, O & DrainOuterGeneric<{ [K in string]: ({ readonly [Field in string]: (GroupMode extends AdvancedGroupByMode ? true : false) extends true ? SalesforceFieldValue<FieldDefinition<(...), (...), (...)>> | null : SalesforceFieldValue<FieldDefinition<DB, TB, Field>> } & ParentSelection<DB, TB, Exclude<SE, `${string} as ${string}`>, GroupMode extends AdvancedGroupByMode ? true : false> & AliasedSelection<DB, TB, SE, GroupMode extends AdvancedGroupByMode ? true : false>)[K] }>, GroupedBy, GroupMode, AdvancedFieldCount>

where()

Call Signature

where(expression): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

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

Parameters
ParameterType
expressionSoqlRawBuilder
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

Call Signature

where(expression): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

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

Parameters
ParameterType
expressionWhereExpressionFactory<DB, TB>
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

Call Signature

where<RE, OP, RHS>(
   lhs,
   op,
   rhs
): AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>;

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"
RHS
Parameters
ParameterType
lhsRE & FilterableFieldName<DB, TB, RE>
opOP
rhsRHS
Returns

AggregateSelectQueryBuilder<DB, TB, O, GroupedBy, GroupMode, AdvancedFieldCount>

toOperationNode()

toOperationNode(): SelectQueryNode;

Returns the immutable operation node represented by this builder.

Returns

SelectQueryNode

AggregateFunctionNode

Generated API reference for AggregateFunctionNode in @kysoql/core.

AliasedAggregateFunctionBuilder

Generated API reference for AliasedAggregateFunctionBuilder in @kysoql/core.

On this page

Type ParametersMethods$call()Type ParametersParametersReturns$assertType()Type ParametersReturns$castTo()Type ParametersReturns$narrowType()Type ParametersReturns$if()Type ParametersParametersReturnsclearGroupBy()ReturnsclearLimit()ReturnsclearOffset()ReturnsclearOrderBy()ReturnsclearSelect()ReturnsclearWhere()Returnscompile()Returnsexecute()ParametersReturnsexecuteTakeFirst()ParametersReturnsexecuteTakeFirstOrThrow()ParametersReturnsexecuteAll()ParametersReturnsapex()ReturnsdynamicApex()ReturnsforView()ParametersReturnsforReference()ParametersReturnsupdateTracking()ParametersReturnsupdateViewstat()ParametersReturnsusingScope()ParametersReturnswithUserId()ParametersReturnswithRecordVisibilityContext()ParametersReturnssetOptions()ParametersReturnswithDataCategory()Type ParametersParametersReturnsgroupBy()Call SignatureCall SignatureCall SignaturegroupByRollup()Type ParametersParametersReturnsgroupByCube()Type ParametersParametersReturnshaving()Call SignatureCall SignatureCall Signaturelimit()ParametersReturnsoffset()ParametersReturnsorderBy()Call SignatureCall SignatureCall SignatureCall SignatureCall Signatureselect()Call SignatureCall SignatureCall SignatureCall SignatureCall Signaturewhere()Call SignatureCall SignatureCall SignaturetoOperationNode()Returns