PipelineDefinitionBuilderSearchMetaTInput, TOutput Method |
Appends a $searchMeta stage to the pipeline.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax public static PipelineDefinition<TInput, SearchMetaResult> SearchMeta<TInput, TOutput>(
this PipelineDefinition<TInput, TOutput> pipeline,
SearchDefinition<TOutput> query,
string indexName = null,
SearchCountOptions count = null
)
<ExtensionAttribute>
Public Shared Function SearchMeta(Of TInput, TOutput) (
pipeline As PipelineDefinition(Of TInput, TOutput),
query As SearchDefinition(Of TOutput),
Optional indexName As String = Nothing,
Optional count As SearchCountOptions = Nothing
) As PipelineDefinition(Of TInput, SearchMetaResult)
[<ExtensionAttribute>]
static member SearchMeta :
pipeline : PipelineDefinition<'TInput, 'TOutput> *
query : SearchDefinition<'TOutput> *
?indexName : string *
?count : SearchCountOptions
(* Defaults:
let _indexName = defaultArg indexName null
let _count = defaultArg count null
*)
-> PipelineDefinition<'TInput, SearchMetaResult>
Parameters
- pipeline
- Type: MongoDB.DriverPipelineDefinitionTInput, TOutput
The pipeline. - query
- Type: MongoDB.Driver.SearchSearchDefinitionTOutput
The search definition. - indexName (Optional)
- Type: SystemString
The index name. - count (Optional)
- Type: MongoDB.Driver.SearchSearchCountOptions
The count options.
Type Parameters
- TInput
- The type of the input documents.
- TOutput
- The type of the output documents.
Return Value
Type:
PipelineDefinitionTInput,
SearchMetaResult
A new pipeline with an additional stage.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
PipelineDefinitionTInput,
TOutput. 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