Class PipelineStageDefinitionBuilder

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

Methods for building pipeline stages.

public static class PipelineStageDefinitionBuilder

Inheritance

object

PipelineStageDefinitionBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

BucketAutoForLinq2<TInput, TValue, TOutput>(Expression<Func<TInput, TValue>>, int, Expression<Func<IGrouping<TValue, TInput>, TOutput>>, AggregateBucketAutoOptions, ExpressionTranslationOptions)

Creates a $bucketAuto stage (this method can only be used with LINQ2).

public static PipelineStageDefinition<TInput, TOutput> BucketAutoForLinq2<TInput, TValue, TOutput>(Expression<Func<TInput, TValue>> groupBy, int buckets, Expression<Func<IGrouping<TValue, TInput>, TOutput>> output, AggregateBucketAutoOptions options = null, ExpressionTranslationOptions translationOptions = null)

Parameters

groupBy Expression<Func<TInput, TValue>>

The group by expression.

buckets int

The number of buckets.

output Expression<Func<IGrouping<TValue, TInput>, TOutput>>

The output projection.

options AggregateBucketAutoOptions

The options (optional).

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TValue

The type of the output documents.

TOutput

The type of the output documents.

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

Creates a $bucketAuto stage.

public static PipelineStageDefinition<TInput, AggregateBucketAutoResult<TValue>> BucketAuto<TInput, TValue>(AggregateExpressionDefinition<TInput, TValue> groupBy, int buckets, AggregateBucketAutoOptions options = null)

Parameters

groupBy AggregateExpressionDefinition<TInput, TValue>

The group by expression.

buckets int

The number of buckets.

options AggregateBucketAutoOptions

The options.

Returns

PipelineStageDefinition<TInput, AggregateBucketAutoResult<TValue>>

The stage.

Type Parameters

TInput

The type of the input documents.

TValue

The type of the values.

BucketAuto<TInput, TValue>(Expression<Func<TInput, TValue>>, int, AggregateBucketAutoOptions, ExpressionTranslationOptions)

Creates a $bucketAuto stage.

public static PipelineStageDefinition<TInput, AggregateBucketAutoResult<TValue>> BucketAuto<TInput, TValue>(Expression<Func<TInput, TValue>> groupBy, int buckets, AggregateBucketAutoOptions options = null, ExpressionTranslationOptions translationOptions = null)

Parameters

groupBy Expression<Func<TInput, TValue>>

The group by expression.

buckets int

The number of buckets.

options AggregateBucketAutoOptions

The options (optional).

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, AggregateBucketAutoResult<TValue>>

The stage.

Type Parameters

TInput

The type of the input documents.

TValue

The type of the value.

BucketAuto<TInput, TValue, TOutput>(AggregateExpressionDefinition<TInput, TValue>, int, ProjectionDefinition<TInput, TOutput>, AggregateBucketAutoOptions)

Creates a $bucketAuto stage.

public static PipelineStageDefinition<TInput, TOutput> BucketAuto<TInput, TValue, TOutput>(AggregateExpressionDefinition<TInput, TValue> groupBy, int buckets, ProjectionDefinition<TInput, TOutput> output, AggregateBucketAutoOptions options = null)

Parameters

groupBy AggregateExpressionDefinition<TInput, TValue>

The group by expression.

buckets int

The number of buckets.

output ProjectionDefinition<TInput, TOutput>

The output projection.

options AggregateBucketAutoOptions

The options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TValue

The type of the values.

TOutput

The type of the output documents.

BucketAuto<TInput, TValue, TOutput>(Expression<Func<TInput, TValue>>, int, Expression<Func<IGrouping<AggregateBucketAutoResultId<TValue>, TInput>, TOutput>>, AggregateBucketAutoOptions, ExpressionTranslationOptions)

Creates a $bucketAuto stage (this overload can only be used with LINQ3).

public static PipelineStageDefinition<TInput, TOutput> BucketAuto<TInput, TValue, TOutput>(Expression<Func<TInput, TValue>> groupBy, int buckets, Expression<Func<IGrouping<AggregateBucketAutoResultId<TValue>, TInput>, TOutput>> output, AggregateBucketAutoOptions options = null, ExpressionTranslationOptions translationOptions = null)

Parameters

groupBy Expression<Func<TInput, TValue>>

The group by expression.

buckets int

The number of buckets.

output Expression<Func<IGrouping<AggregateBucketAutoResultId<TValue>, TInput>, TOutput>>

The output projection.

options AggregateBucketAutoOptions

The options (optional).

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TValue

The type of the output documents.

TOutput

The type of the output documents.

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

Creates a $bucket stage.

public static PipelineStageDefinition<TInput, AggregateBucketResult<TValue>> Bucket<TInput, TValue>(AggregateExpressionDefinition<TInput, TValue> groupBy, IEnumerable<TValue> boundaries, AggregateBucketOptions<TValue> options = null)

Parameters

groupBy AggregateExpressionDefinition<TInput, TValue>

The group by expression.

boundaries IEnumerable<TValue>

The boundaries.

options AggregateBucketOptions<TValue>

The options.

Returns

PipelineStageDefinition<TInput, AggregateBucketResult<TValue>>

The stage.

Type Parameters

TInput

The type of the input documents.

TValue

The type of the values.

Bucket<TInput, TValue>(Expression<Func<TInput, TValue>>, IEnumerable<TValue>, AggregateBucketOptions<TValue>, ExpressionTranslationOptions)

Creates a $bucket stage.

public static PipelineStageDefinition<TInput, AggregateBucketResult<TValue>> Bucket<TInput, TValue>(Expression<Func<TInput, TValue>> groupBy, IEnumerable<TValue> boundaries, AggregateBucketOptions<TValue> options = null, ExpressionTranslationOptions translationOptions = null)

Parameters

groupBy Expression<Func<TInput, TValue>>

The group by expression.

boundaries IEnumerable<TValue>

The boundaries.

options AggregateBucketOptions<TValue>

The options.

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, AggregateBucketResult<TValue>>

