Click or drag to resize

PipelineDefinitionBuilderGraphLookupTInput, TIntermediate, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TOutput Method (PipelineDefinitionTInput, TIntermediate, IMongoCollectionTFrom, FieldDefinitionTFrom, TConnectFrom, FieldDefinitionTFrom, TConnectTo, AggregateExpressionDefinitionTIntermediate, TStartWith, FieldDefinitionTOutput, TAs, AggregateGraphLookupOptionsTFrom, TFrom, TOutput)

Appends a $graphLookup stage to the pipeline.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.5.0+57.Branch.master.Sha.6a4e00a2d91090c65a9b11364b9ebfdb9c7da076
Syntax
public static PipelineDefinition<TInput, TOutput> GraphLookup<TInput, TIntermediate, TFrom, TConnectFrom, TConnectTo, TStartWith, 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,
	AggregateGraphLookupOptions<TFrom, TFrom, TOutput> options = null
)
where TAs : Object, IEnumerable<TFrom>

Parameters

pipeline
Type: MongoDB.DriverPipelineDefinitionTInput, TIntermediate
The pipeline.
from
Type: MongoDB.DriverIMongoCollectionTFrom
The from collection.
connectFromField
Type: MongoDB.DriverFieldDefinitionTFrom, TConnectFrom
The connect from field.
connectToField
Type: MongoDB.DriverFieldDefinitionTFrom, TConnectTo
The connect to field.
startWith
Type: MongoDB.DriverAggregateExpressionDefinitionTIntermediate, TStartWith
The start with value.
as
Type: MongoDB.DriverFieldDefinitionTOutput, TAs
The as field.
options (Optional)
Type: MongoDB.DriverAggregateGraphLookupOptionsTFrom, TFrom, 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}).
TAs
The type of the as field.
TOutput
The type of the output documents.

Return Value

Type: PipelineDefinitionTInput, TOutput
The stage.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type PipelineDefinitionTInput, 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