IAggregateFluent<TResult> Interface

Fluent interface for aggregate.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2

Syntax

Copy

public interface IAggregateFluent<TResult> : IAsyncCursorSource<TResult>

Public Interface IAggregateFluent(Of TResult)
	Inherits IAsyncCursorSource(Of TResult)

type IAggregateFluent<'TResult> =  
    interface
        interface IAsyncCursorSource<'TResult>
    end

Type Parameters

TResult: The type of the result of the pipeline.

The IAggregateFluent<TResult> type exposes the following members.

Properties

	Name	Description
	Database	Gets the database.
	Options	Gets the options.
	Stages	Gets the stages.

Top

Methods

	Name	Description
	AppendStage<TNewResult>	Appends the stage to the pipeline.
	As<TNewResult>	Changes the result type of the pipeline.
	Bucket<TValue>(AggregateExpressionDefinition<TResult, TValue>, IEnumerable<TValue>, AggregateBucketOptions<TValue>)	Appends a $bucket stage to the pipeline.
	Bucket<TValue, TNewResult>(AggregateExpressionDefinition<TResult, TValue>, IEnumerable<TValue>, ProjectionDefinition<TResult, TNewResult>, AggregateBucketOptions<TValue>)	Appends a $bucket stage to the pipeline with a custom projection.
	BucketAuto<TValue>(AggregateExpressionDefinition<TResult, TValue>, Int32, AggregateBucketAutoOptions)	Appends a $bucketAuto stage to the pipeline.
	BucketAuto<TValue, TNewResult>(AggregateExpressionDefinition<TResult, TValue>, Int32, ProjectionDefinition<TResult, TNewResult>, AggregateBucketAutoOptions)	Appends a $bucketAuto stage to the pipeline with a custom projection.
	ChangeStream	Appends a $changeStream stage to the pipeline. Normally you would prefer to use the Watch method of IMongoCollection<TDocument>. Only use this method if subsequent stages project away the resume token (the _id) or you don't want the resulting cursor to automatically resume.
	Count	Appends a count stage to the pipeline.
	Densify(FieldDefinition<TResult>, DensifyRange,FieldDefinition<TResult>[])	Appends a $densify stage to the pipeline.
	Densify(FieldDefinition<TResult>, DensifyRange, IEnumerable<FieldDefinition<TResult>>)	Appends a $densify stage to the pipeline.
	Facet<TNewResult>	Appends a $facet stage to the pipeline.
	GraphLookup<TFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TNewResult>	Appends a $graphLookup stage to the pipeline.
	Group<TNewResult>	Appends a group stage to the pipeline.
	Limit	Appends a limit stage to the pipeline.
	Lookup<TForeignDocument, TNewResult>(String, FieldDefinition<TResult>, FieldDefinition<TForeignDocument>, FieldDefinition<TNewResult>, AggregateLookupOptions<TForeignDocument, TNewResult>)	Appends a lookup stage to the pipeline.
	Lookup<TForeignDocument, TAsElement, TAs, TNewResult>(IMongoCollection<TForeignDocument>, BsonDocument, PipelineDefinition<TForeignDocument, TAsElement>, FieldDefinition<TNewResult, TAs>, AggregateLookupOptions<TForeignDocument, TNewResult>)	Appends a lookup stage to the pipeline.
	Match	Appends a match stage to the pipeline.
	Merge<TOutput>	Appends a merge stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
	MergeAsync<TOutput>	Appends a merge stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
	OfType<TNewResult>	Appends a match stage to the pipeline that matches derived documents and changes the result type to the derived type.
	Out(String, CancellationToken)	Appends an out stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
	Out(IMongoCollection<TResult>, CancellationToken)	Appends an out stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
	OutAsync(String, CancellationToken)	Appends an out stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
	OutAsync(IMongoCollection<TResult>, CancellationToken)	Appends an out stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
	Project<TNewResult>	Appends a project stage to the pipeline.
	ReplaceRoot<TNewResult>	Appends a $replaceRoot stage to the pipeline.
	ReplaceWith<TNewResult>	Appends a $replaceWith stage to the pipeline.
	Search(SearchDefinition<TResult>, SearchOptions<TResult>)	Appends a $search stage to the pipeline.
	Search(SearchDefinition<TResult>, SearchHighlightOptions<TResult>, String, SearchCountOptions, Boolean, Boolean)	Appends a $search stage to the pipeline.
	SearchMeta	Appends a $searchMeta stage to the pipeline.
	SetWindowFields<TWindowFields>(AggregateExpressionDefinition<ISetWindowFieldsPartition<TResult>, TWindowFields>)	Appends a $setWindowFields to the pipeline.
	SetWindowFields<TPartitionBy, TWindowFields>(AggregateExpressionDefinition<TResult, TPartitionBy>, AggregateExpressionDefinition<ISetWindowFieldsPartition<TResult>, TWindowFields>)	Appends a $setWindowFields to the pipeline.
	SetWindowFields<TPartitionBy, TWindowFields>(AggregateExpressionDefinition<TResult, TPartitionBy>, SortDefinition<TResult>, AggregateExpressionDefinition<ISetWindowFieldsPartition<TResult>, TWindowFields>)	Appends a $setWindowFields to the pipeline.
	Skip	Appends a skip stage to the pipeline.
	Sort	Appends a sort stage to the pipeline.
	SortByCount<TId>	Appends a sortByCount stage to the pipeline.
	ToCollection	Executes an aggregation pipeline that writes the results to a collection.
	ToCollectionAsync	Executes an aggregation pipeline that writes the results to a collection.
	ToCursor	Executes the operation and returns a cursor to the results. (Inherited from IAsyncCursorSource<TDocument>.)
	ToCursorAsync	Executes the operation and returns a cursor to the results. (Inherited from IAsyncCursorSource<TDocument>.)
	UnionWith<TWith>	Appends an $unionWith stage to the pipeline.
	Unwind<TNewResult>(FieldDefinition<TResult>, IBsonSerializer<TNewResult>)	Obsolete. Appends an unwind stage to the pipeline.
	Unwind<TNewResult>(FieldDefinition<TResult>, AggregateUnwindOptions<TNewResult>)	Appends an unwind stage to the pipeline.

