SearchFacetBuilderTDocumentString Method (String, SearchPathDefinitionTDocument, NullableInt32) |
Creates a facet that narrows down Atlas Search results based on the most frequent
string values in the specified string field.
Namespace:
MongoDB.Driver.Search
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax public SearchFacet<TDocument> String(
string name,
SearchPathDefinition<TDocument> path,
Nullable<int> numBuckets = null
)
Public Function String (
name As String,
path As SearchPathDefinition(Of TDocument),
Optional numBuckets As Nullable(Of Integer) = Nothing
) As SearchFacet(Of TDocument)
member String :
name : string *
path : SearchPathDefinition<'TDocument> *
?numBuckets : Nullable<int>
(* Defaults:
let _numBuckets = defaultArg numBuckets null
*)
-> SearchFacet<'TDocument>
Parameters
- name
- Type: SystemString
The name of the facet. - path
- Type: MongoDB.Driver.SearchSearchPathDefinitionTDocument
The field path to facet on. - numBuckets (Optional)
- Type: SystemNullableInt32
The maximum number of facet categories to return in the results.
Return Value
Type:
SearchFacetTDocumentA string search facet.
See Also