The stage.

Type Parameters

TInput

The type of the input documents.

TValue

The type of the values.

Bucket<TInput, TValue, TOutput>(AggregateExpressionDefinition<TInput, TValue>, IEnumerable<TValue>, ProjectionDefinition<TInput, TOutput>, AggregateBucketOptions<TValue>)

Creates a $bucket stage.

public static PipelineStageDefinition<TInput, TOutput> Bucket<TInput, TValue, TOutput>(AggregateExpressionDefinition<TInput, TValue> groupBy, IEnumerable<TValue> boundaries, ProjectionDefinition<TInput, TOutput> output, AggregateBucketOptions<TValue> options = null)

Parameters

groupBy AggregateExpressionDefinition<TInput, TValue>

The group by expression.

boundaries IEnumerable<TValue>

The boundaries.

output ProjectionDefinition<TInput, TOutput>

The output projection.

options AggregateBucketOptions<TValue>

The options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TValue

The type of the values.

TOutput

The type of the output documents.

Bucket<TInput, TValue, TOutput>(Expression<Func<TInput, TValue>>, IEnumerable<TValue>, Expression<Func<IGrouping<TValue, TInput>, TOutput>>, AggregateBucketOptions<TValue>, ExpressionTranslationOptions)

Creates a $bucket stage.

public static PipelineStageDefinition<TInput, TOutput> Bucket<TInput, TValue, TOutput>(Expression<Func<TInput, TValue>> groupBy, IEnumerable<TValue> boundaries, Expression<Func<IGrouping<TValue, TInput>, TOutput>> output, AggregateBucketOptions<TValue> options = null, ExpressionTranslationOptions translationOptions = null)

Parameters

groupBy Expression<Func<TInput, TValue>>

The group by expression.

boundaries IEnumerable<TValue>

The boundaries.

output Expression<Func<IGrouping<TValue, TInput>, TOutput>>

The output projection.

options AggregateBucketOptions<TValue>

The options.

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TValue

The type of the values.

TOutput

The type of the output documents.

ChangeStream<TInput>(ChangeStreamStageOptions)

Creates a $changeStream stage. 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.

public static PipelineStageDefinition<TInput, ChangeStreamDocument<TInput>> ChangeStream<TInput>(ChangeStreamStageOptions options = null)

Parameters

options ChangeStreamStageOptions

The options.

Returns

PipelineStageDefinition<TInput, ChangeStreamDocument<TInput>>

The stage.

Type Parameters

TInput

The type of the input documents.

Count<TInput>()

Creates a $count stage.

public static PipelineStageDefinition<TInput, AggregateCountResult> Count<TInput>()

Returns

PipelineStageDefinition<TInput, AggregateCountResult>

The stage.

Type Parameters

TInput

The type of the input documents.

Densify<TInput>(FieldDefinition<TInput>, DensifyRange, params FieldDefinition<TInput>[])

Creates a $densify stage.

public static PipelineStageDefinition<TInput, TInput> Densify<TInput>(FieldDefinition<TInput> field, DensifyRange range, params FieldDefinition<TInput>[] partitionByFields)

Parameters

field FieldDefinition<TInput>

The field.

range DensifyRange

The range.

partitionByFields FieldDefinition<TInput>[]

The partition by fields.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

Densify<TInput>(FieldDefinition<TInput>, DensifyRange, IEnumerable<FieldDefinition<TInput>>)

Creates a $densify stage.

public static PipelineStageDefinition<TInput, TInput> Densify<TInput>(FieldDefinition<TInput> field, DensifyRange range, IEnumerable<FieldDefinition<TInput>> partitionByFields = null)

Parameters

field FieldDefinition<TInput>

The field.

range DensifyRange

The range.

partitionByFields IEnumerable<FieldDefinition<TInput>>

The partition by fields.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

Densify<TInput>(Expression<Func<TInput, object>>, DensifyRange, IEnumerable<Expression<Func<TInput, object>>>)

Creates a $densify stage.

public static PipelineStageDefinition<TInput, TInput> Densify<TInput>(Expression<Func<TInput, object>> field, DensifyRange range, IEnumerable<Expression<Func<TInput, object>>> partitionByFields = null)

Parameters

field Expression<Func<TInput, object>>

The field.

range DensifyRange

The range.

partitionByFields IEnumerable<Expression<Func<TInput, object>>>

The partition by fields.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

Densify<TInput>(Expression<Func<TInput, object>>, DensifyRange, params Expression<Func<TInput, object>>[])

Creates a $densify stage.

public static PipelineStageDefinition<TInput, TInput> Densify<TInput>(Expression<Func<TInput, object>> field, DensifyRange range, params Expression<Func<TInput, object>>[] partitionByFields)

Parameters

field Expression<Func<TInput, object>>

The field.

range DensifyRange

The range.

partitionByFields Expression<Func<TInput, object>>[]

The partition by fields.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

Documents<TDocument>(AggregateExpressionDefinition<NoPipelineInput, IEnumerable<TDocument>>, IBsonSerializer<TDocument>)

Creates a $documents stage.

public static PipelineStageDefinition<NoPipelineInput, TDocument> Documents<TDocument>(AggregateExpressionDefinition<NoPipelineInput, IEnumerable<TDocument>> documents, IBsonSerializer<TDocument> documentSerializer = null)

Parameters

documents AggregateExpressionDefinition<NoPipelineInput, IEnumerable<TDocument>>

The documents.

documentSerializer IBsonSerializer<TDocument>

The document serializer.

Returns

PipelineStageDefinition<NoPipelineInput, TDocument>

The stage.

Type Parameters

TDocument

The type of the documents.

Documents<TDocument>(IEnumerable<TDocument>, IBsonSerializer<TDocument>)

Creates a $documents stage.

public static PipelineStageDefinition<NoPipelineInput, TDocument> Documents<TDocument>(IEnumerable<TDocument> documents, IBsonSerializer<TDocument> documentSerializer = null)

Parameters

documents IEnumerable<TDocument>

The documents.

