AggregateFluentBaseTResult Class |
Base class for implementors of IAggregateFluentTResult.
Inheritance HierarchyNamespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.7.3+Branch.v2.7.x.Sha.2f1f2be13a23b8520cb9c2ee8439c022f9a03efe
Syntaxpublic abstract class AggregateFluentBase<TResult> : IOrderedAggregateFluent<TResult>, IAggregateFluent<TResult>, IAsyncCursorSource<TResult>
Type Parameters
- TResult
- The type of the document.
The AggregateFluentBaseTResult type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AggregateFluentBaseTResult | Initializes a new instance of the AggregateFluentBaseTResult class |
Properties
Methods| Name | Description | |
|---|---|---|
 | AppendStageTNewResult |
Appends the stage to the pipeline.
|
| AsTNewResult |
Changes the result type of the pipeline.
|
| BucketTValue(AggregateExpressionDefinitionTResult, TValue, IEnumerableTValue, AggregateBucketOptionsTValue) |
Appends a $bucket stage to the pipeline.
|
| BucketTValue, TNewResult(AggregateExpressionDefinitionTResult, TValue, IEnumerableTValue, ProjectionDefinitionTResult, TNewResult, AggregateBucketOptionsTValue) |
Appends a $bucket stage to the pipeline with a custom projection.
|
| BucketAutoTValue(AggregateExpressionDefinitionTResult, TValue, Int32, AggregateBucketAutoOptions) |
Appends a $bucketAuto stage to the pipeline.
|
| BucketAutoTValue, TNewResult(AggregateExpressionDefinitionTResult, TValue, Int32, ProjectionDefinitionTResult, 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 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.
|
| Count |
Appends a count stage to the pipeline.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| FacetTNewResult |
Appends a $facet stage to the pipeline.
|
| 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.) |
| GraphLookupTFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TNewResult |
Appends a $graphLookup stage to the pipeline.
|
| GroupTNewResult |
Appends a group stage to the pipeline.
|
| Limit |
Appends a limit stage to the pipeline.
|
| LookupTForeignDocument, TNewResult |
Appends a lookup stage to the pipeline.
|
| Match |
Appends a match stage to the pipeline.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OfTypeTNewResult |
Appends a match stage to the pipeline that matches derived documents and changes the result type to the derived type.
|
| Out |
Appends an out stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
|
| OutAsync |
Appends an out stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.
|
| ProjectTNewResult |
Appends a project stage to the pipeline.
|
| ReplaceRootTNewResult |
Appends a $replaceRoot stage to the pipeline.
|
| Skip |
Appends a skip stage to the pipeline.
|
| Sort |
Appends a sort stage to the pipeline.
|
| SortByCountTId |
Appends a sortByCount stage to the pipeline.
|
| ThenBy |
Combines the current sort definition with an additional sort definition.
|
| ToCursor |
Executes the operation and returns a cursor to the results.
|
| ToCursorAsync |
Executes the operation and returns a cursor to the results.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UnwindTNewResult(FieldDefinitionTResult, IBsonSerializerTNewResult) |
Appends an unwind stage to the pipeline.
|
| UnwindTNewResult(FieldDefinitionTResult, AggregateUnwindOptionsTNewResult) |
Appends an unwind stage to the pipeline.
|
Extension Methods| Name | Description | |
|---|---|---|
 | AnyTResult |
