PipelineStageDefinitionBuilderGraphLookupTInput, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TOutput Method (IMongoCollectionTFrom, FieldDefinitionTFrom, TConnectFrom, FieldDefinitionTFrom, TConnectTo, AggregateExpressionDefinitionTInput, TStartWith, FieldDefinitionTOutput, TAs, AggregateGraphLookupOptionsTFrom, TFrom, TOutput) |
Creates a $graphLookup stage.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.15.0+f503bf610759c13f78cff9a3c01e91453185d2ed
Syntax public static PipelineStageDefinition<TInput, TOutput> GraphLookup<TInput, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TOutput>(
IMongoCollection<TFrom> from,
FieldDefinition<TFrom, TConnectFrom> connectFromField,
FieldDefinition<TFrom, TConnectTo> connectToField,
AggregateExpressionDefinition<TInput, TStartWith> startWith,
FieldDefinition<TOutput, TAs> as,
AggregateGraphLookupOptions<TFrom, TFrom, TOutput> options = null
)
where TAs : Object, IEnumerable<TFrom>
Public Shared Function GraphLookup(Of TInput, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs As {Object, IEnumerable(Of TFrom)}, TOutput) (
from As IMongoCollection(Of TFrom),
connectFromField As FieldDefinition(Of TFrom, TConnectFrom),
connectToField As FieldDefinition(Of TFrom, TConnectTo),
startWith As AggregateExpressionDefinition(Of TInput, TStartWith),
as As FieldDefinition(Of TOutput, TAs),
Optional options As AggregateGraphLookupOptions(Of TFrom, TFrom, TOutput) = Nothing
) As PipelineStageDefinition(Of TInput, TOutput)
static member GraphLookup :
from : IMongoCollection<'TFrom> *
connectFromField : FieldDefinition<'TFrom, 'TConnectFrom> *
connectToField : FieldDefinition<'TFrom, 'TConnectTo> *
startWith : AggregateExpressionDefinition<'TInput, 'TStartWith> *
as : FieldDefinition<'TOutput, 'TAs> *
?options : AggregateGraphLookupOptions<'TFrom, 'TFrom, 'TOutput>
(* Defaults:
let _options = defaultArg options null
*)
-> PipelineStageDefinition<'TInput, 'TOutput> when 'TAs : Object and IEnumerable<'TFrom>
Parameters
- 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.DriverAggregateExpressionDefinitionTInput, TStartWith
The start with value. - as
- Type: MongoDB.DriverFieldDefinitionTOutput, TAs
The as field. - options (Optional)
- Type: MongoDB.DriverAggregateGraphLookupOptionsTFrom, TFrom, TOutput
The options.
Type Parameters
- TInput
- The type of the input documents.
- 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.
- TOutput
- The type of the output documents.
Return Value
Type:
PipelineStageDefinitionTInput,
TOutputThe stage.
See Also