documentSerializer IBsonSerializer<TDocument>

The document serializer.

Returns

PipelineStageDefinition<NoPipelineInput, TDocument>

The stage.

Type Parameters

TDocument

The type of the documents.

Facet<TInput>(params AggregateFacet<TInput>[])

Creates a $facet stage.

public static PipelineStageDefinition<TInput, AggregateFacetResults> Facet<TInput>(params AggregateFacet<TInput>[] facets)

Parameters

facets AggregateFacet<TInput>[]

The facets.

Returns

PipelineStageDefinition<TInput, AggregateFacetResults>

The stage.

Type Parameters

TInput

The type of the input documents.

Facet<TInput>(IEnumerable<AggregateFacet<TInput>>)

Creates a $facet stage.

public static PipelineStageDefinition<TInput, AggregateFacetResults> Facet<TInput>(IEnumerable<AggregateFacet<TInput>> facets)

Parameters

facets IEnumerable<AggregateFacet<TInput>>

The facets.

Returns

PipelineStageDefinition<TInput, AggregateFacetResults>

The stage.

Type Parameters

TInput

The type of the input documents.

Facet<TInput, TOutput>(params AggregateFacet<TInput>[])

Creates a $facet stage.

public static PipelineStageDefinition<TInput, TOutput> Facet<TInput, TOutput>(params AggregateFacet<TInput>[] facets)

Parameters

facets AggregateFacet<TInput>[]

The facets.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

Facet<TInput, TOutput>(IEnumerable<AggregateFacet<TInput>>, AggregateFacetOptions<TOutput>)

Creates a $facet stage.

public static PipelineStageDefinition<TInput, TOutput> Facet<TInput, TOutput>(IEnumerable<AggregateFacet<TInput>> facets, AggregateFacetOptions<TOutput> options = null)

Parameters

facets IEnumerable<AggregateFacet<TInput>>

The facets.

options AggregateFacetOptions<TOutput>

The options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

GraphLookup<TInput, TFrom>(IMongoCollection<TFrom>, FieldDefinition<TFrom, BsonValue>, FieldDefinition<TFrom, BsonValue>, AggregateExpressionDefinition<TInput, BsonValue>, FieldDefinition<BsonDocument, IEnumerable<BsonDocument>>, FieldDefinition<BsonDocument, int>)

Creates a $graphLookup stage.

public static PipelineStageDefinition<TInput, BsonDocument> GraphLookup<TInput, TFrom>(IMongoCollection<TFrom> from, FieldDefinition<TFrom, BsonValue> connectFromField, FieldDefinition<TFrom, BsonValue> connectToField, AggregateExpressionDefinition<TInput, BsonValue> startWith, FieldDefinition<BsonDocument, IEnumerable<BsonDocument>> @as, FieldDefinition<BsonDocument, int> depthField = null)

Parameters

from IMongoCollection<TFrom>

The from collection.

connectFromField FieldDefinition<TFrom, BsonValue>

The connect from field.

connectToField FieldDefinition<TFrom, BsonValue>

The connect to field.

startWith AggregateExpressionDefinition<TInput, BsonValue>

The start with value.

as FieldDefinition<BsonDocument, IEnumerable<BsonDocument>>

The as field.

depthField FieldDefinition<BsonDocument, int>

The depth field.

Returns

PipelineStageDefinition<TInput, BsonDocument>

The fluent aggregate interface.

Type Parameters

TInput

The type of the input documents.

TFrom

The type of the from documents.

GraphLookup<TInput, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TOutput>(IMongoCollection<TFrom>, FieldDefinition<TFrom, TConnectFrom>, FieldDefinition<TFrom, TConnectTo>, AggregateExpressionDefinition<TInput, TStartWith>, FieldDefinition<TOutput, TAs>, AggregateGraphLookupOptions<TFrom, TFrom, TOutput>)

Creates a $graphLookup stage.

public static PipelineStageDefinition<TInput, TOutput> GraphLookup<TInput, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TOutput>(IMongoCollection<TFrom> from, FieldDefinition<TFrom, TConnectFrom> connectFromField, FieldDefinition<TFrom, TConnectTo> connectToField, AggregateExpressionDefinition<TInput, TStartWith> startWith, FieldDefinition<TOutput, TAs> @as, AggregateGraphLookupOptions<TFrom, TFrom, TOutput> options = null) where TAs : IEnumerable<TFrom>

Parameters

from IMongoCollection<TFrom>

The from collection.

connectFromField FieldDefinition<TFrom, TConnectFrom>

The connect from field.

connectToField FieldDefinition<TFrom, TConnectTo>

The connect to field.

startWith AggregateExpressionDefinition<TInput, TStartWith>

The start with value.

as FieldDefinition<TOutput, TAs>

The as field.

options AggregateGraphLookupOptions<TFrom, TFrom, TOutput>

The options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TFrom

The type of the from documents.

TConnectFrom

The type of the connect from field (must be either TConnectTo or a type that implements IEnumerable{TConnectTo}).

TConnectTo

The type of the connect to field.

TStartWith

The type of the start with expression (must be either TConnectTo or a type that implements IEnumerable{TConnectTo}).

TAs

The type of the as field.

TOutput

The type of the output documents.

GraphLookup<TInput, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TOutput>(IMongoCollection<TFrom>, Expression<Func<TFrom, TConnectFrom>>, Expression<Func<TFrom, TConnectTo>>, Expression<Func<TInput, TStartWith>>, Expression<Func<TOutput, TAs>>, AggregateGraphLookupOptions<TFrom, TFrom, TOutput>, ExpressionTranslationOptions)

Creates a $graphLookup stage.

public static PipelineStageDefinition<TInput, TOutput> GraphLookup<TInput, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TOutput>(IMongoCollection<TFrom> from, Expression<Func<TFrom, TConnectFrom>> connectFromField, Expression<Func<TFrom, TConnectTo>> connectToField, Expression<Func<TInput, TStartWith>> startWith, Expression<Func<TOutput, TAs>> @as, AggregateGraphLookupOptions<TFrom, TFrom, TOutput> options = null, ExpressionTranslationOptions translationOptions = null) where TAs : IEnumerable<TFrom>

