AggregateQuery

AggregateQuery

A query that calculates aggregations over an underlying query.

Constructor

new AggregateQuery(_query, _aggregates)

Parameters:
Name Type Description
_query

The query whose aggregations will be calculated by this object.

_aggregates

The aggregations that will be performed by this query.

Members

query

The query whose aggregations will be calculated by this object.

Methods

(async) explain()

Plans and optionally executes this query. Returns a Promise that will be resolved with the planner information, statistics from the query execution (if any), and the query results (if any).

Returns:
Type Description

A Promise that will be resolved with the planner information, statistics from the query execution (if any), and the query results (if any).

(async) get()

Executes this query.

Returns:
Type Description

A promise that will be resolved with the results of the query.

isEqual(other)

Compares this object with the given object for equality.

This object is considered "equal" to the other object if and only if other performs the same aggregations as this AggregateQuery and the underlying Query of other compares equal to that of this object using Query.isEqual().

Parameters:
Name Type Description
other

The object to compare to this object for equality.

Returns:
Type Description

true if this object is "equal" to the given object, as defined above, or false otherwise.