SearchFacetBuilderTDocumentNumber Method (String, SearchPathDefinitionTDocument, IEnumerableBsonValue, String) |
Creates a facet that determines the frequency of numeric values by breaking the search
results into separate ranges of numbers.
Namespace:
MongoDB.Driver.Search
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax public SearchFacet<TDocument> Number(
string name,
SearchPathDefinition<TDocument> path,
IEnumerable<BsonValue> boundaries,
string default = null
)
Public Function Number (
name As String,
path As SearchPathDefinition(Of TDocument),
boundaries As IEnumerable(Of BsonValue),
Optional default As String = Nothing
) As SearchFacet(Of TDocument)
member Number :
name : string *
path : SearchPathDefinition<'TDocument> *
boundaries : IEnumerable<BsonValue> *
?default : string
(* Defaults:
let _default = defaultArg default null
*)
-> SearchFacet<'TDocument>
Parameters
- name
- Type: SystemString
The name of the facet. - path
- Type: MongoDB.Driver.SearchSearchPathDefinitionTDocument
The field path to facet on. - boundaries
- Type: System.Collections.GenericIEnumerableBsonValue
A list of numeric values that specify the boundaries for each bucket.
- default (Optional)
- Type: SystemString
The name of an additional bucket that counts documents returned from the operator that
do not fall within the specified boundaries.
Return Value
Type:
SearchFacetTDocumentA number search facet.
See Also