Kysoql
ReferenceAPI referenceInterfaces

SelectFunctionModule

Generated API reference for SelectFunctionModule in @kysoql/core.

@kysoql/core / SelectFunctionModule

Scalar, aggregate, date, and geolocation helpers exposed to SELECT callbacks.

Extends

Type Parameters

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

Methods

convertCurrency()

convertCurrency<Reference>(field): ConvertCurrencyFunctionBuilder<ConvertCurrencyOutput<DB, TB, Reference>>;

Builds a Salesforce convertCurrency(...) expression.

Type Parameters

Type Parameter
Reference extends string

Parameters

ParameterType
fieldReference & CurrencyFieldReference<DB, TB, Reference>

Returns

ConvertCurrencyFunctionBuilder<ConvertCurrencyOutput<DB, TB, Reference>>

format()

Call Signature

format<Reference>(field): FormatFunctionBuilder<FormatOutput<DB, TB, Reference>>;

Builds a Salesforce FORMAT(...) expression.

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

FormatFunctionBuilder<FormatOutput<DB, TB, Reference>>

Call Signature

format<Output>(expression): FormatFunctionBuilder<NestedFormatOutput<Output>>;

Builds a Salesforce FORMAT(...) expression.

Type Parameters
Type Parameter
Output
Parameters
ParameterType
expressionConvertCurrencyFunctionBuilder<Output>
Returns

FormatFunctionBuilder<NestedFormatOutput<Output>>

Call Signature

format<Output, ComparisonValue, Operator>(expression): AggregateFormatFunctionBuilder<NestedFormatOutput<Output>>;

Builds a Salesforce FORMAT(...) expression.

Type Parameters
Type Parameter
Output
ComparisonValue
Operator extends ComparisonOperator
Parameters
ParameterType
expressionFormattableAggregateFunctionBuilder<Output, ComparisonValue, Operator>
Returns

AggregateFormatFunctionBuilder<NestedFormatOutput<Output>>

toLabel()

toLabel<Reference>(field): ToLabelFunctionBuilder<ToLabelOutput<DB, TB, Reference>>;

Builds a Salesforce toLabel(...) expression.

Type Parameters

Type Parameter
Reference extends string

Parameters

ParameterType
fieldReference & TranslatableFieldReference<DB, TB, Reference>

Returns

ToLabelFunctionBuilder<ToLabelOutput<DB, TB, Reference>>

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>

Inherited from

AggregateFunctionModule.calendarMonth

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>

Inherited from

AggregateFunctionModule.calendarQuarter

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>

Inherited from

AggregateFunctionModule.calendarYear

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>

Inherited from

AggregateFunctionModule.dayInMonth

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>

Inherited from

AggregateFunctionModule.dayInWeek

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>

Inherited from

AggregateFunctionModule.dayInYear

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>

Inherited from

AggregateFunctionModule.dayOnly

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>

Inherited from

AggregateFunctionModule.fiscalMonth

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>

Inherited from

AggregateFunctionModule.fiscalQuarter

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>

Inherited from

AggregateFunctionModule.fiscalYear

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>

Inherited from

AggregateFunctionModule.hourInDay

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>

Inherited from

AggregateFunctionModule.weekInMonth

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>

Inherited from

AggregateFunctionModule.weekInYear

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>

Inherited from

AggregateFunctionModule.convertTimezone

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

Inherited from

AggregateFunctionModule.grouping

count()

Call Signature

count(): CountAllFunctionBuilder;

Builds a Salesforce COUNT aggregate expression.

Returns

CountAllFunctionBuilder

Inherited from

AggregateFunctionModule.count

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>

Inherited from

AggregateFunctionModule.count

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>

Inherited from

AggregateFunctionModule.countDistinct

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>

Inherited from

AggregateFunctionModule.avg

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>>

Inherited from

AggregateFunctionModule.max

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>>

Inherited from

AggregateFunctionModule.min

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>

Inherited from

