AggregateOperation class

Collection is the collection on which the operation is performed In case of admin/diagnostic pipeline which does not require an underlying collection, the db parameter must be passed instead.

Constructors

AggregateOperation(Object pipeline, {DbCollection? collection, Db? db, bool? explain, Map<String, Object>? cursor, String? hint, Map<String, Object>? hintDocument, AggregateOptions? aggregateOptions, Map<String, Object>? rawOptions})

Properties

canRetryRead → bool
no setterinherited
collection ↔ DbCollection?
getter/setter pairinherited
command ↔ Map<String, Object>?
getter/setter pairinherited
connection ↔ Connection?
getter/setter pairinherited
cursor ↔ Map<String, Object>
Specify a document that contains options that control the creation of the cursor object.
getter/setter pair
db ↔ Db
getter/setter pairinherited
explain ↔ bool
Specifies to return the information on the processing of the pipeline.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
hint ↔ String?
Optional. Index specification. Specify either the index name as a string (hint field) or the index key pattern (hintDocument field). If specified, then the query system will only consider plans using the hinted index. starting in MongoDB 4.2, with the following exception, hint is required if the command includes the min and/or max fields; hint is not required with min and/or max if the filter is an equality condition on the _id field { _id:
getter/setter pair
hintDocument ↔ Map<String, Object>?
getter/setter pair
options ↔ Map<String, Object>
getter/setter pairinherited
pipeline ↔ List<Map<String, Object>>
An array of aggregation pipeline stages that process and transform the document stream as part of the aggregation pipeline.
getter/setter pair
readPreference ↔ ReadPreference?
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
session ↔ Object?
getter/setter pairinherited

Methods

$buildCommand() → Map<String, Object>
clearSession() → void
inherited
execute({bool skipStateCheck = false}) → Future<Map<String, dynamic>>
inherited
executeDocument() → Future<AggregateResult>
hasAspect(Aspect aspect) → bool
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
processOptions(Map<String, dynamic> command) → void
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited