AggregateOptions class

Implementers

• ChangeStreamOptions

Constructors

AggregateOptions({bool allowDiskUse = false, int? maxTimeMS, bool bypassDocumentValidation = false, ReadConcern? readConcern, CollationOptions? collation, String? comment, WriteConcern? writeConcern})

Properties

allowDiskUse ↔ bool

Enables writing to temporary files. When set to true, a ggregation stages can write data to the _tmp subdirectory in the dbPath directory.

getter/setter pair

bypassDocumentValidation ↔ bool

Applicable only if you specify the $out or $merge aggregation stages. Enables aggregate to bypass document validation during the operation. This lets you insert documents that do not meet the validation requirements.

getter/setter pair

collation → CollationOptions?

Specifies the collation to use for the operation. Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. See Collation document

final

comment → String?

A user-provided comment to attach to this command. Once set, this comment appears alongside records of this command in the following locations:

final

hashCode → int

The hash code for this object.

no setter, inherited

maxTimeMS → int?

Specifies a time limit in milliseconds for processing operations on a cursor. If you do not specify a value for maxTimeMS, operations will not time out. A value of 0 explicitly specifies the default unbounded behavior.

final

readConcern → ReadConcern?

Starting in MongoDB 3.6, the readConcern option has the following syntax: readConcern: { level:

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

writeConcern → WriteConcern?

A document that expresses the write concern to use with the $out or $merge stage.

final

Methods

getOptions(Db? db) → Map<String, Object>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited