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.7.3+Branch.v2.7.x.Sha.2f1f2be13a23b8520cb9c2ee8439c022f9a03efe

Syntax

Copy

public class AggregateOperation<TResult> : IReadOperation<IAsyncCursor<TResult>>

Public Class AggregateOperation(Of TResult)
	Implements IReadOperation(Of IAsyncCursor(Of TResult))

type AggregateOperation<'TResult> =  
    class
        interface IReadOperation<IAsyncCursor<'TResult>>
    end

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.

Top

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.
	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.
	UseCursor	Gets or sets a value indicating whether the server should use a cursor to return the results.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Execute	Executes the operation.
	ExecuteAsync	Executes the operation.
	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.)

Top

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.)

Top

Reference

MongoDB.Driver.Core.Operations Namespace

AggregateOperationAddLanguageSpecificTextSet("LSTBDE8CB0A_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TResultAddLanguageSpecificTextSet("LSTBDE8CB0A_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

AggregateOperationTResult Class