aggregate()

MongoDB Driver Function Reference

Runs an aggregation on a collection and retrieves the results.
More information can be found in the corresponding entry of the MongoDB Manual.

<collection>.aggregate([<pipeline>[, <options>]])

Arguments

<collection>		The target collection.
<pipeline>		An array of BSON documents specifying the aggregation pipline.
<options>		A BOSN document specifying options.

Options

{ allowDiskUse: <boolean>, batchSize: <int>, comment: <string>, maxAwaitTime: <long>,
collation: <document>, hint: <document>, bypass }

allowDiskUse		Allows to write to disk while executing.
batchSize		Sets the batch size.
bypassDocumentValidation		Document validation will be bypassed (default; false),
comment		Sets the comment.
maxAwaitTime		Sets the maximum await time (in milliseconds).
collation		A document specifying the collation.
hint		A document specifying a hint.

Return Value

Returns a result set (cursor).

Example

db.employees.aggregate([{ $match: {salary: { $gt: 1000000 }}}]);

Returns the aggregated documents.

home | MongoDB Driver Function Reference | MongoDB Driver