Click or drag to resize

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.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntax
public SearchFacet<TDocument> String(
	string name,
	SearchPathDefinition<TDocument> path,
	int? numBuckets = null
)

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: SearchFacetTDocument
A string search facet.
See Also