IAggregateFluentTResultSearch Method (SearchDefinitionTResult, SearchHighlightOptionsTResult, String, SearchCountOptions, Boolean, Boolean) |
Appends a $search stage to the pipeline.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax IAggregateFluent<TResult> Search(
SearchDefinition<TResult> searchDefinition,
SearchHighlightOptions<TResult> highlight = null,
string indexName = null,
SearchCountOptions count = null,
bool returnStoredSource = false,
bool scoreDetails = false
)
Function Search (
searchDefinition As SearchDefinition(Of TResult),
Optional highlight As SearchHighlightOptions(Of TResult) = Nothing,
Optional indexName As String = Nothing,
Optional count As SearchCountOptions = Nothing,
Optional returnStoredSource As Boolean = false,
Optional scoreDetails As Boolean = false
) As IAggregateFluent(Of TResult)
abstract Search :
searchDefinition : SearchDefinition<'TResult> *
?highlight : SearchHighlightOptions<'TResult> *
?indexName : string *
?count : SearchCountOptions *
?returnStoredSource : bool *
?scoreDetails : bool
(* Defaults:
let _highlight = defaultArg highlight null
let _indexName = defaultArg indexName null
let _count = defaultArg count null
let _returnStoredSource = defaultArg returnStoredSource false
let _scoreDetails = defaultArg scoreDetails false
*)
-> IAggregateFluent<'TResult>
Parameters
- searchDefinition
- Type: MongoDB.Driver.SearchSearchDefinitionTResult
The search definition. - highlight (Optional)
- Type: MongoDB.Driver.SearchSearchHighlightOptionsTResult
The highlight options. - indexName (Optional)
- Type: SystemString
The index name. - count (Optional)
- Type: MongoDB.Driver.SearchSearchCountOptions
The count options. - returnStoredSource (Optional)
- Type: SystemBoolean
Flag that specifies whether to perform a full document lookup on the backend database
or return only stored source fields directly from Atlas Search.
- scoreDetails (Optional)
- Type: SystemBoolean
Flag that specifies whether to return a detailed breakdown
of the score for each document in the result.
Return Value
Type:
IAggregateFluentTResultThe fluent aggregate interface.
See Also