Method GraphLookup

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

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>)

Appends a $graphLookup stage to the pipeline.

public virtual 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>

The from collection.

connectFromField FieldDefinition<TFrom, TConnectFrom>

The connect from field.

connectToField FieldDefinition<TFrom, TConnectTo>

The connect to field.

startWith AggregateExpressionDefinition<TResult, TStartWith>

The start with value.

as FieldDefinition<TNewResult, TAs>

The as field.

depthField FieldDefinition<TAsElement, int>

The depth field.

options AggregateGraphLookupOptions<TFrom, TAsElement, TNewResult>

The options.

Returns

IAggregateFluent<TNewResult>

The fluent aggregate interface.

Type Parameters

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.

TNewResult

The type of the new result (must be same as TResult with an additional as field).