Interface IAggregateFluent<TResult>

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

public interface IAggregateFluent<TResult> : IAsyncCursorSource<TResult>

Type Parameters

TResult

Extension Methods

IAggregateFluentExtensions.BucketAuto<TResult, TValue>(IAggregateFluent<TResult>, Expression<Func<TResult, TValue>>, int, AggregateBucketAutoOptions)

IAggregateFluentExtensions.BucketAuto<TResult, TValue, TNewResult>(IAggregateFluent<TResult>, Expression<Func<TResult, TValue>>, int, Expression<Func<IGrouping<TValue, TResult>, TNewResult>>, AggregateBucketAutoOptions)

IAggregateFluentExtensions.Bucket<TResult, TValue>(IAggregateFluent<TResult>, Expression<Func<TResult, TValue>>, IEnumerable<TValue>, AggregateBucketOptions<TValue>)

IAggregateFluentExtensions.Bucket<TResult, TValue, TNewResult>(IAggregateFluent<TResult>, Expression<Func<TResult, TValue>>, IEnumerable<TValue>, Expression<Func<IGrouping<TValue, TResult>, TNewResult>>, AggregateBucketOptions<TValue>)

IAggregateFluentExtensions.Facet<TResult>(IAggregateFluent<TResult>, params AggregateFacet<TResult>[])

IAggregateFluentExtensions.Facet<TResult>(IAggregateFluent<TResult>, IEnumerable<AggregateFacet<TResult>>)

IAggregateFluentExtensions.Facet<TResult, TNewResult>(IAggregateFluent<TResult>, params AggregateFacet<TResult>[])

IAggregateFluentExtensions.FirstAsync<TResult>(IAggregateFluent<TResult>, CancellationToken)

IAggregateFluentExtensions.FirstOrDefaultAsync<TResult>(IAggregateFluent<TResult>, CancellationToken)

IAggregateFluentExtensions.FirstOrDefault<TResult>(IAggregateFluent<TResult>, CancellationToken)

IAggregateFluentExtensions.First<TResult>(IAggregateFluent<TResult>, CancellationToken)

IAggregateFluentExtensions.GraphLookup<TResult, TFrom>(IAggregateFluent<TResult>, IMongoCollection<TFrom>, FieldDefinition<TFrom, BsonValue>, FieldDefinition<TFrom, BsonValue>, AggregateExpressionDefinition<TResult, BsonValue>, FieldDefinition<BsonDocument, IEnumerable<BsonDocument>>, FieldDefinition<BsonDocument, int>)

IAggregateFluentExtensions.GraphLookup<TResult, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TNewResult>(IAggregateFluent<TResult>, IMongoCollection<TFrom>, FieldDefinition<TFrom, TConnectFrom>, FieldDefinition<TFrom, TConnectTo>, AggregateExpressionDefinition<TResult, TStartWith>, FieldDefinition<TNewResult, TAs>, AggregateGraphLookupOptions<TFrom, TFrom, TNewResult>)

IAggregateFluentExtensions.GraphLookup<TResult, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TNewResult>(IAggregateFluent<TResult>, IMongoCollection<TFrom>, Expression<Func<TFrom, TConnectFrom>>, Expression<Func<TFrom, TConnectTo>>, Expression<Func<TResult, TStartWith>>, Expression<Func<TNewResult, TAs>>, AggregateGraphLookupOptions<TFrom, TFrom, TNewResult>)

IAggregateFluentExtensions.GraphLookup<TResult, TFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TNewResult>(IAggregateFluent<TResult>, IMongoCollection<TFrom>, Expression<Func<TFrom, TConnectFrom>>, Expression<Func<TFrom, TConnectTo>>, Expression<Func<TResult, TStartWith>>, Expression<Func<TNewResult, TAs>>, Expression<Func<TAsElement, int>>, AggregateGraphLookupOptions<TFrom, TAsElement, TNewResult>)

IAggregateFluentExtensions.Group<TResult>(IAggregateFluent<TResult>, ProjectionDefinition<TResult, BsonDocument>)

IAggregateFluentExtensions.Group<TResult, TKey, TNewResult>(IAggregateFluent<TResult>, Expression<Func<TResult, TKey>>, Expression<Func<IGrouping<TKey, TResult>, TNewResult>>)

IAggregateFluentExtensions.Lookup<TResult>(IAggregateFluent<TResult>, string, FieldDefinition<TResult>, FieldDefinition<BsonDocument>, FieldDefinition<BsonDocument>)

