Click or drag to resize

PipelineDefinitionBuilder.GraphLookup<TInput, TIntermediate, TFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TOutput> Method (PipelineDefinition<TInput, TIntermediate>, IMongoCollection<TFrom>, FieldDefinition<TFrom, TConnectFrom>, FieldDefinition<TFrom, TConnectTo>, AggregateExpressionDefinition<TIntermediate, TStartWith>, FieldDefinition<TOutput, TAs>, FieldDefinition<TAsElement, Int32>, AggregateGraphLookupOptions<TFrom, TAsElement, TOutput>)

Appends a $graphLookup stage to the pipeline.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.6.0+Branch.origin/v2.6.x.Sha.593796a7b35dc59243383bcc684de296a5468f2e
Syntax
public static PipelineDefinition<TInput, TOutput> GraphLookup<TInput, TIntermediate, TFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TOutput>(
	this PipelineDefinition<TInput, TIntermediate> pipeline,
	IMongoCollection<TFrom> from,
	FieldDefinition<TFrom, TConnectFrom> connectFromField,
	FieldDefinition<TFrom, TConnectTo> connectToField,
	AggregateExpressionDefinition<TIntermediate, TStartWith> startWith,
	FieldDefinition<TOutput, TAs> as,
	FieldDefinition<TAsElement, int> depthField,
	AggregateGraphLookupOptions<TFrom, TAsElement, TOutput> options = null
)
where TAs : Object, IEnumerable<TAsElement>

Parameters

pipeline
Type: MongoDB.Driver.PipelineDefinition<TInput, TIntermediate>
The pipeline.
from
Type: MongoDB.Driver.IMongoCollection<TFrom>
The from collection.
connectFromField
Type: MongoDB.Driver.FieldDefinition<TFrom, TConnectFrom>
The connect from field.
connectToField
Type: MongoDB.Driver.FieldDefinition<TFrom, TConnectTo>
The connect to field.
startWith
Type: MongoDB.Driver.AggregateExpressionDefinition<TIntermediate, TStartWith>
The start with value.
as
Type: MongoDB.Driver.FieldDefinition<TOutput, TAs>
The as field.
depthField
Type: MongoDB.Driver.FieldDefinition<TAsElement, Int32>
The depth field.
options (Optional)
Type: MongoDB.Driver.AggregateGraphLookupOptions<TFrom, TAsElement, TOutput>
The options.

Type Parameters

TInput
The type of the input documents.
TIntermediate
The type of the intermediate 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.

Return Value

Type: PipelineDefinition<TInput, TOutput>
The fluent aggregate interface.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type PipelineDefinition<TInput, TIntermediate>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
See Also