Click or drag to resize

PipelineDefinitionBuilderLookupTInput, TIntermediate, TForeignDocument, TOutput Method (PipelineDefinitionTInput, TIntermediate, IMongoCollectionTForeignDocument, FieldDefinitionTIntermediate, FieldDefinitionTForeignDocument, FieldDefinitionTOutput, AggregateLookupOptionsTForeignDocument, TOutput)

Appends a $lookup stage to the pipeline.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax
public static PipelineDefinition<TInput, TOutput> Lookup<TInput, TIntermediate, TForeignDocument, TOutput>(
	this PipelineDefinition<TInput, TIntermediate> pipeline,
	IMongoCollection<TForeignDocument> foreignCollection,
	FieldDefinition<TIntermediate> localField,
	FieldDefinition<TForeignDocument> foreignField,
	FieldDefinition<TOutput> as,
	AggregateLookupOptions<TForeignDocument, TOutput> options = null
)

Parameters

pipeline
Type: MongoDB.DriverPipelineDefinitionTInput, TIntermediate
The pipeline.
foreignCollection
Type: MongoDB.DriverIMongoCollectionTForeignDocument
The foreign collection.
localField
Type: MongoDB.DriverFieldDefinitionTIntermediate
The local field.
foreignField
Type: MongoDB.DriverFieldDefinitionTForeignDocument
The foreign field.
as
Type: MongoDB.DriverFieldDefinitionTOutput
The "as" field.
options (Optional)
Type: MongoDB.DriverAggregateLookupOptionsTForeignDocument, TOutput
The options.

Type Parameters

TInput
The type of the input documents.
TIntermediate
The type of the intermediate documents.
TForeignDocument
The type of the foreign collection documents.
TOutput
The type of the output documents.

Return Value

Type: PipelineDefinitionTInput, TOutput
A new pipeline with an additional 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