AggregateOptions

Represents available options for an aggregate call

struct AggregateOptions {

CursorInitArguments cursor;

inout(Nullable!int) batchSize();

Nullable!bool explain;

Nullable!bool allowDiskUse;

Nullable!long maxTimeMS;

Nullable!bool bypassDocumentValidation;

Nullable!ReadConcern readConcern;

Nullable!Collation collation;

Nullable!Bson hint;

Nullable!string comment;

}

Members

Functions

batchSize inout(Nullable!int) batchSize(): Specifies the initial batch size for the cursor.

Variables

allowDiskUse Nullable!bool allowDiskUse;: Enables writing to temporary files. When set to true, aggregation operations can write data to the _tmp subdirectory in the dbPath directory.
bypassDocumentValidation Nullable!bool bypassDocumentValidation;: If true, allows the write to opt-out of document level validation. This only applies when the $out or $merge stage is specified.
collation Nullable!Collation collation;: Specifies a collation.
comment Nullable!string comment;: Users can specify an arbitrary string to help trace the operation through the database profiler, currentOp, and logs.
cursor CursorInitArguments cursor;: Undocumented in source.
explain Nullable!bool explain;: Undocumented in source.
hint Nullable!Bson hint;: The index to use for the aggregation. The index is on the initial collection / view against which the aggregation is run.
maxTimeMS Nullable!long maxTimeMS;: 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.
readConcern Nullable!ReadConcern readConcern;: Specifies the read concern. Only compatible with a write stage. (e.g. $out, $merge)

See Also

https://docs.mongodb.com/manual/reference/method/db.collection.aggregate/

Meta

Source

See Implementation

Standards

https://github.com/mongodb/specifications/blob/0c6e56141c867907aacf386e0cbe56d6562a0614/source/crud/crud.rst#api

index vibe db mongo collection functions

structs