vibe.d beta banner
get vibe.d
0.8.4

Asynchronous I/O that doesn’t get in your way, written in D

Struct AggregateOptions

Represents available options for an aggregate call

struct AggregateOptions ;

Fields

NameTypeDescription
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)Available only if you specify the $out aggregation operator.
collation std.typecons.Nullable!(vibe.db.mongo.collection.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 CursorInitArgumentsSpecifies the initial batch size for the cursor.
explain std.typecons.Nullable!(bool)Specifies to return the information on the processing of the pipeline.
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!(uint)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.

See Also

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

Authors

Sönke Ludwig

Copyright

© 2012-2016 RejectedSoftware e.K.

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.