Parameters

from IMongoCollection<TFrom>

The from collection.

connectFromField Expression<Func<TFrom, TConnectFrom>>

The connect from field.

connectToField Expression<Func<TFrom, TConnectTo>>

The connect to field.

startWith Expression<Func<TInput, TStartWith>>

The start with value.

as Expression<Func<TOutput, TAs>>

The as field.

options AggregateGraphLookupOptions<TFrom, TFrom, TOutput>

The options.

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TFrom

The type of the from documents.

TConnectFrom

The type of the connect from field (must be either TConnectTo or a type that implements IEnumerable{TConnectTo}).

TConnectTo

The type of the connect to field.

TStartWith

The type of the start with expression (must be either TConnectTo or a type that implements IEnumerable{TConnectTo}).

TAs

The type of the as field.

TOutput

The type of the output documents.

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

Creates a $graphLookup stage.

public static PipelineStageDefinition<TInput, TOutput> GraphLookup<TInput, TFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TOutput>(IMongoCollection<TFrom> from, FieldDefinition<TFrom, TConnectFrom> connectFromField, FieldDefinition<TFrom, TConnectTo> connectToField, AggregateExpressionDefinition<TInput, TStartWith> startWith, FieldDefinition<TOutput, TAs> @as, FieldDefinition<TAsElement, int> depthField, AggregateGraphLookupOptions<TFrom, TAsElement, TOutput> options = null) where TAs : IEnumerable<TAsElement>

Parameters

from IMongoCollection<TFrom>

The from collection.

connectFromField FieldDefinition<TFrom, TConnectFrom>

The connect from field.

connectToField FieldDefinition<TFrom, TConnectTo>

The connect to field.

startWith AggregateExpressionDefinition<TInput, TStartWith>

The start with value.

as FieldDefinition<TOutput, TAs>

The as field.

depthField FieldDefinition<TAsElement, int>

The depth field.

options AggregateGraphLookupOptions<TFrom, TAsElement, TOutput>

The options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TFrom

The type of the from documents.

TConnectFrom

The type of the connect from field (must be either TConnectTo or a type that implements IEnumerable{TConnectTo}).

TConnectTo

The type of the connect to field.

TStartWith

The type of the start with expression (must be either TConnectTo or a type that implements IEnumerable{TConnectTo}).

TAsElement

The type of the as field elements.

TAs

The type of the as field.

TOutput

The type of the output documents.

GraphLookup<TInput, TFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TOutput>(IMongoCollection<TFrom>, Expression<Func<TFrom, TConnectFrom>>, Expression<Func<TFrom, TConnectTo>>, Expression<Func<TInput, TStartWith>>, Expression<Func<TOutput, TAs>>, Expression<Func<TAsElement, int>>, AggregateGraphLookupOptions<TFrom, TAsElement, TOutput>, ExpressionTranslationOptions)

Creates a $graphLookup stage.

public static PipelineStageDefinition<TInput, TOutput> GraphLookup<TInput, TFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TOutput>(IMongoCollection<TFrom> from, Expression<Func<TFrom, TConnectFrom>> connectFromField, Expression<Func<TFrom, TConnectTo>> connectToField, Expression<Func<TInput, TStartWith>> startWith, Expression<Func<TOutput, TAs>> @as, Expression<Func<TAsElement, int>> depthField, AggregateGraphLookupOptions<TFrom, TAsElement, TOutput> options = null, ExpressionTranslationOptions translationOptions = null) where TAs : IEnumerable<TAsElement>

Parameters

from IMongoCollection<TFrom>

The from collection.

connectFromField Expression<Func<TFrom, TConnectFrom>>

The connect from field.

connectToField Expression<Func<TFrom, TConnectTo>>

The connect to field.

startWith Expression<Func<TInput, TStartWith>>

The start with value.

as Expression<Func<TOutput, TAs>>

The as field.

depthField Expression<Func<TAsElement, int>>

The depth field.

options AggregateGraphLookupOptions<TFrom, TAsElement, TOutput>

The options.

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TFrom

The type of the from documents.

TConnectFrom

The type of the connect from field (must be either TConnectTo or a type that implements IEnumerable{TConnectTo}).

TConnectTo

The type of the connect to field.

TStartWith

The type of the start with expression (must be either TConnectTo or a type that implements IEnumerable{TConnectTo}).

TAsElement

The type of the as field elements.

TAs

The type of the as field.

TOutput

The type of the output documents.

Group<TInput>(ProjectionDefinition<TInput, BsonDocument>)

Creates a $group stage.

public static PipelineStageDefinition<TInput, BsonDocument> Group<TInput>(ProjectionDefinition<TInput, BsonDocument> group)

Parameters

group ProjectionDefinition<TInput, BsonDocument>

The group projection.

Returns

PipelineStageDefinition<TInput, BsonDocument>

The stage.

Type Parameters

TInput

The type of the input documents.

Group<TInput, TOutput>(ProjectionDefinition<TInput, TOutput>)

Creates a $group stage.

public static PipelineStageDefinition<TInput, TOutput> Group<TInput, TOutput>(ProjectionDefinition<TInput, TOutput> group)

Parameters

group ProjectionDefinition<TInput, TOutput>

The group projection.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

Group<TInput, TValue, TOutput>(Expression<Func<TInput, TValue>>, Expression<Func<IGrouping<TValue, TInput>, TOutput>>, ExpressionTranslationOptions)

Creates a $group stage (this method can only be used with LINQ2).

public static PipelineStageDefinition<TInput, TOutput> Group<TInput, TValue, TOutput>(Expression<Func<TInput, TValue>> value, Expression<Func<IGrouping<TValue, TInput>, TOutput>> group, ExpressionTranslationOptions translationOptions = null)

Parameters

value Expression<Func<TInput, TValue>>

The value field.

group Expression<Func<IGrouping<TValue, TInput>, TOutput>>

