Class AggregateOptions

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

Options for an aggregate operation.

public class AggregateOptions

Inheritance

object

AggregateOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllowDiskUse

Gets or sets a value indicating whether to allow disk use.

public bool? AllowDiskUse { get; set; }

Property Value

bool?

BatchSize

Gets or sets the size of a batch.

public int? BatchSize { get; set; }

Property Value

int?

BypassDocumentValidation

Gets or sets a value indicating whether to bypass document validation.

public bool? BypassDocumentValidation { get; set; }

Property Value

bool?

Collation

Gets or sets the collation.

public Collation Collation { get; set; }

Property Value

Collation

Comment

Gets or sets the comment.

public BsonValue Comment { get; set; }

Property Value

BsonValue

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 BsonValue Hint { get; set; }

Property Value

BsonValue

Let

Gets or sets the "let" definition.

public BsonDocument Let { get; set; }

Property Value

BsonDocument

MaxAwaitTime

Gets or sets the maximum await time.

public TimeSpan? MaxAwaitTime { get; set; }

Property Value

TimeSpan?

MaxTime

Gets or sets the maximum time.

public TimeSpan? MaxTime { get; set; }

Property Value

TimeSpan?

TranslationOptions

Gets or sets the translation options.

public ExpressionTranslationOptions TranslationOptions { get; set; }

Property Value

ExpressionTranslationOptions

UseCursor

Gets or sets a value indicating whether to use a cursor.

[Obsolete("Server versions 3.6 and newer always use a cursor.")]
public bool? UseCursor { get; set; }

Property Value

bool?