IAggregateFluentExtensions.GraphLookup<TResult, TFrom> Method (IAggregateFluent<TResult>, IMongoCollection<TFrom>, FieldDefinition<TFrom, BsonValue>, FieldDefinition<TFrom, BsonValue>, AggregateExpressionDefinition<TResult, 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.5.0+57.Branch.master.Sha.6a4e00a2d91090c65a9b11364b9ebfdb9c7da076
Syntax public static IAggregateFluent<BsonDocument> GraphLookup<TResult, TFrom>(
this IAggregateFluent<TResult> aggregate,
IMongoCollection<TFrom> from,
FieldDefinition<TFrom, BsonValue> connectFromField,
FieldDefinition<TFrom, BsonValue> connectToField,
AggregateExpressionDefinition<TResult, BsonValue> startWith,
FieldDefinition<BsonDocument, IEnumerable<BsonDocument>> as,
FieldDefinition<BsonDocument, int> depthField = null
)
<ExtensionAttribute>
Public Shared Function GraphLookup(Of TResult, TFrom) (
aggregate As IAggregateFluent(Of TResult),
from As IMongoCollection(Of TFrom),
connectFromField As FieldDefinition(Of TFrom, BsonValue),
connectToField As FieldDefinition(Of TFrom, BsonValue),
startWith As AggregateExpressionDefinition(Of TResult, BsonValue),
as As FieldDefinition(Of BsonDocument, IEnumerable(Of BsonDocument)),
Optional depthField As FieldDefinition(Of BsonDocument, Integer) = Nothing
) As IAggregateFluent(Of BsonDocument)
[<ExtensionAttribute>]
static member GraphLookup :
aggregate : IAggregateFluent<'TResult> *
from : IMongoCollection<'TFrom> *
connectFromField : FieldDefinition<'TFrom, BsonValue> *
connectToField : FieldDefinition<'TFrom, BsonValue> *
startWith : AggregateExpressionDefinition<'TResult, BsonValue> *
as : FieldDefinition<BsonDocument, IEnumerable<BsonDocument>> *
?depthField : FieldDefinition<BsonDocument, int>
(* Defaults:
let _depthField = defaultArg depthField null
*)
-> IAggregateFluent<BsonDocument>
Parameters
- aggregate
- Type: MongoDB.Driver.IAggregateFluent<TResult>
The aggregate. - 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<TResult, 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
- TResult
- The type of the result.
- TFrom
- The type of the from documents.
Return Value
Type:
IAggregateFluent<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
IAggregateFluent<TResult>. 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