Click or drag to resize

AggregateOperationTResult Class

Represents an aggregate operation.
Inheritance Hierarchy
SystemObject
  MongoDB.Driver.Core.OperationsAggregateOperationTResult

Namespace:  MongoDB.Driver.Core.Operations
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
public class AggregateOperation<TResult> : IReadOperation<IAsyncCursor<TResult>>, 
	IExecutableInRetryableReadContext<IAsyncCursor<TResult>>

Type Parameters

TResult
The type of the result values.

The AggregateOperationTResult type exposes the following members.

Constructors
  NameDescription
Public methodAggregateOperationTResult(CollectionNamespace, IEnumerableBsonDocument, IBsonSerializerTResult, MessageEncoderSettings)
Initializes a new instance of the AggregateOperationTResult class.
Public methodAggregateOperationTResult(DatabaseNamespace, IEnumerableBsonDocument, IBsonSerializerTResult, MessageEncoderSettings)
Initializes a new instance of the AggregateOperationTResult class.
Top
Properties
  NameDescription
Public propertyAllowDiskUse
Gets or sets a value indicating whether the server is allowed to use the disk.
Public propertyBatchSize
Gets or sets the size of a batch.
Public propertyCollation
Gets or sets the collation.
Public propertyCollectionNamespace
Gets the collection namespace.
Public propertyComment
Gets or sets the comment.
Public propertyDatabaseNamespace
Gets the database namespace.
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 the server should spend on this operation.
Public propertyMessageEncoderSettings
Gets the message encoder settings.
Public propertyPipeline
Gets the pipeline.
Public propertyReadConcern
Gets or sets the read concern.
Public propertyResultSerializer
Gets the result value serializer.
Public propertyRetryRequested
Gets or sets a value indicating whether to retry.
Public propertyUseCursor Obsolete.
Gets or sets a value indicating whether the server should use a cursor to return the results.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecute(IReadBinding, CancellationToken)
Executes the operation.
Public methodExecute(RetryableReadContext, CancellationToken)
Executes the first attempt.
Public methodExecuteAsync(IReadBinding, CancellationToken)
Executes the operation.
Public methodExecuteAsync(RetryableReadContext, CancellationToken)
Executes the first attempt.
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 methodToExplainOperation
Returns an AggregateExplainOperation for this AggregateOperation.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
See Also