The group projection.

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TValue

The type of the values.

TOutput

The type of the output documents.

Remarks

This method can only be used with LINQ2 but that can't be verified until Render is called.

Limit<TInput>(long)

Creates a $limit stage.

public static PipelineStageDefinition<TInput, TInput> Limit<TInput>(long limit)

Parameters

limit long

The limit.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

Lookup<TInput, TForeignDocument, TOutput>(IMongoCollection<TForeignDocument>, FieldDefinition<TInput>, FieldDefinition<TForeignDocument>, FieldDefinition<TOutput>, AggregateLookupOptions<TForeignDocument, TOutput>)

Creates a $lookup stage.

public static PipelineStageDefinition<TInput, TOutput> Lookup<TInput, TForeignDocument, TOutput>(IMongoCollection<TForeignDocument> foreignCollection, FieldDefinition<TInput> localField, FieldDefinition<TForeignDocument> foreignField, FieldDefinition<TOutput> @as, AggregateLookupOptions<TForeignDocument, TOutput> options = null)

Parameters

foreignCollection IMongoCollection<TForeignDocument>

The foreign collection.

localField FieldDefinition<TInput>

The local field.

foreignField FieldDefinition<TForeignDocument>

The foreign field.

as FieldDefinition<TOutput>

The "as" field.

options AggregateLookupOptions<TForeignDocument, TOutput>

The options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TForeignDocument

The type of the foreign collection documents.

TOutput

The type of the output documents.

Lookup<TInput, TForeignDocument, TOutput>(IMongoCollection<TForeignDocument>, Expression<Func<TInput, object>>, Expression<Func<TForeignDocument, object>>, Expression<Func<TOutput, object>>, AggregateLookupOptions<TForeignDocument, TOutput>)

Creates a $lookup stage.

public static PipelineStageDefinition<TInput, TOutput> Lookup<TInput, TForeignDocument, TOutput>(IMongoCollection<TForeignDocument> foreignCollection, Expression<Func<TInput, object>> localField, Expression<Func<TForeignDocument, object>> foreignField, Expression<Func<TOutput, object>> @as, AggregateLookupOptions<TForeignDocument, TOutput> options = null)

Parameters

foreignCollection IMongoCollection<TForeignDocument>

The foreign collection.

localField Expression<Func<TInput, object>>

The local field.

foreignField Expression<Func<TForeignDocument, object>>

The foreign field.

as Expression<Func<TOutput, object>>

The "as" field.

options AggregateLookupOptions<TForeignDocument, TOutput>

The options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TForeignDocument

The type of the foreign collection documents.

TOutput

The type of the output documents.

Lookup<TInput, TForeignDocument, TAsElement, TAs, TOutput>(IMongoCollection<TForeignDocument>, BsonDocument, PipelineDefinition<TForeignDocument, TAsElement>, FieldDefinition<TOutput, TAs>, AggregateLookupOptions<TForeignDocument, TOutput>)

Creates a $lookup stage.

public static PipelineStageDefinition<TInput, TOutput> Lookup<TInput, TForeignDocument, TAsElement, TAs, TOutput>(IMongoCollection<TForeignDocument> foreignCollection, BsonDocument let, PipelineDefinition<TForeignDocument, TAsElement> lookupPipeline, FieldDefinition<TOutput, TAs> @as, AggregateLookupOptions<TForeignDocument, TOutput> options = null) where TAs : IEnumerable<TAsElement>

Parameters

foreignCollection IMongoCollection<TForeignDocument>

The foreign collection.

let BsonDocument

The "let" definition.

lookupPipeline PipelineDefinition<TForeignDocument, TAsElement>

The lookup pipeline.

as FieldDefinition<TOutput, TAs>

The as field in TOutput in which to place the results of the lookup pipeline.

options AggregateLookupOptions<TForeignDocument, TOutput>

The options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TForeignDocument

The type of the foreign collection documents.

TAsElement

The type of the as field elements.

TAs

The type of the as field.

TOutput

The type of the output documents.

Lookup<TInput, TForeignDocument, TAsElement, TAs, TOutput>(IMongoCollection<TForeignDocument>, BsonDocument, PipelineDefinition<TForeignDocument, TAsElement>, Expression<Func<TOutput, TAs>>, AggregateLookupOptions<TForeignDocument, TOutput>)

Creates a $lookup stage.

public static PipelineStageDefinition<TInput, TOutput> Lookup<TInput, TForeignDocument, TAsElement, TAs, TOutput>(IMongoCollection<TForeignDocument> foreignCollection, BsonDocument let, PipelineDefinition<TForeignDocument, TAsElement> lookupPipeline, Expression<Func<TOutput, TAs>> @as, AggregateLookupOptions<TForeignDocument, TOutput> options = null) where TAs : IEnumerable<TAsElement>

Parameters

foreignCollection IMongoCollection<TForeignDocument>

The foreign collection.

let BsonDocument

The "let" definition.

lookupPipeline PipelineDefinition<TForeignDocument, TAsElement>

The lookup pipeline.

as Expression<Func<TOutput, TAs>>

The as field in TOutput in which to place the results of the lookup pipeline.

options AggregateLookupOptions<TForeignDocument, TOutput>

The options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TForeignDocument

The type of the foreign collection documents.

TAsElement

The type of the as field elements.

TAs

The type of the as field.

TOutput

The type of the output documents.

Match<TInput>(FilterDefinition<TInput>)

Creates a $match stage.

public static PipelineStageDefinition<TInput, TInput> Match<TInput>(FilterDefinition<TInput> filter)

Parameters

filter FilterDefinition<TInput>

The filter.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

Match<TInput>(Expression<Func<TInput, bool>>)

Creates a $match stage.

public static PipelineStageDefinition<TInput, TInput> Match<TInput>(Expression<Func<TInput, bool>> filter)

Parameters

filter Expression<Func<TInput, bool>>

The filter.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

Merge<TInput, TOutput>(IMongoCollection<TOutput>, MergeStageOptions<TOutput>)

