Class AggregateOperation<TResult>

Namespace: MongoDB.Driver.Core.Operations

Assembly: MongoDB.Driver.Core.dll

Represents an aggregate operation.

[Obsolete("This class will be made internal in a later release.")]
public class AggregateOperation<TResult> : IReadOperation<IAsyncCursor<TResult>>, IExecutableInRetryableReadContext<IAsyncCursor<TResult>>

Type Parameters

TResult: The type of the result values.

Inheritance: object

AggregateOperation<TResult>

Implements: IReadOperation<IAsyncCursor<TResult>>

IExecutableInRetryableReadContext<IAsyncCursor<TResult>>

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: OperationExtensionMethods.ExecuteAsync<TResult>(IReadOperation<TResult>, IChannelSourceHandle, ReadPreference, ICoreSessionHandle, CancellationToken)

OperationExtensionMethods.Execute<TResult>(IReadOperation<TResult>, IChannelSourceHandle, ReadPreference, ICoreSessionHandle, CancellationToken)

Constructors

AggregateOperation(CollectionNamespace, IEnumerable<BsonDocument>, IBsonSerializer<TResult>, MessageEncoderSettings): Initializes a new instance of the AggregateOperation<TResult> class.

AggregateOperation(DatabaseNamespace, IEnumerable<BsonDocument>, IBsonSerializer<TResult>, MessageEncoderSettings): Initializes a new instance of the AggregateOperation<TResult> class.

Properties

AllowDiskUse: Gets or sets a value indicating whether the server is allowed to use the disk.

BatchSize: Gets or sets the size of a batch.

Collation: Gets or sets the collation.

CollectionNamespace: Gets the collection namespace.

Comment: Gets or sets the comment.

DatabaseNamespace: Gets the database namespace.

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 the server should spend on this operation.

MessageEncoderSettings: Gets the message encoder settings.

Pipeline: Gets the pipeline.

ReadConcern: Gets or sets the read concern.

ResultSerializer: Gets the result value serializer.

RetryRequested: Gets or sets a value indicating whether to retry.

UseCursor: Gets or sets a value indicating whether the server should use a cursor to return the results.

Methods

Execute(IReadBinding, CancellationToken): Executes the operation.

Execute(RetryableReadContext, CancellationToken): Executes the first attempt.

ExecuteAsync(IReadBinding, CancellationToken): Executes the operation.

ExecuteAsync(RetryableReadContext, CancellationToken): Executes the first attempt.

ToExplainOperation(ExplainVerbosity): Returns an AggregateExplainOperation for this AggregateOperation.