Class Aggregators

Simple Aggregator DSL.

Remarks

The methods in this class are for the most part simple factory methods for various EntryAggregator classes, but in some cases provide additional type safety. They also tend to make the code more readable, especially if imported statically, so their use is strongly encouraged in lieu of direct construction of EntryAggregator classes.

Hierarchy

Aggregators

Index

Constructors

constructor

Methods

average count distinct groupBy max min priority record reduce script sum top

Constructors

constructor

new Aggregators(): Aggregators
Returns Aggregators

Methods

`Static` average

average<K, V>(extractorOrProperty: string | ValueExtractor): EntryAggregator<K, V, number>
Return an aggregator that calculates a average of the numeric values extracted from a set of entries in a Map.

Returns
an aggregator that calculates a average of the numeric values extracted from a set of entries in a Map
Type Parameters
- K = any
  
  the type of the entry's key
- V = any
  
  the type of the entry's value
Parameters
- extractorOrProperty: string | ValueExtractor
  
  the extractor or method/property name to provide values for aggregation
Returns EntryAggregator<K, V, number>

`Static` count

count<K, V>(): EntryAggregator<K, V, number>
Return an aggregator that calculates a number of values in an entry set.

Returns
an aggregator that calculates a number of values in an entry set
Type Parameters
- K = any
  
  the type of the entry's key
- V = any
  
  the type of the entry's value
Returns EntryAggregator<K, V, number>

`Static` distinct

distinct<K, V>(extractorOrProperty: string | ValueExtractor): EntryAggregator<K, V, number>
Return an aggregator that calculates the set of distinct values from the entries in a Map.

Returns
an aggregator that calculates the set of distinct values from the entries in a Map
Type Parameters
- K = any
- V = any
Parameters
- extractorOrProperty: string | ValueExtractor
  
  the extractor or method/property name to provide values for aggregation
Returns EntryAggregator<K, V, number>

`Static` groupBy

groupBy<K, V, T, E, R>(extractorOrProperty: string | ValueExtractor, agg: EntryAggregator<K, V, T>, filter: Filter): EntryAggregator<K, V, Map<E, R>>
Return a GroupAggregator based on a specified property or method name(s) and an EntryAggregator.

Returns
a new GroupAggregator
Type Parameters
- K = any
  
  the type of the Map entry keys
- V = any
  
  the type of the Map entry values
- T = any
  
  the type of the value to extract from
- E = any
  
  the type of the extracted value
- R = any
  
  the type of the group aggregator result
Parameters
- extractorOrProperty: string | ValueExtractor
  
  the extractor or method/property name to provide values for aggregation
- agg: EntryAggregator<K, V, T>
  
  an underlying EntryAggregator
- filter: Filter
  
  an optional Filter object used to filter out results of individual group aggregation results
Returns EntryAggregator<K, V, Map<E, R>>

`Static` max

max(extractorOrProperty: string | ValueExtractor): MaxAggregator
Return an aggregator that calculates a maximum of the numeric values extracted from a set of entries in a Map.

Returns
an aggregator that calculates a maximum of the numeric values extracted from a set of entries in a Map
Parameters
- extractorOrProperty: string | ValueExtractor
  
  the extractor or method/property name to provide values for aggregation
Returns MaxAggregator

`Static` min

min<K, V>(extractorOrProperty: string | ValueExtractor): EntryAggregator<K, V, number>
Return an aggregator that calculates a minimum of the numeric values extracted from a set of entries in a Map.

Returns
an aggregator that calculates a minimum of the numeric values extracted from a set of entries in a Map
Type Parameters
- K = any
  
  the type of the entry's key
- V = any
  
  the type of the entry's value
Parameters
- extractorOrProperty: string | ValueExtractor
  
  the extractor or method/property name to provide values for aggregation
Returns EntryAggregator<K, V, number>

`Static` priority

priority<K, V, R>(agg: EntryAggregator<K, V, R>, schedulingPriority?: Schedule, executionTimeout?: number, requestTimeout?: number): PriorityAggregator<K, V, R>
Return a new PriorityAggregator to control scheduling priority of an aggregation operation.
Type Parameters
- K = any
  
  the type of the Map entry keys
- V = any
  
  the type of the Map entry values
- R = any
  
  the type of the final result
Parameters
- agg: EntryAggregator<K, V, R>
  
  the underlying EntryAggregator
- schedulingPriority: Schedule = aggregator.Schedule.STANDARD
  
  the schedule priority
- executionTimeout: number = aggregator.Timeout.DEFAULT
  
  the execution timeout