IAggregateFluentExtensions.Lookup<TResult, TForeignDocument, TNewResult>(IAggregateFluent<TResult>, IMongoCollection<TForeignDocument>, Expression<Func<TResult, object>>, Expression<Func<TForeignDocument, object>>, Expression<Func<TNewResult, object>>, AggregateLookupOptions<TForeignDocument, TNewResult>)

IAggregateFluentExtensions.Match<TResult>(IAggregateFluent<TResult>, Expression<Func<TResult, bool>>)

IAggregateFluentExtensions.Project<TResult>(IAggregateFluent<TResult>, ProjectionDefinition<TResult, BsonDocument>)

IAggregateFluentExtensions.Project<TResult, TNewResult>(IAggregateFluent<TResult>, Expression<Func<TResult, TNewResult>>)

IAggregateFluentExtensions.ReplaceRoot<TResult, TNewResult>(IAggregateFluent<TResult>, Expression<Func<TResult, TNewResult>>)

IAggregateFluentExtensions.SingleAsync<TResult>(IAggregateFluent<TResult>, CancellationToken)

IAggregateFluentExtensions.SingleOrDefaultAsync<TResult>(IAggregateFluent<TResult>, CancellationToken)

IAggregateFluentExtensions.SingleOrDefault<TResult>(IAggregateFluent<TResult>, CancellationToken)

IAggregateFluentExtensions.Single<TResult>(IAggregateFluent<TResult>, CancellationToken)

IAggregateFluentExtensions.SortByCount<TResult, TKey>(IAggregateFluent<TResult>, Expression<Func<TResult, TKey>>)

IAggregateFluentExtensions.SortByDescending<TResult>(IAggregateFluent<TResult>, Expression<Func<TResult, object>>)

IAggregateFluentExtensions.SortBy<TResult>(IAggregateFluent<TResult>, Expression<Func<TResult, object>>)

IAggregateFluentExtensions.Unwind<TResult>(IAggregateFluent<TResult>, FieldDefinition<TResult>)

IAggregateFluentExtensions.Unwind<TResult>(IAggregateFluent<TResult>, Expression<Func<TResult, object>>)

IAggregateFluentExtensions.Unwind<TResult, TNewResult>(IAggregateFluent<TResult>, Expression<Func<TResult, object>>, IBsonSerializer<TNewResult>)

IAggregateFluentExtensions.Unwind<TResult, TNewResult>(IAggregateFluent<TResult>, Expression<Func<TResult, object>>, AggregateUnwindOptions<TNewResult>)

Properties

Database

IMongoDatabase Database { get; }

Property Value

IMongoDatabase

Options

AggregateOptions Options { get; }

Property Value

AggregateOptions

Stages

IList<IPipelineStageDefinition> Stages { get; }

Property Value

IList<IPipelineStageDefinition>

Methods

AppendStage<TNewResult>(PipelineStageDefinition<TResult, TNewResult>)

IAggregateFluent<TNewResult> AppendStage<TNewResult>(PipelineStageDefinition<TResult, TNewResult> stage)

Parameters

stage PipelineStageDefinition<TResult, TNewResult>

Returns

IAggregateFluent<TNewResult>

Type Parameters

TNewResult

As<TNewResult>(IBsonSerializer<TNewResult>)

IAggregateFluent<TNewResult> As<TNewResult>(IBsonSerializer<TNewResult> newResultSerializer = null)

Parameters

newResultSerializer IBsonSerializer<TNewResult>

Returns

IAggregateFluent<TNewResult>

Type Parameters

TNewResult

BucketAuto<TValue>(AggregateExpressionDefinition<TResult, TValue>, int, AggregateBucketAutoOptions)

IAggregateFluent<AggregateBucketAutoResult<TValue>> BucketAuto<TValue>(AggregateExpressionDefinition<TResult, TValue> groupBy, int buckets, AggregateBucketAutoOptions options = null)

Parameters

groupBy AggregateExpressionDefinition<TResult, TValue>

buckets int

options AggregateBucketAutoOptions

Returns

IAggregateFluent<AggregateBucketAutoResult<TValue>>

Type Parameters

TValue

BucketAuto<TValue, TNewResult>(AggregateExpressionDefinition<TResult, TValue>, int, ProjectionDefinition<TResult, TNewResult>, AggregateBucketAutoOptions)

IAggregateFluent<TNewResult> BucketAuto<TValue, TNewResult>(AggregateExpressionDefinition<TResult, TValue> groupBy, int buckets, ProjectionDefinition<TResult, TNewResult> output, AggregateBucketAutoOptions options = null)

