| |
read source history
aggregate()
MongoDB Driver Function Reference
Runs an (admin/diagnostic) aggregation that does not require a collection.
More information can be found in the corresponding entry of the MongoDB Manual.
db.aggregate([<pipeline>[, <options>]])
|
Arguments
<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.aggregate([{ $currentOp : { allUsers: true, idleConnections: true } }, { $match : { shard: "shard01" } }]);
|
Runs the currentOp operation and filters the results.
home | MongoDB Driver Function Reference | MongoDB Driver
|