Click or drag to resize

IOrderedAggregateFluentTResult Interface

Fluent interface for aggregate.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed
Syntax
Copy
public interface IOrderedAggregateFluent<TResult> : IAggregateFluent<TResult>, 
	IAsyncCursorSource<TResult>

Type Parameters

TResult
The type of the result.

The IOrderedAggregateFluentTResult type exposes the following members.

Properties
Methods
  NameDescription
Public methodAppendStageTNewResult
Appends the stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodAsTNewResult
Changes the result type of the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodBucketTValue(AggregateExpressionDefinitionTResult, TValue, IEnumerableTValue, AggregateBucketOptionsTValue)
Appends a $bucket stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodBucketTValue, TNewResult(AggregateExpressionDefinitionTResult, TValue, IEnumerableTValue, ProjectionDefinitionTResult, TNewResult, AggregateBucketOptionsTValue)
Appends a $bucket stage to the pipeline with a custom projection.
(Inherited from IAggregateFluentTResult.)
Public methodBucketAutoTValue(AggregateExpressionDefinitionTResult, TValue, Int32, AggregateBucketAutoOptions)
Appends a $bucketAuto stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodBucketAutoTValue, TNewResult(AggregateExpressionDefinitionTResult, TValue, Int32, ProjectionDefinitionTResult, TNewResult, AggregateBucketAutoOptions)
Appends a $bucketAuto stage to the pipeline with a custom projection.
(Inherited from IAggregateFluentTResult.)
Public methodChangeStream
Appends a $changeStream stage to the pipeline. Normally you would prefer to use the Watch method of IMongoCollectionTDocument. 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.
(Inherited from IAggregateFluentTResult.)
Public methodCount
Appends a count stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodFacetTNewResult
Appends a $facet stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodGraphLookupTFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TNewResult
Appends a $graphLookup stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodGroupTNewResult
Appends a group stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodLimit
Appends a limit stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodLookupTForeignDocument, TNewResult(String, FieldDefinitionTResult, FieldDefinitionTForeignDocument, FieldDefinitionTNewResult, AggregateLookupOptionsTForeignDocument, TNewResult)
Appends a lookup stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodLookupTForeignDocument, TAsElement, TAs, TNewResult(IMongoCollectionTForeignDocument, BsonDocument, PipelineDefinitionTForeignDocument, TAsElement, FieldDefinitionTNewResult, TAs, AggregateLookupOptionsTForeignDocument, TNewResult)
Appends a lookup stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodMatch
Appends a match stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodMergeTOutput
Appends a merge stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
(Inherited from IAggregateFluentTResult.)
Public methodMergeAsyncTOutput
Appends a merge stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
(Inherited from IAggregateFluentTResult.)
Public methodOfTypeTNewResult
Appends a match stage to the pipeline that matches derived documents and changes the result type to the derived type.
(Inherited from IAggregateFluentTResult.)
Public methodOut
Appends an out stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
(Inherited from IAggregateFluentTResult.)
Public methodOutAsync
Appends an out stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
(Inherited from IAggregateFluentTResult.)
Public methodProjectTNewResult
Appends a project stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodReplaceRootTNewResult
Appends a $replaceRoot stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodReplaceWithTNewResult
Appends a $replaceWith stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodSkip
Appends a skip stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodSort
Appends a sort stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodSortByCountTId
Appends a sortByCount stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodThenBy
Combines the current sort definition with an additional sort definition.
Public methodToCursor
Executes the operation and returns a cursor to the results.
(Inherited from IAsyncCursorSourceTDocument.)
Public methodToCursorAsync
Executes the operation and returns a cursor to the results.
(Inherited from IAsyncCursorSourceTDocument.)
Public methodUnwindTNewResult(FieldDefinitionTResult, IBsonSerializerTNewResult) Obsolete.
Appends an unwind stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Public methodUnwindTNewResult(FieldDefinitionTResult, AggregateUnwindOptionsTNewResult)
Appends an unwind stage to the pipeline.
(Inherited from IAggregateFluentTResult.)
Top
Extension Methods
  NameDescription
