IAggregateFluentExtensionsGraphLookupTResult, TFrom Method (IAggregateFluentTResult, IMongoCollectionTFrom, FieldDefinitionTFrom, BsonValue, FieldDefinitionTFrom, BsonValue, AggregateExpressionDefinitionTResult, BsonValue, FieldDefinitionBsonDocument, IEnumerableBsonDocument, FieldDefinitionBsonDocument, Int32) (original) (raw)
Appends a $graphLookup stage to the pipeline.
Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed
Syntax
public static IAggregateFluent GraphLookup<TResult, TFrom>( this IAggregateFluent aggregate, IMongoCollection from, FieldDefinition<TFrom, BsonValue> connectFromField, FieldDefinition<TFrom, BsonValue> connectToField, AggregateExpressionDefinition<TResult, BsonValue> startWith, FieldDefinition<BsonDocument, IEnumerable> as, FieldDefinition<BsonDocument, int> depthField = null )
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)[] 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> * ?depthField : FieldDefinition<BsonDocument, int> (* Defaults: let _depthField = defaultArg depthField null *) -> IAggregateFluent
Parameters
aggregate
Type: MongoDB.DriverIAggregateFluentTResult
The aggregate.
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.DriverAggregateExpressionDefinitionTResult, BsonValue
The start with value.
as
Type: MongoDB.DriverFieldDefinitionBsonDocument, IEnumerableBsonDocument
The as field.
depthField (Optional)
Type: MongoDB.DriverFieldDefinitionBsonDocument, Int32
The depth field.
Type Parameters
TResult
The type of the result.
TFrom
The type of the from documents.
Return Value
Type: IAggregateFluentBsonDocument
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