Resume or Delete an Atlas Search Index Draft

On this page

Procedure

If you saved your Atlas Search index definition as a Create an Atlas Search Index, you can resume editing your index definition.

Important

You can't create a new index when you have a pending index draft.

Procedure

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 Resume Index Creation.

Optional: Save or delete your index definition draft.

Click Cancel.
Click Save Draft or Delete Draft.

Customize your Atlas Search index configuration settings.

Click Refine Your Index to make changes to any of the following settings and click Save Changes.

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

Click one of the following buttons.

Create Search Index if you are creating a default index.
Save Changes if you are creating a custom index.

Close the You're All Set! Modal Window.

A modal window appears to let you know your index is building. Click the Close button.

Check the status.

The newly created index appears on the Search tab. While the index is building, the Status field reads Build in Progress. When the index is finished building, the Status field reads Active.

Note

Larger collections take longer to index. You will receive an email notification when your index is finished building.

What is MongoDB Atlas? →