Determines whether the cursor returned by a cursor source contains any documents.
(Defined by IAsyncCursorSourceExtensions.) |
| AnyAsyncTResult |
Determines whether the cursor returned by a cursor source contains any documents.
(Defined by IAsyncCursorSourceExtensions.) |
| BucketTResult, TValue(ExpressionFuncTResult, TValue, IEnumerableTValue, AggregateBucketOptionsTValue) | Overloaded.
Appends a $bucket stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| BucketTResult, TValue, TNewResult(ExpressionFuncTResult, TValue, IEnumerableTValue, ExpressionFuncIGroupingTValue, TResult, TNewResult, AggregateBucketOptionsTValue) | Overloaded.
Appends a $bucket stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| BucketAutoTResult, TValue(ExpressionFuncTResult, TValue, Int32, AggregateBucketAutoOptions) | Overloaded.
Appends a $bucketAuto stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| BucketAutoTResult, TValue, TNewResult(ExpressionFuncTResult, TValue, Int32, ExpressionFuncIGroupingTValue, TResult, TNewResult, AggregateBucketAutoOptions) | Overloaded.
Appends a $bucketAuto stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| FacetTResult(IEnumerableAggregateFacetTResult) | Overloaded.
Appends a $facet stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| FacetTResult(AggregateFacetTResult) | Overloaded.
Appends a $facet stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| FacetTResult, TNewResult(AggregateFacetTResult) | Overloaded.
Appends a $facet stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| FirstTResult(CancellationToken) | Overloaded.
Returns the first document of the aggregate result.
(Defined by IAggregateFluentExtensions.) |
| FirstTResult(CancellationToken) | Overloaded.
Returns the first document of a cursor returned by a cursor source.
(Defined by IAsyncCursorSourceExtensions.) |
| FirstAsyncTResult(CancellationToken) | Overloaded.
Returns the first document of the aggregate result.
(Defined by IAggregateFluentExtensions.) |
| FirstAsyncTResult(CancellationToken) | Overloaded.
Returns the first document of a cursor returned by a cursor source.
(Defined by IAsyncCursorSourceExtensions.) |
| FirstOrDefaultTResult(CancellationToken) | Overloaded.
Returns the first document of the aggregate result, or the default value if the result set is empty.
(Defined by IAggregateFluentExtensions.) |
| FirstOrDefaultTResult(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.) |
| FirstOrDefaultAsyncTResult(CancellationToken) | Overloaded.
Returns the first document of the aggregate result, or the default value if the result set is empty.
(Defined by IAggregateFluentExtensions.) |
| FirstOrDefaultAsyncTResult(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.) |
| ForEachAsyncTResult(FuncTResult, Task, CancellationToken) | Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorSourceExtensions.) |
| ForEachAsyncTResult(FuncTResult, Int32, Task, CancellationToken) | Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorSourceExtensions.) |
| ForEachAsyncTResult(ActionTResult, CancellationToken) | Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorSourceExtensions.) |
| ForEachAsyncTResult(ActionTResult, Int32, CancellationToken) | Overloaded.
Calls a delegate for each document returned by the cursor.
(Defined by IAsyncCursorSourceExtensions.) |
| GraphLookupTResult, TFrom(IMongoCollectionTFrom, FieldDefinitionTFrom, BsonValue, FieldDefinitionTFrom, BsonValue, AggregateExpressionDefinitionTResult, BsonValue, FieldDefinitionBsonDocument, IEnumerableBsonDocument, FieldDefinitionBsonDocument, Int32) | Overloaded.
Appends a $graphLookup stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| GraphLookupTResult, 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.) |
| GraphLookupTResult, 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.) |
| GraphLookupTResult, 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.) |
| GroupTResult(ProjectionDefinitionTResult, BsonDocument) | Overloaded.
Appends a group stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| GroupTResult, TKey, TNewResult(ExpressionFuncTResult, TKey, ExpressionFuncIGroupingTKey, TResult, TNewResult) | Overloaded.
Appends a group stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| LookupTResult(String, FieldDefinitionTResult, FieldDefinitionBsonDocument, FieldDefinitionBsonDocument) | Overloaded.
Appends a lookup stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| LookupTResult, TForeignDocument, TNewResult(IMongoCollectionTForeignDocument, ExpressionFuncTResult, Object, ExpressionFuncTForeignDocument, Object, ExpressionFuncTNewResult, Object, AggregateLookupOptionsTForeignDocument, TNewResult) | Overloaded.
Appends a lookup stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| MatchTResult |
Appends a match stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| ProjectTResult(ProjectionDefinitionTResult, BsonDocument) | Overloaded.
Appends a project stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| ProjectTResult, TNewResult(ExpressionFuncTResult, TNewResult) | Overloaded.
Appends a project stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| ReplaceRootTResult, TNewResult |
Appends a $replaceRoot stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| SingleTResult(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.) |
| SingleTResult(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.) |
| SingleAsyncTResult(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.) |
| SingleAsyncTResult(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.) |
| SingleOrDefaultTResult(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.) |
| SingleOrDefaultTResult(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.) |
| SingleOrDefaultAsyncTResult(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.) |
| SingleOrDefaultAsyncTResult(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.) |
| SortByTResult |
Appends an ascending sort stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| SortByCountTResult, TKey |
Appends a sortByCount stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| SortByDescendingTResult |
Appends a descending sort stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| ThenByTResult |
Modifies the current sort stage by appending an ascending field specification to it.
(Defined by IAggregateFluentExtensions.) |
| ThenByDescendingTResult |
Modifies the current sort stage by appending a descending field specification to it.
(Defined by IAggregateFluentExtensions.) |
| ToBson |
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.) |
| ToBsonDocument |
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.) |
| ToEnumerableTResult |
Wraps a cursor source in an IEnumerable. Each time GetEnumerator is called a new cursor is fetched from the cursor source.
(Defined by IAsyncCursorSourceExtensions.) |
| ToJson |
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.) |
| ToListTResult |
Returns a list containing all the documents returned by the cursor returned by a cursor source.
(Defined by IAsyncCursorSourceExtensions.) |
| ToListAsyncTResult |
Returns a list containing all the documents returned by the cursor returned by a cursor source.
(Defined by IAsyncCursorSourceExtensions.) |
| UnwindTResult(ExpressionFuncTResult, Object) | Overloaded.
Appends an unwind stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| UnwindTResult(FieldDefinitionTResult) | Overloaded.
Appends an unwind stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| UnwindTResult, TNewResult(ExpressionFuncTResult, Object, IBsonSerializerTNewResult) | Overloaded.
Appends an unwind stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
| UnwindTResult, TNewResult(ExpressionFuncTResult, Object, AggregateUnwindOptionsTNewResult) | Overloaded.
Appends an unwind stage to the pipeline.
(Defined by IAggregateFluentExtensions.) |
See Also