The storedSource option in a MongoDB Search index definition specifies the fields in the source document that MongoDB Search must store. You can configure storedSource to improve query performance in certain use cases, as it reduces the need for implicit query time lookup on the backend database. You can store fields of all MongoDB Search Field Types on MongoDB Search.
MongoDB Search doesn't index stored fields, so you must index the fields separately in order to run queries on them. You can also retrieve stored fields at query time by using the returnStoredSource option.
Note
storedSource is only available on clusters running MongoDB 7.0+.
To learn more about retrieving the stored fields, see Return Stored Source Fields.
Syntax
The storedSource option has the following syntax in an index
definition:
1 { 2 "storedSource": true | false | { 3 "include" | "exclude": [ 4 "<field-name>", 5 ... 6 ] 7 } 8 }
Options
The storedSource option takes a boolean value or an object in the index definition.
Boolean Values
Value | Description |
|---|---|
| Specifies that MongoDB Search must store all the fields in the documents. Storing full documents might significantly impact performance during indexing and querying. To learn more, see Storing Source Fields. This is not supported if index definition contains vector type field. Instead, use |
| Specifies that MongoDB Search must not store the original source document. This is the default value for the |
Object
The storedSource option object must contain one of the following fields:
Field | Type | Description |
|---|---|---|
| array of strings | List that contains the field names or dot-separated paths to fields to store. In addition to the specified fields, MongoDB Search stores |
| array of strings | List that contains the field names or dot-separated paths to fields to exclude from being stored. If specified, MongoDB Search stores original documents except the fields listed here. If index definition contains field of type vector, you must exclude the |
Examples
The following index examples use the fields in the sample_mflix.movies collection to demonstrate how to configure the fields to store on MongoDB Search using the storedSource option. You can use mongosh, the Atlas UI Visual Editor, or the Atlas UI JSON Editor to configure the indexes.