IAggregateFluentTResultLookupTForeignDocument, TNewResult Method (String, FieldDefinitionTResult, FieldDefinitionTForeignDocument, FieldDefinitionTNewResult, AggregateLookupOptionsTForeignDocument, TNewResult) |
Appends a lookup stage to the pipeline.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2
Syntax IAggregateFluent<TNewResult> Lookup<TForeignDocument, TNewResult>(
string foreignCollectionName,
FieldDefinition<TResult> localField,
FieldDefinition<TForeignDocument> foreignField,
FieldDefinition<TNewResult> as,
AggregateLookupOptions<TForeignDocument, TNewResult> options = null
)
Function Lookup(Of TForeignDocument, TNewResult) (
foreignCollectionName As String,
localField As FieldDefinition(Of TResult),
foreignField As FieldDefinition(Of TForeignDocument),
as As FieldDefinition(Of TNewResult),
Optional options As AggregateLookupOptions(Of TForeignDocument, TNewResult) = Nothing
) As IAggregateFluent(Of TNewResult)
abstract Lookup :
foreignCollectionName : string *
localField : FieldDefinition<'TResult> *
foreignField : FieldDefinition<'TForeignDocument> *
as : FieldDefinition<'TNewResult> *
?options : AggregateLookupOptions<'TForeignDocument, 'TNewResult>
(* Defaults:
let _options = defaultArg options null
*)
-> IAggregateFluent<'TNewResult>
Parameters
- foreignCollectionName
- Type: SystemString
Name of the other collection. - localField
- Type: MongoDB.DriverFieldDefinitionTResult
The local field. - foreignField
- Type: MongoDB.DriverFieldDefinitionTForeignDocument
The foreign field. - as
- Type: MongoDB.DriverFieldDefinitionTNewResult
The field in TNewResult to place the foreign results. - options (Optional)
- Type: MongoDB.DriverAggregateLookupOptionsTForeignDocument, TNewResult
The options.
Type Parameters
- TForeignDocument
- The type of the foreign document.
- TNewResult
- The type of the new result.
Return Value
Type:
IAggregateFluentTNewResultThe fluent aggregate interface.
See Also