AggregateOperationTResult Class |
Represents an aggregate operation.
Inheritance HierarchyNamespace: MongoDB.Driver.Core.Operations
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntaxpublic 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| Name | Description | |
|---|---|---|
 | AggregateOperationTResult(CollectionNamespace, IEnumerableBsonDocument, IBsonSerializerTResult, MessageEncoderSettings) |
Initializes a new instance of the AggregateOperationTResult class.
|
| AggregateOperationTResult(DatabaseNamespace, IEnumerableBsonDocument, IBsonSerializerTResult, MessageEncoderSettings) |
Initializes a new instance of the AggregateOperationTResult class.
|
Properties| Name | Description | |
|---|---|---|
 | 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 | Obsolete.
Gets or sets a value indicating whether the server should use a cursor to return the results.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| 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.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToExplainOperation |
Returns an AggregateExplainOperation for this AggregateOperation.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | ExecuteIAsyncCursorTResult |
Executes a read operation using a channel source.
(Defined by OperationExtensionMethods.) |
| ExecuteAsyncIAsyncCursorTResult |
Executes a read operation using a channel source.
(Defined by OperationExtensionMethods.) |
| ToBson |
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.) |
| ToBsonDocument |
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.) |
| ToJson |
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.) |
See Also