Click or drag to resize

IAggregateFluentExtensionsGraphLookupTResult, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TNewResult Method (IAggregateFluentTResult, IMongoCollectionTFrom, FieldDefinitionTFrom, TConnectFrom, FieldDefinitionTFrom, TConnectTo, AggregateExpressionDefinitionTResult, TStartWith, FieldDefinitionTNewResult, TAs, AggregateGraphLookupOptionsTFrom, TFrom, TNewResult)

Appends a $graphLookup stage to the pipeline.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax
public static IAggregateFluent<TNewResult> GraphLookup<TResult, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TNewResult>(
	this IAggregateFluent<TResult> aggregate,
	IMongoCollection<TFrom> from,
	FieldDefinition<TFrom, TConnectFrom> connectFromField,
	FieldDefinition<TFrom, TConnectTo> connectToField,
	AggregateExpressionDefinition<TResult, TStartWith> startWith,
	FieldDefinition<TNewResult, TAs> as,
	AggregateGraphLookupOptions<TFrom, TFrom, TNewResult> options = null
)
where TAs : Object, IEnumerable<TFrom>

Parameters

aggregate
Type: MongoDB.DriverIAggregateFluentTResult
The aggregate.
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.DriverAggregateExpressionDefinitionTResult, TStartWith
The start with value.
as
Type: MongoDB.DriverFieldDefinitionTNewResult, TAs
The as field.
options (Optional)
Type: MongoDB.DriverAggregateGraphLookupOptionsTFrom, TFrom, TNewResult
The options.

Type Parameters

TResult
The type of the result.
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.
TNewResult
The type of the new result (must be same as TResult with an additional as field).

Return Value

Type: IAggregateFluentTNewResult
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 IAggregateFluentTResult. 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