Struct AggregateOptions

Represents available options for an aggregate call


							
					struct AggregateOptions
					;

Fields

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

Name	Type	Description
`batchSize`[get]	`inout(std.typecons.Nullable!(int))`	Specifies the initial batch size for the cursor.

Authors	Sönke Ludwig
Copyright	© 2012-2016 Sönke Ludwig
License	Subject to the terms of the MIT license, as written in the included LICENSE.txt file.