Creates a $merge stage.

public static PipelineStageDefinition<TInput, TOutput> Merge<TInput, TOutput>(IMongoCollection<TOutput> outputCollection, MergeStageOptions<TOutput> mergeOptions)

Parameters

outputCollection IMongoCollection<TOutput>

The output collection.

mergeOptions MergeStageOptions<TOutput>

The merge options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

OfType<TInput, TOutput>(IBsonSerializer<TOutput>)

Create a $match stage that select documents of a sub type.

public static PipelineStageDefinition<TInput, TOutput> OfType<TInput, TOutput>(IBsonSerializer<TOutput> outputSerializer = null) where TOutput : TInput

Parameters

outputSerializer IBsonSerializer<TOutput>

The output serializer.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

Out<TInput>(IMongoCollection<TInput>)

Creates a $out stage.

public static PipelineStageDefinition<TInput, TInput> Out<TInput>(IMongoCollection<TInput> outputCollection)

Parameters

outputCollection IMongoCollection<TInput>

The output collection.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

Project<TInput>(ProjectionDefinition<TInput, BsonDocument>)

Creates a $project stage.

public static PipelineStageDefinition<TInput, BsonDocument> Project<TInput>(ProjectionDefinition<TInput, BsonDocument> projection)

Parameters

projection ProjectionDefinition<TInput, BsonDocument>

The projection.

Returns

PipelineStageDefinition<TInput, BsonDocument>

The stage.

Type Parameters

TInput

The type of the input documents.

Project<TInput, TOutput>(ProjectionDefinition<TInput, TOutput>)

Creates a $project stage.

public static PipelineStageDefinition<TInput, TOutput> Project<TInput, TOutput>(ProjectionDefinition<TInput, TOutput> projection)

Parameters

projection ProjectionDefinition<TInput, TOutput>

The projection.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

Project<TInput, TOutput>(Expression<Func<TInput, TOutput>>, ExpressionTranslationOptions)

Creates a $project stage.

public static PipelineStageDefinition<TInput, TOutput> Project<TInput, TOutput>(Expression<Func<TInput, TOutput>> projection, ExpressionTranslationOptions translationOptions = null)

Parameters

projection Expression<Func<TInput, TOutput>>

The projection.

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

ReplaceRoot<TInput, TOutput>(AggregateExpressionDefinition<TInput, TOutput>)

Creates a $replaceRoot stage.

public static PipelineStageDefinition<TInput, TOutput> ReplaceRoot<TInput, TOutput>(AggregateExpressionDefinition<TInput, TOutput> newRoot)

Parameters

newRoot AggregateExpressionDefinition<TInput, TOutput>

The new root.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

ReplaceRoot<TInput, TOutput>(Expression<Func<TInput, TOutput>>, ExpressionTranslationOptions)

Creates a $replaceRoot stage.

public static PipelineStageDefinition<TInput, TOutput> ReplaceRoot<TInput, TOutput>(Expression<Func<TInput, TOutput>> newRoot, ExpressionTranslationOptions translationOptions = null)

Parameters

newRoot Expression<Func<TInput, TOutput>>

The new root.

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

ReplaceWith<TInput, TOutput>(AggregateExpressionDefinition<TInput, TOutput>)

Creates a $replaceWith stage.

public static PipelineStageDefinition<TInput, TOutput> ReplaceWith<TInput, TOutput>(AggregateExpressionDefinition<TInput, TOutput> newRoot)

Parameters

newRoot AggregateExpressionDefinition<TInput, TOutput>

The new root.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

ReplaceWith<TInput, TOutput>(Expression<Func<TInput, TOutput>>, ExpressionTranslationOptions)

Creates a $replaceWith stage.

public static PipelineStageDefinition<TInput, TOutput> ReplaceWith<TInput, TOutput>(Expression<Func<TInput, TOutput>> newRoot, ExpressionTranslationOptions translationOptions = null)

Parameters

newRoot Expression<Func<TInput, TOutput>>

The new root.

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

SearchMeta<TInput>(SearchDefinition<TInput>, string, SearchCountOptions)

Creates a $searchMeta stage.

public static PipelineStageDefinition<TInput, SearchMetaResult> SearchMeta<TInput>(SearchDefinition<TInput> searchDefinition, string indexName = null, SearchCountOptions count = null)

Parameters

searchDefinition SearchDefinition<TInput>

The search definition.

indexName string

The index name.

count SearchCountOptions

The count options.

Returns

PipelineStageDefinition<TInput, SearchMetaResult>

The stage.

Type Parameters

TInput

The type of the input documents.

Search<TInput>(SearchDefinition<TInput>, SearchHighlightOptions<TInput>, string, SearchCountOptions, bool, bool)

Creates a $search stage.

public static PipelineStageDefinition<TInput, TInput> Search<TInput>(SearchDefinition<TInput> searchDefinition, SearchHighlightOptions<TInput> highlight = null, string indexName = null, SearchCountOptions count = null, bool returnStoredSource = false, bool scoreDetails = false)

Parameters

searchDefinition SearchDefinition<TInput>

The search definition.

highlight SearchHighlightOptions<TInput>

The highlight options.

indexName string

The index name.

count SearchCountOptions

The count options.

returnStoredSource bool

Flag that specifies whether to perform a full document lookup on the backend database or return only stored source fields directly from Atlas Search.

scoreDetails bool

Flag that specifies whether to return a detailed breakdown of the score for each document in the result.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

Search<TInput>(SearchDefinition<TInput>, SearchOptions<TInput>)

Creates a $search stage.

public static PipelineStageDefinition<TInput, TInput> Search<TInput>(SearchDefinition<TInput> searchDefinition, SearchOptions<TInput> searchOptions)

Parameters

searchDefinition SearchDefinition<TInput>

The search definition.

searchOptions SearchOptions<TInput>

The search options.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

SetWindowFields<TInput, TWindowFields>(AggregateExpressionDefinition<ISetWindowFieldsPartition<TInput>, TWindowFields>)

