KysoqlCountQueryBuilder
Generated API reference for CountQueryBuilder in @kysoql/core.
@kysoql/core / CountQueryBuilder
Type-safe builder for Salesforce COUNT() queries.
Type Parameters
| Type Parameter |
|---|
DB |
TB extends keyof DB |
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
clearLimit()
clearLimit(): CountQueryBuilder<DB, TB>;Returns a builder with the LIMIT clause removed.
Returns
CountQueryBuilder<DB, TB>
clearWhere()
clearWhere(): CountQueryBuilder<DB, TB>;Returns a builder with the WHERE predicate removed.
Returns
CountQueryBuilder<DB, TB>
compile()
compile(): CompiledQuery<number>;Compiles the current operation tree into a CompiledQuery.
Returns
CompiledQuery<number>
execute()
execute(options?): Promise<number>;Compiles and executes the query with the configured executor.
Parameters
| Parameter | Type |
|---|---|
options? | AbortableQueryOptions |
Returns
Promise<number>
executeAll()
executeAll(options?): Promise<number>;Executes with the executor's Salesforce query-all semantics.
Parameters
| Parameter | Type |
|---|---|
options? | AbortableQueryOptions |
Returns
Promise<number>
apex()
apex(): ApexCountQueryBuilder<DB, TB, "static">;Switches to the static Apex builder for the current query.
Returns
ApexCountQueryBuilder<DB, TB, "static">
dynamicApex()
dynamicApex(): ApexCountQueryBuilder<DB, TB, "dynamic">;Switches to the dynamic Apex builder for the current query.
Returns
ApexCountQueryBuilder<DB, TB, "dynamic">
limit()
limit(limit): CountQueryBuilder<DB, TB>;Adds or replaces the SOQL LIMIT clause.
Parameters
| Parameter | Type |
|---|---|
limit | number |
Returns
CountQueryBuilder<DB, TB>
forView()
forView(..._mruCheck): CountQueryBuilder<DB, TB>;Adds FOR VIEW; available only for MRU-enabled objects.
Parameters
| Parameter | Type |
|---|---|
..._mruCheck | SalesforceObjectMruEnabled<DB[TB]> extends false ? readonly [never] : readonly [] |
Returns
CountQueryBuilder<DB, TB>
forReference()
forReference(..._mruCheck): CountQueryBuilder<DB, TB>;Adds FOR REFERENCE; available only for MRU-enabled objects.
Parameters
| Parameter | Type |
|---|---|
..._mruCheck | SalesforceObjectMruEnabled<DB[TB]> extends false ? readonly [never] : readonly [] |
Returns
CountQueryBuilder<DB, TB>
updateTracking()
updateTracking(..._knowledgeArticleCheck): CountQueryBuilder<DB, TB>;Adds the KnowledgeArticle UPDATE TRACKING clause.
Parameters
| Parameter | Type |
|---|---|
..._knowledgeArticleCheck | KnowledgeArticleUpdateCheck<TB> |
Returns
CountQueryBuilder<DB, TB>
updateViewstat()
updateViewstat(..._knowledgeArticleCheck): CountQueryBuilder<DB, TB>;Adds the KnowledgeArticle UPDATE VIEWSTAT clause.
Parameters
| Parameter | Type |
|---|---|
..._knowledgeArticleCheck | KnowledgeArticleUpdateCheck<TB> |
Returns
CountQueryBuilder<DB, TB>
usingScope()
usingScope(scope): CountQueryBuilder<DB, TB>;Adds a Salesforce USING SCOPE clause validated against schema metadata.
Parameters
| Parameter | Type |
|---|---|
scope | SalesforceObjectSupportedScope<DB[TB]> |
Returns
CountQueryBuilder<DB, TB>
withUserId()
withUserId(userId, ..._userProfileFeedCheck): CountQueryBuilder<DB, TB>;Adds the UserProfileFeed WITH USER_ID clause.
Parameters
| Parameter | Type |
|---|---|
userId | string |
..._userProfileFeedCheck | UserProfileFeedWithUserIdCheck<TB> |
Returns
CountQueryBuilder<DB, TB>
withRecordVisibilityContext()
withRecordVisibilityContext(parameters): CountQueryBuilder<DB, TB>;Adds WITH RECORD_VISIBILITY_CONTEXT options.
Parameters
| Parameter | Type |
|---|---|
parameters | RecordVisibilityContextOptions |
Returns
CountQueryBuilder<DB, TB>
setOptions()
setOptions(options): CountQueryBuilder<DB, TB>;Adds object-specific Salesforce SET OPTIONS values.
Parameters
| Parameter | Type |
|---|---|
options | Data360AggregateSetOptionsFor<DB[TB]> |
Returns
CountQueryBuilder<DB, TB>
withDataCategory()
withDataCategory<Group>(
group,
selector,
categories
): CountQueryBuilder<DB, TB>;Adds a typed WITH DATA CATEGORY filter.
Type Parameters
| Type Parameter |
|---|
Group extends never |
Parameters
| Parameter | Type |
|---|---|
group | Group |
selector | DataCategorySelector |
categories | DataCategoryInput<SalesforceObjectDataCategory<DB[TB], Group>> |
Returns
CountQueryBuilder<DB, TB>
where()
Call Signature
where(expression): CountQueryBuilder<DB, TB>;Adds a typed WHERE predicate and combines it with any existing predicate using AND.
Parameters
| Parameter | Type |
|---|---|
expression | SoqlRawBuilder |
Returns
CountQueryBuilder<DB, TB>
Call Signature
where(expression): CountQueryBuilder<DB, TB>;Adds a typed WHERE predicate and combines it with any existing predicate using AND.
Parameters
| Parameter | Type |
|---|---|
expression | WhereExpressionFactory<DB, TB> |
Returns
CountQueryBuilder<DB, TB>
Call Signature
where<RE, OP, RHS>(
lhs,
op,
rhs
): CountQueryBuilder<DB, TB>;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
| Parameter | Type |
|---|---|
lhs | RE & FilterableFieldName<DB, TB, RE> |
op | OP |
rhs | RHS |
Returns
CountQueryBuilder<DB, TB>
toOperationNode()
toOperationNode(): SelectQueryNode;Returns the immutable operation node represented by this builder.