Kysoql
ReferenceAPI referenceInterfaces

AggregateFunctionModule

Generated API reference for AggregateFunctionModule in @kysoql/core.

@kysoql/core / AggregateFunctionModule

Aggregate and date-function helpers exposed to expression callbacks.

Extended by

Type Parameters

Type ParameterDefault type
DB-
TB extends keyof DB-
GroupingFields extends stringnever

Methods

calendarMonth()

calendarMonth<Input>(field): NumericDateFunctionBuilder<DB, TB, "calendarMonth", Input>;

Builds CALENDAR_MONTH(...) for a date or datetime field.

Type Parameters

Type Parameter
Input extends DateFunctionInput

Parameters

ParameterType
fieldInput & DateFunctionArgument<DB, TB, Input, TemporalSalesforceType>

Returns

NumericDateFunctionBuilder<DB, TB, "calendarMonth", Input>

calendarQuarter()

calendarQuarter<Input>(field): NumericDateFunctionBuilder<DB, TB, "calendarQuarter", Input>;

Builds CALENDAR_QUARTER(...) for a date or datetime field.

Type Parameters

Type Parameter
Input extends DateFunctionInput

Parameters

ParameterType
fieldInput & DateFunctionArgument<DB, TB, Input, TemporalSalesforceType>

Returns

NumericDateFunctionBuilder<DB, TB, "calendarQuarter", Input>

calendarYear()

calendarYear<Input>(field): NumericDateFunctionBuilder<DB, TB, "calendarYear", Input>;

Builds CALENDAR_YEAR(...) for a date or datetime field.

Type Parameters

Type Parameter
Input extends DateFunctionInput

Parameters

ParameterType
fieldInput & DateFunctionArgument<DB, TB, Input, TemporalSalesforceType>

Returns

NumericDateFunctionBuilder<DB, TB, "calendarYear", Input>

dayInMonth()

dayInMonth<Input>(field): NumericDateFunctionBuilder<DB, TB, "dayInMonth", Input>;

Builds DAY_IN_MONTH(...) for a date or datetime field.

Type Parameters

Type Parameter
Input extends DateFunctionInput

Parameters

ParameterType
fieldInput & DateFunctionArgument<DB, TB, Input, TemporalSalesforceType>

Returns

NumericDateFunctionBuilder<DB, TB, "dayInMonth", Input>

dayInWeek()

dayInWeek<Input>(field): NumericDateFunctionBuilder<DB, TB, "dayInWeek", Input>;

Builds DAY_IN_WEEK(...) for a date or datetime field.

Type Parameters

Type Parameter
Input extends DateFunctionInput

Parameters

ParameterType
fieldInput & DateFunctionArgument<DB, TB, Input, TemporalSalesforceType>

Returns

NumericDateFunctionBuilder<DB, TB, "dayInWeek", Input>

dayInYear()

dayInYear<Input>(field): NumericDateFunctionBuilder<DB, TB, "dayInYear", Input>;

Builds DAY_IN_YEAR(...) for a date or datetime field.

Type Parameters

Type Parameter
Input extends DateFunctionInput

Parameters

ParameterType
fieldInput & DateFunctionArgument<DB, TB, Input, TemporalSalesforceType>

Returns

NumericDateFunctionBuilder<DB, TB, "dayInYear", Input>

dayOnly()

dayOnly<Input>(field): DayOnlyFunctionBuilder<DB, TB, Input>;

Builds DAY_ONLY(...) for a datetime field.

Type Parameters

Type Parameter
Input extends DateFunctionInput

Parameters

ParameterType
fieldInput & DateFunctionArgument<DB, TB, Input, "datetime">

Returns

DayOnlyFunctionBuilder<DB, TB, Input>

fiscalMonth()

fiscalMonth<Input>(field): NumericDateFunctionBuilder<DB, TB, "fiscalMonth", Input>;

Builds FISCAL_MONTH(...) for a date or datetime field.

Type Parameters

Type Parameter
Input extends DateFunctionInput