Create a $setWindowFields stage.

public static PipelineStageDefinition<TInput, BsonDocument> SetWindowFields<TInput, TWindowFields>(AggregateExpressionDefinition<ISetWindowFieldsPartition<TInput>, TWindowFields> output)

Parameters

output AggregateExpressionDefinition<ISetWindowFieldsPartition<TInput>, TWindowFields>

The window fields expression.

Returns

PipelineStageDefinition<TInput, BsonDocument>

The stage.

Type Parameters

TInput

The type of the input documents.

TWindowFields

The type of the added window fields.

SetWindowFields<TInput, TWindowFields>(Expression<Func<ISetWindowFieldsPartition<TInput>, TWindowFields>>, ExpressionTranslationOptions)

Create a $setWindowFields stage.

public static PipelineStageDefinition<TInput, BsonDocument> SetWindowFields<TInput, TWindowFields>(Expression<Func<ISetWindowFieldsPartition<TInput>, TWindowFields>> output, ExpressionTranslationOptions translationOptions = null)

Parameters

output Expression<Func<ISetWindowFieldsPartition<TInput>, TWindowFields>>

The window fields expression.

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, BsonDocument>

The stage.

Type Parameters

TInput

The type of the input documents.

TWindowFields

The type of the added window fields.

SetWindowFields<TInput, TPartitionBy, TWindowFields>(AggregateExpressionDefinition<TInput, TPartitionBy>, AggregateExpressionDefinition<ISetWindowFieldsPartition<TInput>, TWindowFields>)

Create a $setWindowFields stage.

public static PipelineStageDefinition<TInput, BsonDocument> SetWindowFields<TInput, TPartitionBy, TWindowFields>(AggregateExpressionDefinition<TInput, TPartitionBy> partitionBy, AggregateExpressionDefinition<ISetWindowFieldsPartition<TInput>, TWindowFields> output)

Parameters

partitionBy AggregateExpressionDefinition<TInput, TPartitionBy>

The partitionBy expression.

output AggregateExpressionDefinition<ISetWindowFieldsPartition<TInput>, TWindowFields>

The window fields expression.

Returns

PipelineStageDefinition<TInput, BsonDocument>

The stage.

Type Parameters

TInput

The type of the input documents.

TPartitionBy

The type of the value to partition by.

TWindowFields

The type of the added window fields.

SetWindowFields<TInput, TPartitionBy, TWindowFields>(AggregateExpressionDefinition<TInput, TPartitionBy>, SortDefinition<TInput>, AggregateExpressionDefinition<ISetWindowFieldsPartition<TInput>, TWindowFields>)

Create a $setWindowFields stage.

public static PipelineStageDefinition<TInput, BsonDocument> SetWindowFields<TInput, TPartitionBy, TWindowFields>(AggregateExpressionDefinition<TInput, TPartitionBy> partitionBy, SortDefinition<TInput> sortBy, AggregateExpressionDefinition<ISetWindowFieldsPartition<TInput>, TWindowFields> output)

Parameters

partitionBy AggregateExpressionDefinition<TInput, TPartitionBy>

The partitionBy expression.

sortBy SortDefinition<TInput>

The sortBy expression.

output AggregateExpressionDefinition<ISetWindowFieldsPartition<TInput>, TWindowFields>

The window fields expression.

Returns

PipelineStageDefinition<TInput, BsonDocument>

The stage.

Type Parameters

TInput

The type of the input documents.

TPartitionBy

The type of the value to partition by.

TWindowFields

The type of the added window fields.

SetWindowFields<TInput, TPartitionBy, TWindowFields>(Expression<Func<TInput, TPartitionBy>>, SortDefinition<TInput>, Expression<Func<ISetWindowFieldsPartition<TInput>, TWindowFields>>, ExpressionTranslationOptions)

Create a $setWindowFields stage.

public static PipelineStageDefinition<TInput, BsonDocument> SetWindowFields<TInput, TPartitionBy, TWindowFields>(Expression<Func<TInput, TPartitionBy>> partitionBy, SortDefinition<TInput> sortBy, Expression<Func<ISetWindowFieldsPartition<TInput>, TWindowFields>> output, ExpressionTranslationOptions translationOptions = null)

Parameters

partitionBy Expression<Func<TInput, TPartitionBy>>

The partitionBy expression.

sortBy SortDefinition<TInput>

The sortBy expression.

output Expression<Func<ISetWindowFieldsPartition<TInput>, TWindowFields>>

The window fields expression.

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, BsonDocument>

The stage.

Type Parameters

TInput

The type of the input documents.

TPartitionBy

The type of the value to partition by.

TWindowFields

The type of the added window fields.

SetWindowFields<TInput, TPartitionBy, TWindowFields>(Expression<Func<TInput, TPartitionBy>>, Expression<Func<ISetWindowFieldsPartition<TInput>, TWindowFields>>, ExpressionTranslationOptions)

Create a $setWindowFields stage.

public static PipelineStageDefinition<TInput, BsonDocument> SetWindowFields<TInput, TPartitionBy, TWindowFields>(Expression<Func<TInput, TPartitionBy>> partitionBy, Expression<Func<ISetWindowFieldsPartition<TInput>, TWindowFields>> output, ExpressionTranslationOptions translationOptions = null)

Parameters

partitionBy Expression<Func<TInput, TPartitionBy>>

The partitionBy expression.

output Expression<Func<ISetWindowFieldsPartition<TInput>, TWindowFields>>

The window fields expression.

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, BsonDocument>

The stage.

Type Parameters

TInput

The type of the input documents.

TPartitionBy

The type of the value to partition by.

TWindowFields

The type of the added window fields.

Set<TInput>(SetFieldDefinitions<TInput>)

Creates a $set stage.

public static PipelineStageDefinition<TInput, TInput> Set<TInput>(SetFieldDefinitions<TInput> fields)

Parameters

fields SetFieldDefinitions<TInput>

The fields to set.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

Set<TInput, TFields>(Expression<Func<TInput, TFields>>)

