Create an Atlas Search Index¶
You can also create and manage Atlas Search indexes with the Atlas API.
To create an Atlas Search index, you must have an Atlas cluster with:
- MongoDB version
- At least one collection
You must have the:
Navigate to the Atlas Cluster Overview page.¶
Click the cluster name to view cluster details.¶
Click the Search tab.¶
Create an index.¶
- For your first index, click Create Search Index.
- For subsequent indexes, click Create Index.
Select a Configuration Method and click Next.¶
- For a guided experience, select Visual Editor.
- To edit the raw index definition, select JSON Editor.
Enter the Index Name, and set the Database and Collection.¶
In the Index Name field, enter a name for the index.
The index name defaults to default. You can leave the default name in place or choose one of your own.Note
If you name your index
default, you don't need to specify an
indexparameter when using the $search pipeline stage. Otherwise, you must specify the index name using the
Index names must be unique within their namespace.
In the Database and Collection section, find the database or collection, and select the collection name.Important
The Database and Collection picker is available for
M10and higher clusters only. For free and shared tier clusters, you must enter a Database and Collection in the corresponding fields.
- If you use the Visual Editor, click Next.
Review the default Atlas Search index configuration settings.¶
If you are satisfied with the default configuration, skip to step 9. If you wish to refine your Atlas Search index, proceed to the next step.
Defining your own field mappings is recommended for advanced users only.
Customize your Atlas Search index configuration settings.¶
Click Refine Your Index to make changes to any of the following settings and click Save Changes.
Select dynamic or static mapping of fields. To disable dynamic mapping, set Dynamic Mapping 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 Index Definitions.
Required if dynamic mapping is disabled.
To add the fields to index, click Add Field. You must specify the following settings for each field:
Optional: If you use the Visual Editor, you can save or delete your index definition draft.¶
- Click Cancel.
- Click Save Draft or Delete Draft.
You can't create a new index when you have a pending index draft.
To learn more about creating an index using an index draft, see Resume or Delete an Atlas Search Index Draft.
Click the Create Search Index button.¶
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.
Larger collections take longer to index. You will receive an email notification when your index is finished building.
The Atlas Search Indexes tab in the right-side panel of the Atlas UI displays information about Atlas Search indexes for the selected namespace. The Status column shows the current state of the index on the primary node of the cluster. Click the View status details link below the status to view the state of the index on all the nodes of the cluster.
When the Status column reads Active, the index is ready to use. In other states, queries against the index may return incomplete results.
Atlas has not yet started building the index.
Atlas is building the index or re-building the index after an edit. In this state, Atlas Search does not serve queries.
Index is ready to use.
Atlas could not build the index. Use the error in the View status details modal window to troubleshoot the issue.
Delete in Progress
Atlas is deleting the index from the cluster nodes.
When and after Atlas builds the index, the Documents column shows the percentage and number of documents indexed. The column also shows the total number of documents in the collection.