AggregationFramework

$addFields stage .

$addFields stage .

$bucket aggregation stage .

$bucket aggregation stage .

$bucket aggregation stage .

$bucket aggregation stage .

$collStats aggregation stage .

$collStats aggregation stage .

$count of the number of documents input .

$count of the number of documents input

$currentOp .

$currentOp .

$documents stage

$documents stage

$facet .

Performs $facet stage, to process multiple aggregation pipelines within a single stage on the same set of input documents.

Each sub-pipeline has its own field in the output document where its results are stored as an array of documents.

The $filter aggregation stage.

Filter companion

$geoNear aggregation stage, that outputs documents in order of nearest to farthest from a specified point.

The $graphLookup aggregation stage.

$groups documents together to calculate aggregates on document collections .

$groups documents together to calculate aggregates on document collections .

This command aggregates on arbitrary identifiers. Document fields identifier must be prefixed with $.

$groups documents together to calculate aggregates on document collections. This command aggregates on one field.

$groups documents together to calculate aggregates on document collections. This command aggregates on multiple fields, and they must be named.

$indexStats aggregation stage.

$limits the number of documents that pass through the stream.

$listLocalSessions aggregation stage.

$listSessions aggregation stage.

Performs a left outer join to an unsharded collection in the same database to filter in documents from the "joined" collection for processing .

Performs a left outer join to an unsharded collection in the same database to filter in documents from the "joined" collection for processing .

Performs an uncorrelated lookup .

Performs an uncorrelated lookup .

Filters out documents from the stream that do not match the predicate .

Filters out documents from the stream that do not match the predicate .

$merge aggregation stage.

Takes the documents returned by the aggregation pipeline and writes them to a specified collection

$planCacheStats aggregation stage.

Reshapes a document stream by renaming, adding, or removing fields. Also uses Project to create computed values or sub-objects.

Restricts the contents of the documents based on information stored in the documents themselves. http://docs.mongodb.org/manual/reference/operator/aggregation/redact/#pipe._S_redact Redact

Promotes a specified document to the top level and replaces all other fields. The operation replaces all existing fields in the input document, including the _id field. https://docs.mongodb.com/manual/reference/operator/aggregation/replaceRoot

Promotes a specified document to the top level and replaces all other fields. The operation replaces all existing fields in the input document, including the _id field. https://docs.mongodb.com/manual/reference/operator/aggregation/replaceRoot

The $replaceWith aggregation stage.

$sample aggregation stage, that randomly selects the specified number of documents from its input.

$set aggregation stage

$skips over a number of documents before passing all further documents along the stream.

$sorts the stream based on the given fields.

The $sortByCount aggregation stage.

The $sortByCount aggregation stage.

$unionWith stage

$unionWith stage

The $unset aggregation stage.

Turns a document with an array into multiple documents, one document for each element in the array. http://docs.mongodb.org/manual/reference/aggregation/unwind/#_S_unwind

The $addToSet group accumulator.

The $addToSet group accumulator.

Ascending sort order

'''EXPERIMENTAL:''' See AtlasSearch$

'''EXPERIMENTAL:''' Atlas Search (only on MongoDB Atlas)

The $avg group accumulator.

The $avg group accumulator.

Low level pipeline operator which allows to open a tailable cursor against subsequent change events of a given collection.

For common use-cases, you might prefer to use the watch operator on a collection.

'''Note:''' the target mongo instance MUST be a replica-set (even in the case of a single node deployement).

Descending sort order

The $field group accumulator.

The $field group accumulator.

Factory to declare custom call to a group function.

Represents one of the group/accumulator operators, for the $group aggregation. Operation.

The $field group accumulator.

The $field group accumulator.

The $max group accumulator.

The $max group accumulator.

The $mergeObjects group accumulator.

Keyword of metadata.

Metadata sort order.

The $min group accumulator.

The $min group accumulator.

Only for advanced user: Factory for stage not already provided in the API.

For example for { $sample: { size: 2 } }

import reactivemongo.api.bson.BSONDocument
import reactivemongo.api.bson.collection.BSONCollection

def foo(coll: BSONCollection) =
 coll.aggregateWith[BSONDocument]() { agg =>
   import agg.PipelineOperator

   List(PipelineOperator(BSONDocument(
     f"$$sample" -> BSONDocument("size" -> 2))))
 }

One of MongoDBs pipeline operators for aggregation. Sealed as these are defined in the MongoDB specifications, and clients should not have custom operators.

The $push group accumulator.

The $push group accumulator.

'''EXPERIMENTAL:''' One or at least one string with optional alternate analyzer specified in multi field

'''EXPERIMENTAL:''' Search string utilities

Returns a slice/subset of an array.

Represents that a field should be sorted on, as well as whether it should be ascending or descending.

The $stdDevPop group accumulator.

The $stdDevPop for a single field.

The $stdDevSamp group accumulator

The $stdDevSamp for a single field

The $sum group accumulator.

The `$sum: 1` group accumulator.

The $sum group accumulator.

References the score associated with the corresponding `$text` query for each matching document.

Aggregation pipeline (with at least one stage operator)