Parameters

groupBy AggregateExpressionDefinition<TResult, TValue>

buckets int

output ProjectionDefinition<TResult, TNewResult>

options AggregateBucketAutoOptions

Returns

IAggregateFluent<TNewResult>

Type Parameters

TValue

TNewResult

Bucket<TValue>(AggregateExpressionDefinition<TResult, TValue>, IEnumerable<TValue>, AggregateBucketOptions<TValue>)

IAggregateFluent<AggregateBucketResult<TValue>> Bucket<TValue>(AggregateExpressionDefinition<TResult, TValue> groupBy, IEnumerable<TValue> boundaries, AggregateBucketOptions<TValue> options = null)

Parameters

groupBy AggregateExpressionDefinition<TResult, TValue>

boundaries IEnumerable<TValue>

options AggregateBucketOptions<TValue>

Returns

IAggregateFluent<AggregateBucketResult<TValue>>

Type Parameters

TValue

Bucket<TValue, TNewResult>(AggregateExpressionDefinition<TResult, TValue>, IEnumerable<TValue>, ProjectionDefinition<TResult, TNewResult>, AggregateBucketOptions<TValue>)

IAggregateFluent<TNewResult> Bucket<TValue, TNewResult>(AggregateExpressionDefinition<TResult, TValue> groupBy, IEnumerable<TValue> boundaries, ProjectionDefinition<TResult, TNewResult> output, AggregateBucketOptions<TValue> options = null)

Parameters

groupBy AggregateExpressionDefinition<TResult, TValue>

boundaries IEnumerable<TValue>

output ProjectionDefinition<TResult, TNewResult>

options AggregateBucketOptions<TValue>

Returns

IAggregateFluent<TNewResult>

Type Parameters

TValue

TNewResult

Count()

IAggregateFluent<AggregateCountResult> Count()

Returns

IAggregateFluent<AggregateCountResult>

Facet<TNewResult>(IEnumerable<AggregateFacet<TResult>>, AggregateFacetOptions<TNewResult>)

IAggregateFluent<TNewResult> Facet<TNewResult>(IEnumerable<AggregateFacet<TResult>> facets, AggregateFacetOptions<TNewResult> options = null)

Parameters

facets IEnumerable<AggregateFacet<TResult>>

options AggregateFacetOptions<TNewResult>

Returns

IAggregateFluent<TNewResult>

Type Parameters

TNewResult

GraphLookup<TFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TNewResult>(IMongoCollection<TFrom>, FieldDefinition<TFrom, TConnectFrom>, FieldDefinition<TFrom, TConnectTo>, AggregateExpressionDefinition<TResult, TStartWith>, FieldDefinition<TNewResult, TAs>, FieldDefinition<TAsElement, int>, AggregateGraphLookupOptions<TFrom, TAsElement, TNewResult>)

IAggregateFluent<TNewResult> GraphLookup<TFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TNewResult>(IMongoCollection<TFrom> from, FieldDefinition<TFrom, TConnectFrom> connectFromField, FieldDefinition<TFrom, TConnectTo> connectToField, AggregateExpressionDefinition<TResult, TStartWith> startWith, FieldDefinition<TNewResult, TAs> @as, FieldDefinition<TAsElement, int> depthField, AggregateGraphLookupOptions<TFrom, TAsElement, TNewResult> options = null) where TAs : IEnumerable<TAsElement>

Parameters

from IMongoCollection<TFrom>

connectFromField FieldDefinition<TFrom, TConnectFrom>

connectToField FieldDefinition<TFrom, TConnectTo>

startWith AggregateExpressionDefinition<TResult, TStartWith>

as FieldDefinition<TNewResult, TAs>

depthField FieldDefinition<TAsElement, int>

options AggregateGraphLookupOptions<TFrom, TAsElement, TNewResult>

Returns

IAggregateFluent<TNewResult>

Type Parameters

TFrom

TConnectFrom

TConnectTo

TStartWith

TAsElement

TAs

TNewResult

Group<TNewResult>(ProjectionDefinition<TResult, TNewResult>)

IAggregateFluent<TNewResult> Group<TNewResult>(ProjectionDefinition<TResult, TNewResult> group)

Parameters

group ProjectionDefinition<TResult, TNewResult>

Returns

IAggregateFluent<TNewResult>

Type Parameters

TNewResult

Limit(int)

IAggregateFluent<TResult> Limit(int limit)

Parameters

limit int

Returns

IAggregateFluent<TResult>