Public Extension MethodAnyTResult
Determines whether the cursor returned by a cursor source contains any documents.
(Defined by IAsyncCursorSourceExtensions.)
Public Extension MethodAnyAsyncTResult
Determines whether the cursor returned by a cursor source contains any documents.
(Defined by IAsyncCursorSourceExtensions.)
Public Extension MethodBucketTResult, TValue(ExpressionFuncTResult, TValue, IEnumerableTValue, AggregateBucketOptionsTValue)Overloaded.
Appends a $bucket stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodBucketTResult, TValue, TNewResult(ExpressionFuncTResult, TValue, IEnumerableTValue, ExpressionFuncIGroupingTValue, TResult, TNewResult, AggregateBucketOptionsTValue)Overloaded.
Appends a $bucket stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodBucketAutoTResult, TValue(ExpressionFuncTResult, TValue, Int32, AggregateBucketAutoOptions)Overloaded.
Appends a $bucketAuto stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodBucketAutoTResult, TValue, TNewResult(ExpressionFuncTResult, TValue, Int32, ExpressionFuncIGroupingTValue, TResult, TNewResult, AggregateBucketAutoOptions)Overloaded.
Appends a $bucketAuto stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodFacetTResult(IEnumerableAggregateFacetTResult)Overloaded.
Appends a $facet stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodFacetTResult(AggregateFacetTResult)Overloaded.
Appends a $facet stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodFacetTResult, TNewResult(AggregateFacetTResult)Overloaded.
Appends a $facet stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodFirstTResult(CancellationToken)Overloaded.
Returns the first document of the aggregate result.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodFirstTResult(CancellationToken)Overloaded.
Returns the first document of a cursor returned by a cursor source.
(Defined by IAsyncCursorSourceExtensions.)
Public Extension MethodFirstAsyncTResult(CancellationToken)Overloaded.
Returns the first document of the aggregate result.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodFirstAsyncTResult(CancellationToken)Overloaded.
Returns the first document of a cursor returned by a cursor source.
(Defined by IAsyncCursorSourceExtensions.)
Public Extension MethodFirstOrDefaultTResult(CancellationToken)Overloaded.
Returns the first document of the aggregate result, or the default value if the result set is empty.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodFirstOrDefaultTResult(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.)
Public Extension MethodFirstOrDefaultAsyncTResult(CancellationToken)Overloaded.
Returns the first document of the aggregate result, or the default value if the result set is empty.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodFirstOrDefaultAsyncTResult(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.)
Public Extension MethodForEachAsyncTResult(FuncTResult, Task, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorSourceExtensions.)
Public Extension MethodForEachAsyncTResult(FuncTResult, Int32, Task, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorSourceExtensions.)
Public Extension MethodForEachAsyncTResult(ActionTResult, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorSourceExtensions.)
Public Extension MethodForEachAsyncTResult(ActionTResult, Int32, CancellationToken)Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorSourceExtensions.)
Public Extension MethodGraphLookupTResult, TFrom(IMongoCollectionTFrom, FieldDefinitionTFrom, BsonValue, FieldDefinitionTFrom, BsonValue, AggregateExpressionDefinitionTResult, BsonValue, FieldDefinitionBsonDocument, IEnumerableBsonDocument, FieldDefinitionBsonDocument, Int32)Overloaded.
Appends a $graphLookup stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodGraphLookupTResult, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TNewResult(IMongoCollectionTFrom, FieldDefinitionTFrom, TConnectFrom, FieldDefinitionTFrom, TConnectTo, AggregateExpressionDefinitionTResult, TStartWith, FieldDefinitionTNewResult, TAs, AggregateGraphLookupOptionsTFrom, TFrom, TNewResult)Overloaded.
Appends a $graphLookup stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodGraphLookupTResult, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TNewResult(IMongoCollectionTFrom, ExpressionFuncTFrom, TConnectFrom, ExpressionFuncTFrom, TConnectTo, ExpressionFuncTResult, TStartWith, ExpressionFuncTNewResult, TAs, AggregateGraphLookupOptionsTFrom, TFrom, TNewResult)Overloaded.
Appends a $graphLookup stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodGraphLookupTResult, TFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TNewResult(IMongoCollectionTFrom, ExpressionFuncTFrom, TConnectFrom, ExpressionFuncTFrom, TConnectTo, ExpressionFuncTResult, TStartWith, ExpressionFuncTNewResult, TAs, ExpressionFuncTAsElement, Int32, AggregateGraphLookupOptionsTFrom, TAsElement, TNewResult)Overloaded.
Appends a $graphLookup stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodGroupTResult(ProjectionDefinitionTResult, BsonDocument)Overloaded.
Appends a group stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodGroupTResult, TKey, TNewResult(ExpressionFuncTResult, TKey, ExpressionFuncIGroupingTKey, TResult, TNewResult)Overloaded.
Appends a group stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodLookupTResult(String, FieldDefinitionTResult, FieldDefinitionBsonDocument, FieldDefinitionBsonDocument)Overloaded.
Appends a lookup stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodLookupTResult(IMongoCollectionBsonDocument, BsonDocument, PipelineDefinitionBsonDocument, BsonDocument, FieldDefinitionBsonDocument, IEnumerableBsonDocument)Overloaded.
Appends a lookup stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodLookupTResult, TForeignDocument, TNewResult(IMongoCollectionTForeignDocument, ExpressionFuncTResult, Object, ExpressionFuncTForeignDocument, Object, ExpressionFuncTNewResult, Object, AggregateLookupOptionsTForeignDocument, TNewResult)Overloaded.
Appends a lookup stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodLookupTResult, TForeignDocument, TAsElement, TAs, TNewResult(IMongoCollectionTForeignDocument, BsonDocument, PipelineDefinitionTForeignDocument, TAsElement, ExpressionFuncTNewResult, TAs, AggregateLookupOptionsTForeignDocument, TNewResult)Overloaded.
Appends a lookup stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodMatchTResult
Appends a match stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodProjectTResult(ProjectionDefinitionTResult, BsonDocument)Overloaded.
Appends a project stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodProjectTResult, TNewResult(ExpressionFuncTResult, TNewResult)Overloaded.
Appends a project stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodReplaceRootTResult, TNewResult
Appends a $replaceRoot stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodReplaceWithTResult, TNewResult
Appends a $replaceWith stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodSingleTResult(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.)
Public Extension MethodSingleTResult(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.)
Public Extension MethodSingleAsyncTResult(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.)
Public Extension MethodSingleAsyncTResult(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.)
Public Extension MethodSingleOrDefaultTResult(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.)
Public Extension MethodSingleOrDefaultTResult(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.)
Public Extension MethodSingleOrDefaultAsyncTResult(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.)
Public Extension MethodSingleOrDefaultAsyncTResult(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.)
Public Extension MethodSortByTResult
Appends an ascending sort stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodSortByCountTResult, TKey
Appends a sortByCount stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodSortByDescendingTResult
Appends a descending sort stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodThenByTResult
Modifies the current sort stage by appending an ascending field specification to it.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodThenByDescendingTResult
Modifies the current sort stage by appending a descending field specification to it.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodToEnumerableTResult
Wraps a cursor source in an IEnumerable. Each time GetEnumerator is called a new cursor is fetched from the cursor source.
(Defined by IAsyncCursorSourceExtensions.)
Public Extension MethodToListTResult
Returns a list containing all the documents returned by the cursor returned by a cursor source.
(Defined by IAsyncCursorSourceExtensions.)
Public Extension MethodToListAsyncTResult
Returns a list containing all the documents returned by the cursor returned by a cursor source.
(Defined by IAsyncCursorSourceExtensions.)
Public Extension MethodUnwindTResult(ExpressionFuncTResult, Object)Overloaded.
Appends an unwind stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodUnwindTResult(FieldDefinitionTResult)Overloaded.
Appends an unwind stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodUnwindTResult, TNewResult(ExpressionFuncTResult, Object, IBsonSerializerTNewResult)Overloaded.
Appends an unwind stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Public Extension MethodUnwindTResult, TNewResult(ExpressionFuncTResult, Object, AggregateUnwindOptionsTNewResult)Overloaded.
Appends an unwind stage to the pipeline.
(Defined by IAggregateFluentExtensions.)
Top
See Also