AggregateOptions Class (original) (raw)

Options for an aggregate operation.

Inheritance Hierarchy

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed

Syntax

public class AggregateOptions

Public Class AggregateOptions

type AggregateOptions = class end

The AggregateOptions type exposes the following members.

Constructors

| | Name | Description | | | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -------------------------------------------------------- | | Public method | AggregateOptions | Initializes a new instance of the AggregateOptions class |

Top

Properties

| | Name | Description | | | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | Public property | AllowDiskUse | Gets or sets a value indicating whether to allow disk use. | | Public property | BatchSize | Gets or sets the size of a batch. | | Public property | BypassDocumentValidation | Gets or sets a value indicating whether to bypass document validation. | | Public property | Collation | Gets or sets the collation. | | Public property | Comment | Gets or sets the comment. | | Public property | 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. | | Public property | MaxAwaitTime | Gets or sets the maximum await time. | | Public property | MaxTime | Gets or sets the maximum time. | | Public property | TranslationOptions | Gets or sets the translation options. | | Public property | UseCursor | Gets or sets a value indicating whether to use a cursor. |

Top

Methods

| | Name | Description | | | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Public method | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | | Protected method | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | | Public method | GetHashCode | Serves as the default hash function. (Inherited from Object.) | | Public method | GetType | Gets the Type of the current instance. (Inherited from Object.) | | Protected method | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | | Public method | ToString | Returns a string that represents the current object. (Inherited from Object.) |

Top

Extension Methods

See Also

Reference