Lookup<TForeignDocument, TNewResult>(string, FieldDefinition<TResult>, FieldDefinition<TForeignDocument>, FieldDefinition<TNewResult>, AggregateLookupOptions<TForeignDocument, TNewResult>)

IAggregateFluent<TNewResult> Lookup<TForeignDocument, TNewResult>(string foreignCollectionName, FieldDefinition<TResult> localField, FieldDefinition<TForeignDocument> foreignField, FieldDefinition<TNewResult> @as, AggregateLookupOptions<TForeignDocument, TNewResult> options = null)

Parameters

foreignCollectionName string

localField FieldDefinition<TResult>

foreignField FieldDefinition<TForeignDocument>

as FieldDefinition<TNewResult>

options AggregateLookupOptions<TForeignDocument, TNewResult>

Returns

IAggregateFluent<TNewResult>

Type Parameters

TForeignDocument

TNewResult

Match(FilterDefinition<TResult>)

IAggregateFluent<TResult> Match(FilterDefinition<TResult> filter)

Parameters

filter FilterDefinition<TResult>

Returns

IAggregateFluent<TResult>

OfType<TNewResult>(IBsonSerializer<TNewResult>)

IAggregateFluent<TNewResult> OfType<TNewResult>(IBsonSerializer<TNewResult> newResultSerializer = null) where TNewResult : TResult

Parameters

newResultSerializer IBsonSerializer<TNewResult>

Returns

IAggregateFluent<TNewResult>

Type Parameters

TNewResult

Out(string, CancellationToken)

IAsyncCursor<TResult> Out(string collectionName, CancellationToken cancellationToken = default)

Parameters

collectionName string

cancellationToken CancellationToken

Returns

IAsyncCursor<TResult>

OutAsync(string, CancellationToken)

Task<IAsyncCursor<TResult>> OutAsync(string collectionName, CancellationToken cancellationToken = default)

Parameters

collectionName string

cancellationToken CancellationToken

Returns

Task<IAsyncCursor<TResult>>

Project<TNewResult>(ProjectionDefinition<TResult, TNewResult>)

IAggregateFluent<TNewResult> Project<TNewResult>(ProjectionDefinition<TResult, TNewResult> projection)

Parameters

projection ProjectionDefinition<TResult, TNewResult>

Returns

IAggregateFluent<TNewResult>

Type Parameters

TNewResult

ReplaceRoot<TNewResult>(AggregateExpressionDefinition<TResult, TNewResult>)

IAggregateFluent<TNewResult> ReplaceRoot<TNewResult>(AggregateExpressionDefinition<TResult, TNewResult> newRoot)

Parameters

newRoot AggregateExpressionDefinition<TResult, TNewResult>

Returns

IAggregateFluent<TNewResult>

Type Parameters

TNewResult

Skip(int)

IAggregateFluent<TResult> Skip(int skip)

Parameters

skip int

Returns

IAggregateFluent<TResult>

Sort(SortDefinition<TResult>)

IAggregateFluent<TResult> Sort(SortDefinition<TResult> sort)

Parameters

sort SortDefinition<TResult>

Returns

IAggregateFluent<TResult>

SortByCount<TId>(AggregateExpressionDefinition<TResult, TId>)

IAggregateFluent<AggregateSortByCountResult<TId>> SortByCount<TId>(AggregateExpressionDefinition<TResult, TId> id)

Parameters

id AggregateExpressionDefinition<TResult, TId>

Returns

IAggregateFluent<AggregateSortByCountResult<TId>>

Type Parameters

TId

Unwind<TNewResult>(FieldDefinition<TResult>, IBsonSerializer<TNewResult>)

[Obsolete("Use the Unwind overload which takes an options parameter.")]
IAggregateFluent<TNewResult> Unwind<TNewResult>(FieldDefinition<TResult> field, IBsonSerializer<TNewResult> newResultSerializer)

Parameters

field FieldDefinition<TResult>

newResultSerializer IBsonSerializer<TNewResult>

Returns

IAggregateFluent<TNewResult>

Type Parameters

TNewResult

Unwind<TNewResult>(FieldDefinition<TResult>, AggregateUnwindOptions<TNewResult>)

IAggregateFluent<TNewResult> Unwind<TNewResult>(FieldDefinition<TResult> field, AggregateUnwindOptions<TNewResult> options = null)

Parameters

field FieldDefinition<TResult>

options AggregateUnwindOptions<TNewResult>

Returns

IAggregateFluent<TNewResult>

Type Parameters

TNewResult