Parameters

ParameterType
fieldInput & DateFunctionArgument<DB, TB, Input, TemporalSalesforceType>

Returns

NumericDateFunctionBuilder<DB, TB, "fiscalMonth", Input>

fiscalQuarter()

fiscalQuarter<Input>(field): NumericDateFunctionBuilder<DB, TB, "fiscalQuarter", Input>;

Builds FISCAL_QUARTER(...) for a date or datetime field.

Type Parameters

Type Parameter
Input extends DateFunctionInput

Parameters

ParameterType
fieldInput & DateFunctionArgument<DB, TB, Input, TemporalSalesforceType>

Returns

NumericDateFunctionBuilder<DB, TB, "fiscalQuarter", Input>

fiscalYear()

fiscalYear<Input>(field): NumericDateFunctionBuilder<DB, TB, "fiscalYear", Input>;

Builds FISCAL_YEAR(...) for a date or datetime field.

Type Parameters

Type Parameter
Input extends DateFunctionInput

Parameters

ParameterType
fieldInput & DateFunctionArgument<DB, TB, Input, TemporalSalesforceType>

Returns

NumericDateFunctionBuilder<DB, TB, "fiscalYear", Input>

hourInDay()

hourInDay<Input>(field): NumericDateFunctionBuilder<DB, TB, "hourInDay", Input>;

Builds HOUR_IN_DAY(...) for a datetime field.

Type Parameters

Type Parameter
Input extends DateFunctionInput

Parameters

ParameterType
fieldInput & DateFunctionArgument<DB, TB, Input, "datetime">

Returns

NumericDateFunctionBuilder<DB, TB, "hourInDay", Input>

weekInMonth()

weekInMonth<Input>(field): NumericDateFunctionBuilder<DB, TB, "weekInMonth", Input>;

Builds WEEK_IN_MONTH(...) for a date or datetime field.

Type Parameters

Type Parameter
Input extends DateFunctionInput

Parameters

ParameterType
fieldInput & DateFunctionArgument<DB, TB, Input, TemporalSalesforceType>

Returns

NumericDateFunctionBuilder<DB, TB, "weekInMonth", Input>

weekInYear()

weekInYear<Input>(field): NumericDateFunctionBuilder<DB, TB, "weekInYear", Input>;

Builds WEEK_IN_YEAR(...) for a date or datetime field.

Type Parameters

Type Parameter
Input extends DateFunctionInput

Parameters

ParameterType
fieldInput & DateFunctionArgument<DB, TB, Input, TemporalSalesforceType>

Returns

NumericDateFunctionBuilder<DB, TB, "weekInYear", Input>

convertTimezone()

convertTimezone<Reference>(field): ConvertTimezoneFunctionBuilder<Reference>;

Builds a Salesforce convertTimezone(...) expression.

Type Parameters

Type Parameter
Reference extends string

Parameters

ParameterType
fieldReference & DateGroupableFieldReference<DB, TB, Reference, "datetime">

Returns

ConvertTimezoneFunctionBuilder<Reference>

grouping()

grouping<Reference>(field): GroupingFunctionBuilder;

Builds a Salesforce GROUPING(...) aggregate expression.

Type Parameters

Type Parameter
Reference extends string

Parameters

ParameterType
fieldReference & GroupingFieldReference<DB, TB, GroupingFields, Reference>

Returns

GroupingFunctionBuilder

count()

Call Signature

count(): CountAllFunctionBuilder;

Builds a Salesforce COUNT aggregate expression.

Returns

CountAllFunctionBuilder

Call Signature

count<Reference>(field): AggregateFunctionBuilder<number, number, NumericAggregateOperator>;

Builds a Salesforce COUNT aggregate expression.

Type Parameters
Type Parameter
Reference extends string
Parameters
ParameterType
fieldReference & AggregatableFieldReference<DB, TB, Reference>
Returns

AggregateFunctionBuilder<number, number, NumericAggregateOperator>

countDistinct()

