Click or drag to resize

PipelineDefinitionBuilder.GraphLookup<TInput, TIntermediate, TFrom> Method (PipelineDefinition<TInput, TIntermediate>, IMongoCollection<TFrom>, FieldDefinition<TFrom, BsonValue>, FieldDefinition<TFrom, BsonValue>, AggregateExpressionDefinition<TIntermediate, BsonValue>, FieldDefinition<BsonDocument, IEnumerable<BsonDocument>>, FieldDefinition<BsonDocument, Int32>)

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, BsonDocument> GraphLookup<TInput, TIntermediate, TFrom>(
	this PipelineDefinition<TInput, TIntermediate> pipeline,
	IMongoCollection<TFrom> from,
	FieldDefinition<TFrom, BsonValue> connectFromField,
	FieldDefinition<TFrom, BsonValue> connectToField,
	AggregateExpressionDefinition<TIntermediate, BsonValue> startWith,
	FieldDefinition<BsonDocument, IEnumerable<BsonDocument>> as,
	FieldDefinition<BsonDocument, int> depthField = null
)

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, BsonValue>
The connect from field.
connectToField
Type: MongoDB.Driver.FieldDefinition<TFrom, BsonValue>
The connect to field.
startWith
Type: MongoDB.Driver.AggregateExpressionDefinition<TIntermediate, BsonValue>
The start with value.
as
Type: MongoDB.Driver.FieldDefinition<BsonDocument, IEnumerable<BsonDocument>>
The as field.
depthField (Optional)
Type: MongoDB.Driver.FieldDefinition<BsonDocument, Int32>
The depth field.

Type Parameters

TInput
The type of the input documents.
TIntermediate
The type of the intermediate documents.
TFrom
The type of the from documents.

Return Value

Type: PipelineDefinition<TInput, BsonDocument>
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