Edit an Atlas Search Index

Navigate to the Atlas Cluster Overview page.

Click Databases in the top-left corner of Atlas to navigate to the Database Deployments page for your project.

Click the cluster name to view cluster details.

Click the Search tab.

Click and choose one of the following from the dropdown.

• Edit with Visual Editor for a guided experience.

  Note

  The Visual Editor doesn't support custom analyzers or synonym mapping definitions.

• Edit with JSON Editor to edit the raw index definition.

Review current configuration settings and edit them as needed.

• If you are using the Visual Editor, configure the following settings:

  Field Name	Description	Necessity
  Index Analyzer	Specify the analyzer to use for indexing the collection data. By default, Atlas Search uses the standard analyzer ("lucene.standard"). Corresponds to the analyzer setting.	Optional
  Search Analyzer	Specify the analyzer to use when parsing data for the Atlas Search queries. By default, Atlas Search uses the standard analyzer ("lucene.standard"). Corresponds to the searchAnalyzer setting.	Optional
  Dynamic Mapping	Specify dynamic or static mapping of fields. To disable dynamic mapping, set "dynamic": to Off. By default, dynamic mapping is enabled. If you disable dynamic mapping, you must specify the fields to index. To learn more about dynamic and static mappings, see Review Atlas Search Index Syntax. Corresponds to the mappings.dynamic setting.	Required
  Store Full Document	Note The Atlas Search index storedSource option and $search returnStoredSource option are in preview, but can be used in production applications. If there are any syntax or behavior changes between the preview stage and general availability (GA), we will proactively communicate before introducing any breaking changes. The MongoDB Cloud Support team will help troubleshoot any issues related to using this feature as part of your contract. Specify whether to store entire documents on Atlas Search for query-time lookups. If this is enabled, Atlas Search stores all the fields in the documents by default. You can exclude specific fields from storage on Atlas Search in the Field Mappings definition for the fields. To learn more about storing fields, see Define Stored Source Fields in Your Atlas Search Index.	Required
  Field Mappings	Required if dynamic mapping is disabled. To add the fields to index, you must specify the following settings for each field: Field name - Name of the field to index. Enable Dynamic Mapping - Static or dynamic mapping to use. If you disable dynamic mapping, the data in the field isn't automatically indexed. Store Original Value - Flag to store field on Atlas Search for query-time lookups. This is enabled by default if Store Full Document is enabled. However, you can toggle the setting to Off to exclude the field from storage. To learn more about storing fields, see Define Stored Source Fields in Your Atlas Search Index. Note The Atlas Search index storedSource option and $search returnStoredSource option are in preview, but can be used in production applications. If there are any syntax or behavior changes between the preview stage and general availability (GA), we will proactively communicate before introducing any breaking changes. The MongoDB Cloud Support team will help troubleshoot any issues related to using this feature as part of your contract. Data Type Configuration - Field data type. To learn more about the supported data types and their options, see BSON Data Types and Atlas Search Field Types. Note Unlike compound indexes, the order of fields in the Atlas Search index definition is not important. Fields can be defined in any order. Corresponds to the mappings.fields setting.	Conditional

• If you are using the JSON Editor, configure the following settings:

  Field Name	Description	Necessity
  analyzer	Specify the analyzer to use for indexing the collection data. By default, Atlas Search uses the standard analyzer ("lucene.standard").	Optional
  searchAnalyzer	Specify the analyzer to use when parsing data for the Atlas Search queries. By default, Atlas Search uses the standard analyzer ("lucene.standard").	Optional
  mappings.dynamic	Specify dynamic or static mapping of fields. To disable dynamic mapping, set "dynamic": to false. By default, dynamic mapping is enabled. If you disable dynamic mapping, you must specify the fields to index. To learn more about dynamic and static mappings, see Review Atlas Search Index Syntax.	Required
  mappings.fields	Required if dynamic mapping is disabled. Specify the fields that you would like to index. To learn more, see Define Field Mappings. Note Unlike compound indexes, the order of fields in the Atlas Search index definition is not important. Fields can be defined in any order.	Conditional
  storedSource	Note storedSource is only available on Atlas clusters running one of the following versions: MongoDB 4.4.12+ MongoDB 5.0.6+ Specify fields in the documents to store for query-time look-ups using the returnedStoredSource option. Value can be one of the following: true, to store all fields false, to not store any fields Object that specifies the fields to include or exclude from storage If omitted, defaults to false. To learn more about the syntax and fields, see Define Stored Source Fields in Your Atlas Search Index. Note You can store fields of all BSON Data Types on Atlas Search.	Optional
  synonyms	Specify synonym mappings to use in your index. To learn more, see Define Synonym Mappings in Your Atlas Search Index.	Optional

Click Save to apply the changes.

The index's status changes from Active to Building. In this state, you can continue to use the old index because Atlas Search does not delete the old index until the updated index is ready for use. Once the status returns to Active, the modified index is ready to use.