- requestTimeout: number = aggregator.Timeout.DEFAULT
  
  the request timeout
Returns PriorityAggregator<K, V, R>

`Static` record

record<K, V>(type?: RecordType): QueryRecorder<K, V>
Returns a new QueryRecorder aggregator which may be used is used to produce an object that contains an estimated or actual cost of the query execution for a given Filter.

Returns
a new QueryRecorder aggregator which may be used is used to produce an object that contains an estimated or actual cost of the query execution for a given Filter
Type Parameters
- K = any
  
  the type of the Map entry keys
- V = any
  
  the type of the Map entry values
Parameters
- type: RecordType = aggregator.RecordType.EXPLAIN
  
  the RecordType
Returns QueryRecorder<K, V>

`Static` reduce

reduce<K, V, E, R>(extractorOrProperty: string | ValueExtractor): ReducerAggregator<K, V, Map<K, E>>
Return an aggregator that will return the extracted value for each entry in the map.
Type Parameters
- K = any
  
  the type of the Map entry keys
- V = any
  
  the type of the Map entry values
- E = any
  
  extracted value type
- R = any
  
  the type of the group aggregator result
Parameters
- extractorOrProperty: string | ValueExtractor
  
  the extractor or method/property name to provide values for aggregation
Returns ReducerAggregator<K, V, Map<K, E>>

`Static` script

script<K, V, R>(language: string, name: string, args: any[]): ScriptAggregator<K, V, R>
Return an aggregator that is implemented in a script using the specified language.

Returns
an aggregator that is implemented in a script using the specified language
Type Parameters
- K = any
  
  the type of the Map entry keys
- V = any
  
  the type of the Map entry values
- R = any
  
  the type of the group aggregator result
Parameters
- language: string
  
  the string specifying one of the supported languages
- name: string
  
  the aggregator name
- args: any[]
  
  arguments to pass to the aggregator
Returns ScriptAggregator<K, V, R>

`Static` sum

sum(extractorOrProperty: string | ValueExtractor): SumAggregator
Return an aggregator that calculates a sum of the numeric values extracted from a set of entries in a Map.

Returns
an aggregator that calculates a sum of the numeric values extracted from a set of entries in a Map
Parameters
- extractorOrProperty: string | ValueExtractor
  
  the extractor or method/property name to provide values for aggregation
Returns SumAggregator

`Static` top

top<K, V, R>(count: number): TopAggregator<K, V, R>
Return an aggregator that aggregates the top N extracted values into an array.
Type Parameters
- K
- V
- R
Parameters
- count: number
  
  the maximum number of results to include in the aggregation result
Returns TopAggregator<K, V, R>

Class Aggregators

Remarks

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns Aggregators

Methods

Static average

Returns

Type Parameters

K = any

V = any

Parameters

extractorOrProperty: string | ValueExtractor

Returns EntryAggregator<K, V, number>

Static count

Returns

Type Parameters

K = any

V = any

Returns EntryAggregator<K, V, number>

Static distinct

Returns

Type Parameters

K = any

V = any

Parameters

extractorOrProperty: string | ValueExtractor

Returns EntryAggregator<K, V, number>

Static groupBy

Returns

Type Parameters

K = any

V = any

T = any

E = any

R = any

Parameters

extractorOrProperty: string | ValueExtractor

agg: EntryAggregator<K, V, T>

filter: Filter

Returns EntryAggregator<K, V, Map<E, R>>

Static max

Returns

Parameters

extractorOrProperty: string | ValueExtractor

Returns MaxAggregator

Static min

Returns

Type Parameters

K = any

V = any

Parameters

extractorOrProperty: string | ValueExtractor

Returns EntryAggregator<K, V, number>

Static priority

Type Parameters

K = any

V = any

R = any

Parameters

agg: EntryAggregator<K, V, R>

schedulingPriority: Schedule = aggregator.Schedule.STANDARD

executionTimeout: number = aggregator.Timeout.DEFAULT

requestTimeout: number = aggregator.Timeout.DEFAULT

Returns PriorityAggregator<K, V, R>

Static record

Returns

Type Parameters

K = any

V = any

Parameters

type: RecordType = aggregator.RecordType.EXPLAIN

Returns QueryRecorder<K, V>

Static reduce

Type Parameters

K = any

`Static` average

`Static` count

`Static` distinct

`Static` groupBy

`Static` max

`Static` min

`Static` priority

`Static` record

`Static` reduce

`Static` script

`Static` sum

`Static` top