Click or drag to resize

AggregateOptions Class

Options for an aggregate operation.
Inheritance Hierarchy
SystemObject
  MongoDB.DriverAggregateOptions

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.14.0+2b37a1fe1cbdbe1a020b52b77f1197b6d77575e7
Syntax
public class AggregateOptions

The AggregateOptions type exposes the following members.

Constructors
  NameDescription
Public methodAggregateOptions
Initializes a new instance of the AggregateOptions class
Top
Properties
  NameDescription
Public propertyAllowDiskUse
Gets or sets a value indicating whether to allow disk use.
Public propertyBatchSize
Gets or sets the size of a batch.
Public propertyBypassDocumentValidation
Gets or sets a value indicating whether to bypass document validation.
Public propertyCollation
Gets or sets the collation.
Public propertyComment
Gets or sets the comment.
Public propertyHint
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.
Public propertyLet
Gets or sets the "let" definition.
Public propertyMaxAwaitTime
Gets or sets the maximum await time.
Public propertyMaxTime
Gets or sets the maximum time.
Public propertyTranslationOptions
Gets or sets the translation options.
Public propertyUseCursor Obsolete.
Gets or sets a value indicating whether to use a cursor.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also