AggregateField

AggregateField

An AggregateField is a class that contains data that defines an aggregation.

Constructor

new AggregateField()

Methods

alias(alias) → {AggregateField}

Sets the alias on the aggregate field that should be used.

Parameters:
Name Type Description
alias string

The label used in the results to describe this aggregate field when a query is run.

Returns:
Type Description
AggregateField

(static) average() → {Average}

Gets a copy of the Average aggregate field.

Returns:
Type Description
Average

(static) count() → {Count}

Gets a copy of the Count aggregate field.

Returns:
Type Description
Count

(static) sum() → {Sum}

Gets a copy of the Sum aggregate field.

Returns:
Type Description
Sum