Creates a $set stage.

public static PipelineStageDefinition<TInput, TInput> Set<TInput, TFields>(Expression<Func<TInput, TFields>> fields)

Parameters

fields Expression<Func<TInput, TFields>>

The fields to set.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

TFields

The type of object specifying the fields to set.

Skip<TInput>(long)

Creates a $skip stage.

public static PipelineStageDefinition<TInput, TInput> Skip<TInput>(long skip)

Parameters

skip long

The skip.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

SortByCount<TInput, TValue>(AggregateExpressionDefinition<TInput, TValue>)

Creates a $sortByCount stage.

public static PipelineStageDefinition<TInput, AggregateSortByCountResult<TValue>> SortByCount<TInput, TValue>(AggregateExpressionDefinition<TInput, TValue> value)

Parameters

value AggregateExpressionDefinition<TInput, TValue>

The value expression.

Returns

PipelineStageDefinition<TInput, AggregateSortByCountResult<TValue>>

The stage.

Type Parameters

TInput

The type of the input documents.

TValue

The type of the values.

SortByCount<TInput, TValue>(Expression<Func<TInput, TValue>>, ExpressionTranslationOptions)

Creates a $sortByCount stage.

public static PipelineStageDefinition<TInput, AggregateSortByCountResult<TValue>> SortByCount<TInput, TValue>(Expression<Func<TInput, TValue>> value, ExpressionTranslationOptions translationOptions = null)

Parameters

value Expression<Func<TInput, TValue>>

The value.

translationOptions ExpressionTranslationOptions

The translation options.

Returns

PipelineStageDefinition<TInput, AggregateSortByCountResult<TValue>>

The stage.

Type Parameters

TInput

The type of the input documents.

TValue

The type of the values.

Sort<TInput>(SortDefinition<TInput>)

Creates a $sort stage.

public static PipelineStageDefinition<TInput, TInput> Sort<TInput>(SortDefinition<TInput> sort)

Parameters

sort SortDefinition<TInput>

The sort.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

UnionWith<TInput, TWith>(IMongoCollection<TWith>, PipelineDefinition<TWith, TInput>)

Creates a $unionWith stage.

public static PipelineStageDefinition<TInput, TInput> UnionWith<TInput, TWith>(IMongoCollection<TWith> withCollection, PipelineDefinition<TWith, TInput> withPipeline = null)

Parameters

withCollection IMongoCollection<TWith>

The with collection.

withPipeline PipelineDefinition<TWith, TInput>

The with pipeline.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

TWith

The type of the with collection documents.

Unwind<TInput>(FieldDefinition<TInput>, AggregateUnwindOptions<BsonDocument>)

Creates an $unwind stage.

public static PipelineStageDefinition<TInput, BsonDocument> Unwind<TInput>(FieldDefinition<TInput> field, AggregateUnwindOptions<BsonDocument> options = null)

Parameters

field FieldDefinition<TInput>

The field to unwind.

options AggregateUnwindOptions<BsonDocument>

The options.

Returns

PipelineStageDefinition<TInput, BsonDocument>

The stage.

Type Parameters

TInput

The type of the input documents.

Unwind<TInput>(Expression<Func<TInput, object>>, AggregateUnwindOptions<BsonDocument>)

Creates an $unwind stage.

public static PipelineStageDefinition<TInput, BsonDocument> Unwind<TInput>(Expression<Func<TInput, object>> field, AggregateUnwindOptions<BsonDocument> options = null)

Parameters

field Expression<Func<TInput, object>>

The field to unwind.

options AggregateUnwindOptions<BsonDocument>

The options.

Returns

PipelineStageDefinition<TInput, BsonDocument>

The stage.

Type Parameters

TInput

The type of the input documents.

Unwind<TInput, TOutput>(FieldDefinition<TInput>, AggregateUnwindOptions<TOutput>)

Creates an $unwind stage.

public static PipelineStageDefinition<TInput, TOutput> Unwind<TInput, TOutput>(FieldDefinition<TInput> field, AggregateUnwindOptions<TOutput> options = null)

Parameters

field FieldDefinition<TInput>

The field.

options AggregateUnwindOptions<TOutput>

The options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

Unwind<TInput, TOutput>(Expression<Func<TInput, object>>, AggregateUnwindOptions<TOutput>)

Creates an $unwind stage.

public static PipelineStageDefinition<TInput, TOutput> Unwind<TInput, TOutput>(Expression<Func<TInput, object>> field, AggregateUnwindOptions<TOutput> options = null)

Parameters

field Expression<Func<TInput, object>>

The field to unwind.

options AggregateUnwindOptions<TOutput>

The options.

Returns

PipelineStageDefinition<TInput, TOutput>

The stage.

Type Parameters

TInput

The type of the input documents.

TOutput

The type of the output documents.

VectorSearch<TInput>(FieldDefinition<TInput>, QueryVector, int, VectorSearchOptions<TInput>)

Creates a $vectorSearch stage.

public static PipelineStageDefinition<TInput, TInput> VectorSearch<TInput>(FieldDefinition<TInput> field, QueryVector queryVector, int limit, VectorSearchOptions<TInput> options = null)

Parameters

field FieldDefinition<TInput>

The field.

queryVector QueryVector

The query vector.

limit int

The limit.

options VectorSearchOptions<TInput>

The options.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

VectorSearch<TInput, TField>(Expression<Func<TInput, TField>>, QueryVector, int, VectorSearchOptions<TInput>)

Creates a $vectorSearch stage.

public static PipelineStageDefinition<TInput, TInput> VectorSearch<TInput, TField>(Expression<Func<TInput, TField>> field, QueryVector queryVector, int limit, VectorSearchOptions<TInput> options)

Parameters

field Expression<Func<TInput, TField>>

The field.

queryVector QueryVector

The query vector.

limit int

The limit.

options VectorSearchOptions<TInput>

The options.

Returns

PipelineStageDefinition<TInput, TInput>

The stage.

Type Parameters

TInput

The type of the input documents.

TField

The type of the field.