countDistinct<Reference>(field): AggregateFunctionBuilder<number, number, NumericAggregateOperator>;

Builds a Salesforce COUNT_DISTINCT(...) expression.

Type Parameters

Type Parameter
Reference extends string

Parameters

ParameterType
fieldReference & AggregatableFieldReference<DB, TB, Reference>

Returns

AggregateFunctionBuilder<number, number, NumericAggregateOperator>

avg()

avg<Reference>(field): AggregateFunctionBuilder<number | null, number | null, NumericAggregateOperator>;

Builds a Salesforce AVG(...) aggregate expression.

Type Parameters

Type Parameter
Reference extends string

Parameters

ParameterType
fieldReference & NumericAggregatableFieldReference<DB, TB, Reference>

Returns

AggregateFunctionBuilder<number | null, number | null, NumericAggregateOperator>

max()

max<Reference>(field): AggregateFunctionBuilder<AggregateFieldValue<DB, TB, Reference>, SalesforceFieldFilterValue<FieldReferenceDefinition<DB, TB, Reference, readonly []>>, ComparisonOperatorExpression<DB, TB, Reference>>;

Builds a Salesforce MAX(...) aggregate expression.

Type Parameters

Type Parameter
Reference extends string

Parameters

ParameterType
fieldReference & AggregatableFieldReference<DB, TB, Reference>

Returns

AggregateFunctionBuilder<AggregateFieldValue<DB, TB, Reference>, SalesforceFieldFilterValue<FieldReferenceDefinition<DB, TB, Reference, readonly []>>, ComparisonOperatorExpression<DB, TB, Reference>>

min()

min<Reference>(field): AggregateFunctionBuilder<AggregateFieldValue<DB, TB, Reference>, SalesforceFieldFilterValue<FieldReferenceDefinition<DB, TB, Reference, readonly []>>, ComparisonOperatorExpression<DB, TB, Reference>>;

Builds a Salesforce MIN(...) aggregate expression.

Type Parameters

Type Parameter
Reference extends string

Parameters

ParameterType
fieldReference & AggregatableFieldReference<DB, TB, Reference>

Returns

AggregateFunctionBuilder<AggregateFieldValue<DB, TB, Reference>, SalesforceFieldFilterValue<FieldReferenceDefinition<DB, TB, Reference, readonly []>>, ComparisonOperatorExpression<DB, TB, Reference>>

sum()

sum<Reference>(field): AggregateFunctionBuilder<number | null, number | null, NumericAggregateOperator>;

Builds a Salesforce SUM(...) aggregate expression.

Type Parameters

Type Parameter
Reference extends string

Parameters

ParameterType
fieldReference & NumericAggregatableFieldReference<DB, TB, Reference>

Returns

AggregateFunctionBuilder<number | null, number | null, NumericAggregateOperator>

AggregateFunctionExpression

Generated API reference for AggregateFunctionExpression in @kysoql/core.

AggregateFunctionNode

Generated API reference for AggregateFunctionNode in @kysoql/core.

On this page

Extended byType ParametersMethodscalendarMonth()Type ParametersParametersReturnscalendarQuarter()Type ParametersParametersReturnscalendarYear()Type ParametersParametersReturnsdayInMonth()Type ParametersParametersReturnsdayInWeek()Type ParametersParametersReturnsdayInYear()Type ParametersParametersReturnsdayOnly()Type ParametersParametersReturnsfiscalMonth()Type ParametersParametersReturnsfiscalQuarter()Type ParametersParametersReturnsfiscalYear()Type ParametersParametersReturnshourInDay()Type ParametersParametersReturnsweekInMonth()Type ParametersParametersReturnsweekInYear()Type ParametersParametersReturnsconvertTimezone()Type ParametersParametersReturnsgrouping()Type ParametersParametersReturnscount()Call SignatureCall SignaturecountDistinct()Type ParametersParametersReturnsavg()Type ParametersParametersReturnsmax()Type ParametersParametersReturnsmin()Type ParametersParametersReturnssum()Type ParametersParametersReturns