Top

Extension Methods

	Name	Description
	Any<TResult>	Determines whether the cursor returned by a cursor source contains any documents. (Defined by IAsyncCursorSourceExtensions.)
	AnyAsync<TResult>	Determines whether the cursor returned by a cursor source contains any documents. (Defined by IAsyncCursorSourceExtensions.)
	Bucket<TResult, TValue>(Expression<Func<TResult, TValue>>, IEnumerable<TValue>, AggregateBucketOptions<TValue>)	Overloaded. Appends a $bucket stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Bucket<TResult, TValue, TNewResult>(Expression<Func<TResult, TValue>>, IEnumerable<TValue>, Expression<Func<IGrouping<TValue, TResult>, TNewResult>>, AggregateBucketOptions<TValue>)	Overloaded. Appends a $bucket stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	BucketAuto<TResult, TValue>(Expression<Func<TResult, TValue>>, Int32, AggregateBucketAutoOptions)	Overloaded. Appends a $bucketAuto stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	BucketAuto<TResult, TValue, TNewResult>(Expression<Func<TResult, TValue>>, Int32, Expression<Func<IGrouping<AggregateBucketAutoResultId<TValue>, TResult>, TNewResult>>, AggregateBucketAutoOptions)	Overloaded. Appends a $bucketAuto stage to the pipeline (this overload can only be used with LINQ3). (Defined by IAggregateFluentExtensions.)
	BucketAutoForLinq2<TResult, TValue, TNewResult>	Appends a $bucketAuto stage to the pipeline (this method can only be used with LINQ2). (Defined by IAggregateFluentExtensions.)
	Densify<TResult>(Expression<Func<TResult, Object>>, DensifyRange, IEnumerable<Expression<Func<TResult, Object>>>)	Overloaded. Appends a $densify stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Densify<TResult>(Expression<Func<TResult, Object>>, DensifyRange,Expression<Func<TResult, Object>>[])	Overloaded. Appends a $densify stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Facet<TResult>(IEnumerable<AggregateFacet<TResult>>)	Overloaded. Appends a $facet stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Facet<TResult>(AggregateFacet<TResult>[])	Overloaded. Appends a $facet stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Facet<TResult, TNewResult>(AggregateFacet<TResult>[])	Overloaded. Appends a $facet stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	First<TResult>(CancellationToken)	Overloaded. Returns the first document of a cursor returned by a cursor source. (Defined by IAsyncCursorSourceExtensions.)
	First<TResult>(CancellationToken)	Overloaded. Returns the first document of the aggregate result. (Defined by IAggregateFluentExtensions.)
	FirstAsync<TResult>(CancellationToken)	Overloaded. Returns the first document of a cursor returned by a cursor source. (Defined by IAsyncCursorSourceExtensions.)
	FirstAsync<TResult>(CancellationToken)	Overloaded. Returns the first document of the aggregate result. (Defined by IAggregateFluentExtensions.)
	FirstOrDefault<TResult>(CancellationToken)	Overloaded. Returns the first document of a cursor returned by a cursor source, or a default value if the cursor contains no documents. (Defined by IAsyncCursorSourceExtensions.)
	FirstOrDefault<TResult>(CancellationToken)	Overloaded. Returns the first document of the aggregate result, or the default value if the result set is empty. (Defined by IAggregateFluentExtensions.)
	FirstOrDefaultAsync<TResult>(CancellationToken)	Overloaded. Returns the first document of a cursor returned by a cursor source, or a default value if the cursor contains no documents. (Defined by IAsyncCursorSourceExtensions.)
	FirstOrDefaultAsync<TResult>(CancellationToken)	Overloaded. Returns the first document of the aggregate result, or the default value if the result set is empty. (Defined by IAggregateFluentExtensions.)
	ForEachAsync<TResult>(Func<TResult, Task>, CancellationToken)	Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorSourceExtensions.)
	ForEachAsync<TResult>(Func<TResult, Int32, Task>, CancellationToken)	Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorSourceExtensions.)
	ForEachAsync<TResult>(Action<TResult>, CancellationToken)	Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorSourceExtensions.)
	ForEachAsync<TResult>(Action<TResult, Int32>, CancellationToken)	Overloaded. Calls a delegate for each document returned by the cursor. (Defined by IAsyncCursorSourceExtensions.)
	GraphLookup<TResult, TFrom>(IMongoCollection<TFrom>, FieldDefinition<TFrom, BsonValue>, FieldDefinition<TFrom, BsonValue>, AggregateExpressionDefinition<TResult, BsonValue>, FieldDefinition<BsonDocument, IEnumerable<BsonDocument>>, FieldDefinition<BsonDocument, Int32>)	Overloaded. Appends a $graphLookup stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	GraphLookup<TResult, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TNewResult>(IMongoCollection<TFrom>, FieldDefinition<TFrom, TConnectFrom>, FieldDefinition<TFrom, TConnectTo>, AggregateExpressionDefinition<TResult, TStartWith>, FieldDefinition<TNewResult, TAs>, AggregateGraphLookupOptions<TFrom, TFrom, TNewResult>)	Overloaded. Appends a $graphLookup stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	GraphLookup<TResult, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TNewResult>(IMongoCollection<TFrom>, Expression<Func<TFrom, TConnectFrom>>, Expression<Func<TFrom, TConnectTo>>, Expression<Func<TResult, TStartWith>>, Expression<Func<TNewResult, TAs>>, AggregateGraphLookupOptions<TFrom, TFrom, TNewResult>)	Overloaded. Appends a $graphLookup stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	GraphLookup<TResult, TFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TNewResult>(IMongoCollection<TFrom>, Expression<Func<TFrom, TConnectFrom>>, Expression<Func<TFrom, TConnectTo>>, Expression<Func<TResult, TStartWith>>, Expression<Func<TNewResult, TAs>>, Expression<Func<TAsElement, Int32>>, AggregateGraphLookupOptions<TFrom, TAsElement, TNewResult>)	Overloaded. Appends a $graphLookup stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Group<TResult>(ProjectionDefinition<TResult, BsonDocument>)	Overloaded. Appends a group stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Group<TResult, TKey, TNewResult>(Expression<Func<TResult, TKey>>, Expression<Func<IGrouping<TKey, TResult>, TNewResult>>)	Overloaded. Appends a group stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Lookup<TResult>(String, FieldDefinition<TResult>, FieldDefinition<BsonDocument>, FieldDefinition<BsonDocument>)	Overloaded. Appends a lookup stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Lookup<TResult>(IMongoCollection<BsonDocument>, BsonDocument, PipelineDefinition<BsonDocument, BsonDocument>, FieldDefinition<BsonDocument, IEnumerable<BsonDocument>>)	Overloaded. Appends a lookup stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Lookup<TResult, TForeignDocument, TNewResult>(IMongoCollection<TForeignDocument>, Expression<Func<TResult, Object>>, Expression<Func<TForeignDocument, Object>>, Expression<Func<TNewResult, Object>>, AggregateLookupOptions<TForeignDocument, TNewResult>)	Overloaded. Appends a lookup stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Lookup<TResult, TForeignDocument, TAsElement, TAs, TNewResult>(IMongoCollection<TForeignDocument>, BsonDocument, PipelineDefinition<TForeignDocument, TAsElement>, Expression<Func<TNewResult, TAs>>, AggregateLookupOptions<TForeignDocument, TNewResult>)	Overloaded. Appends a lookup stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Match<TResult>	Appends a match stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Project<TResult>(ProjectionDefinition<TResult, BsonDocument>)	Overloaded. Appends a project stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Project<TResult, TNewResult>(Expression<Func<TResult, TNewResult>>)	Overloaded. Appends a project stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	ReplaceRoot<TResult, TNewResult>	Appends a $replaceRoot stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	ReplaceWith<TResult, TNewResult>	Appends a $replaceWith stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	SetWindowFields<TResult, TWindowFields>(Expression<Func<ISetWindowFieldsPartition<TResult>, TWindowFields>>)	Overloaded. Appends a $setWindowFields to the pipeline. (Defined by IAggregateFluentExtensions.)
	SetWindowFields<TResult, TPartitionBy, TWindowFields>(Expression<Func<TResult, TPartitionBy>>, Expression<Func<ISetWindowFieldsPartition<TResult>, TWindowFields>>)	Overloaded. Appends a $setWindowFields to the pipeline. (Defined by IAggregateFluentExtensions.)
	SetWindowFields<TResult, TPartitionBy, TWindowFields>(Expression<Func<TResult, TPartitionBy>>, SortDefinition<TResult>, Expression<Func<ISetWindowFieldsPartition<TResult>, TWindowFields>>)	Overloaded. Appends a $setWindowFields to the pipeline. (Defined by IAggregateFluentExtensions.)
	Single<TResult>(CancellationToken)	Overloaded. Returns the only document of a cursor returned by a cursor source. This method throws an exception if the cursor does not contain exactly one document. (Defined by IAsyncCursorSourceExtensions.)
	Single<TResult>(CancellationToken)	Overloaded. Returns the only document of the aggregate result. Throws an exception if the result set does not contain exactly one document. (Defined by IAggregateFluentExtensions.)
	SingleAsync<TResult>(CancellationToken)	Overloaded. Returns the only document of a cursor returned by a cursor source. This method throws an exception if the cursor does not contain exactly one document. (Defined by IAsyncCursorSourceExtensions.)
	SingleAsync<TResult>(CancellationToken)	Overloaded. Returns the only document of the aggregate result. Throws an exception if the result set does not contain exactly one document. (Defined by IAggregateFluentExtensions.)
	SingleOrDefault<TResult>(CancellationToken)	Overloaded. Returns the only document of a cursor returned by a cursor source, or a default value if the cursor contains no documents. This method throws an exception if the cursor contains more than one document. (Defined by IAsyncCursorSourceExtensions.)
	SingleOrDefault<TResult>(CancellationToken)	Overloaded. Returns the only document of the aggregate result, or the default value if the result set is empty. Throws an exception if the result set contains more than one document. (Defined by IAggregateFluentExtensions.)
	SingleOrDefaultAsync<TResult>(CancellationToken)	Overloaded. Returns the only document of a cursor returned by a cursor source, or a default value if the cursor contains no documents. This method throws an exception if the cursor contains more than one document. (Defined by IAsyncCursorSourceExtensions.)
	SingleOrDefaultAsync<TResult>(CancellationToken)	Overloaded. Returns the only document of the aggregate result, or the default value if the result set is empty. Throws an exception if the result set contains more than one document. (Defined by IAggregateFluentExtensions.)
	SortBy<TResult>	Appends an ascending sort stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	SortByCount<TResult, TKey>	Appends a sortByCount stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	SortByDescending<TResult>	Appends a descending sort stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	ToEnumerable<TResult>	Wraps a cursor source in an IEnumerable. Each time GetEnumerator is called a new cursor is fetched from the cursor source. (Defined by IAsyncCursorSourceExtensions.)
	ToList<TResult>	Returns a list containing all the documents returned by the cursor returned by a cursor source. (Defined by IAsyncCursorSourceExtensions.)
	ToListAsync<TResult>	Returns a list containing all the documents returned by the cursor returned by a cursor source. (Defined by IAsyncCursorSourceExtensions.)
	Unwind<TResult>(Expression<Func<TResult, Object>>)	Overloaded. Appends an unwind stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Unwind<TResult>(FieldDefinition<TResult>)	Overloaded. Appends an unwind stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Unwind<TResult, TNewResult>(Expression<Func<TResult, Object>>, IBsonSerializer<TNewResult>)	Overloaded. Appends an unwind stage to the pipeline. (Defined by IAggregateFluentExtensions.)
	Unwind<TResult, TNewResult>(Expression<Func<TResult, Object>>, AggregateUnwindOptions<TNewResult>)	Overloaded. Appends an unwind stage to the pipeline. (Defined by IAggregateFluentExtensions.)

Top

Remarks

This interface is not guaranteed to remain stable. Implementors should use AggregateFluentBase<TResult>.

Reference

MongoDB.Driver Namespace

IAggregateFluent<AddLanguageSpecificTextSet("LST13AFD46F_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TResult>AddLanguageSpecificTextSet("LST13AFD46F_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Interface

Type Parameters

Reference

IAggregateFluent<TResult> Interface