You can use the MongoDB Search stringFacet type to index string fields for faceting, which allows you to run a facet operator query on that field. MongoDB Search doesn't apply the analyzer when indexing string fields for faceting.
MongoDB Search only supports facet operator queries against fields indexed as the stringFacet type. To perform a normal search also on the same field, you must index the field as type string also.
To facet on string fields in embedded documents, you must index the parent fields as the document type. When you facet on a string field inside embedded documents, MongoDB Search returns facet count for only the number of matching parent documents.
MongoDB Search doesn't dynamically index string values for faceting. You must use static
mappings to index string values for faceting. You can use the Visual Editor or the JSON Editor in the Atlas UI to index string fields as the number type.
Define the Index for the stringFacet Type
To define the index for the stringFacet type, choose your preferred configuration method in the Atlas UI and then select the database and collection.
Configure Properties for the stringFacet Type
The MongoDB Search stringFacet type has the following parameters:
UI Field Name | JSON Option | Type | Necessity | Description |
|---|---|---|---|---|
Data Type |
| string | Required | Human-readable label that identifies this field type. Value must be |
Try an Example for the stringFacet Type
The following index definition example uses the sample_mflix.movies collection. If you have the sample data already loaded on your cluster, you can use the Visual Editor or JSON Editor in the Atlas UI to configure the index. After you select your preferred configuration method, select the database and collection, and refine your index to add field mappings.
stringFacet Type Example
The following index definition for the sample_mflix.movies collection in the sample dataset indexes the genres field as stringFacet for faceting.
Multiple Types Example
The following index definition for the sample_mflix.movies collection in the sample dataset indexes the genres field as stringFacet and string types to return the following types of results for your queries:
Metadata results for queries using MongoDB Search
facet(MongoDB Search Operator).
Learn More
To learn more about the facet collector and see example queries, see Examples.
To learn how to create an index with a facet definition and query that index using the facet collector, see the How to Use Facets with MongoDB Search tutorial.
To see an example index and query that uses stringFacet to run a faceted search with paginated results, see Use Facet with the Paginated Results.