AggregateOptions Class |
Options for an aggregate operation.
Inheritance HierarchyNamespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
SyntaxThe AggregateOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AggregateOptions | Initializes a new instance of the AggregateOptions class |
Properties| Name | Description | |
|---|---|---|
 | AllowDiskUse |
Gets or sets a value indicating whether to allow disk use.
|
| BatchSize |
Gets or sets the size of a batch.
|
| BypassDocumentValidation |
Gets or sets a value indicating whether to bypass document validation.
|
| Collation |
Gets or sets the collation.
|
| Comment |
Gets or sets the comment.
|
| Hint |
Gets or sets the hint. This must either be a BsonString representing the index name or a BsonDocument representing the key pattern of the index.
|
| Let |
Gets or sets the "let" definition.
|
| MaxAwaitTime |
Gets or sets the maximum await time.
|
| MaxTime |
Gets or sets the maximum time.
|
| TranslationOptions |
Gets or sets the translation options.
|
| UseCursor | Obsolete.
Gets or sets a value indicating whether to use a cursor.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | ToBson |
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.) |
| ToBsonDocument |
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.) |
| ToJson |
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.) |
See Also