AggregateFunctionModule.sum

geolocation()

geolocation(latitude, longitude): GeolocationFunctionBuilder;

Builds a Salesforce GEOLOCATION(latitude, longitude) expression.

Parameters

ParameterType
latitudenumber
longitudenumber

Returns

GeolocationFunctionBuilder

Inherited from

GeolocationFunctionModule.geolocation

distance()

Call Signature

distance<First>(
   location,
   destination,
   unit
): DistanceFunctionBuilder<DistanceLiteralOutput<DB, TB, First>, ReferenceFilterable<DB, TB, First>, ReferenceSortable<DB, TB, First>>;

Builds a typed Salesforce DISTANCE(...) expression.

Type Parameters
Type Parameter
First extends string
Parameters
ParameterType
locationFirst & LocationFieldReference<DB, TB, First>
destinationGeolocationFunctionBuilder
unitDistanceUnit
Returns

DistanceFunctionBuilder<DistanceLiteralOutput<DB, TB, First>, ReferenceFilterable<DB, TB, First>, ReferenceSortable<DB, TB, First>>

Inherited from

GeolocationFunctionModule.distance

Call Signature

distance<First, Second>(
   location,
   destination,
   unit
): DistanceFunctionBuilder<DistanceFieldOutput<DB, TB, First, Second>, BothTrue<ReferenceFilterable<DB, TB, First>, ReferenceFilterable<DB, TB, Second>>, BothTrue<ReferenceSortable<DB, TB, First>, ReferenceSortable<DB, TB, Second>>>;

Builds a typed Salesforce DISTANCE(...) expression.

Type Parameters
Type Parameter
First extends string
Second extends string
Parameters
ParameterType
locationFirst & LocationFieldReference<DB, TB, First>
destinationSecond & LocationFieldReference<DB, TB, Second>
unitDistanceUnit
Returns

DistanceFunctionBuilder<DistanceFieldOutput<DB, TB, First, Second>, BothTrue<ReferenceFilterable<DB, TB, First>, ReferenceFilterable<DB, TB, Second>>, BothTrue<ReferenceSortable<DB, TB, First>, ReferenceSortable<DB, TB, Second>>>

Inherited from

GeolocationFunctionModule.distance

SelectExpressionBuilder

Generated API reference for SelectExpressionBuilder in @kysoql/core.

SelectionNode

Generated API reference for SelectionNode in @kysoql/core.

On this page

ExtendsType ParametersMethodsconvertCurrency()Type ParametersParametersReturnsformat()Call SignatureCall SignatureCall SignaturetoLabel()Type ParametersParametersReturnscalendarMonth()Type ParametersParametersReturnsInherited fromcalendarQuarter()Type ParametersParametersReturnsInherited fromcalendarYear()Type ParametersParametersReturnsInherited fromdayInMonth()Type ParametersParametersReturnsInherited fromdayInWeek()Type ParametersParametersReturnsInherited fromdayInYear()Type ParametersParametersReturnsInherited fromdayOnly()Type ParametersParametersReturnsInherited fromfiscalMonth()Type ParametersParametersReturnsInherited fromfiscalQuarter()Type ParametersParametersReturnsInherited fromfiscalYear()Type ParametersParametersReturnsInherited fromhourInDay()Type ParametersParametersReturnsInherited fromweekInMonth()Type ParametersParametersReturnsInherited fromweekInYear()Type ParametersParametersReturnsInherited fromconvertTimezone()Type ParametersParametersReturnsInherited fromgrouping()Type ParametersParametersReturnsInherited fromcount()Call SignatureCall SignaturecountDistinct()Type ParametersParametersReturnsInherited fromavg()Type ParametersParametersReturnsInherited frommax()Type ParametersParametersReturnsInherited frommin()Type ParametersParametersReturnsInherited fromsum()Type ParametersParametersReturnsInherited fromgeolocation()ParametersReturnsInherited fromdistance()Call SignatureCall Signature