Click or drag to resize

PipelineDefinitionBuilderGraphLookupTInput, TIntermediate, TFrom Method (PipelineDefinitionTInput, TIntermediate, IMongoCollectionTFrom, FieldDefinitionTFrom, BsonValue, FieldDefinitionTFrom, BsonValue, AggregateExpressionDefinitionTIntermediate, BsonValue, FieldDefinitionBsonDocument, IEnumerableBsonDocument, FieldDefinitionBsonDocument, Int32)

Appends a $graphLookup stage to the pipeline.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
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.DriverPipelineDefinitionTInput, TIntermediate
The pipeline.
from
Type: MongoDB.DriverIMongoCollectionTFrom
The from collection.
connectFromField
Type: MongoDB.DriverFieldDefinitionTFrom, BsonValue
The connect from field.
connectToField
Type: MongoDB.DriverFieldDefinitionTFrom, BsonValue
The connect to field.
startWith
Type: MongoDB.DriverAggregateExpressionDefinitionTIntermediate, BsonValue
The start with value.
as
Type: MongoDB.DriverFieldDefinitionBsonDocument, IEnumerableBsonDocument
The as field.
depthField (Optional)
Type: MongoDB.DriverFieldDefinitionBsonDocument, 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: PipelineDefinitionTInput, 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 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