View an Atlas Search Index¶

On this page

Prerequisites

Procedure

Note

You can also manage Atlas Search indexes with the Atlas API.

Important

If you use the $out aggregation stage to modify a collection with an Atlas Search index, you must delete and re-create the search index. If possible, consider using $merge instead of $out.

You can view an Atlas Search index definition in the Index Overview page. For each index, the Index Overview page shows the following:

Namespace for the index.
Index and search analyzers specified in the index definition.
Dynamic or static mapping.
Field mappings in the index definition, if any, including field name, data type, and whether dynamic mapping is enabled for the individual field.

This page describes how to view your index definition in the Index Overview page. You can also Edit an Atlas Search Index with the visual or JSON editor in the Index Overview page.

Prerequisites¶

You must have the:

Project Data Access Read Only or higher role to view Atlas Search analyzers and indexes using the Atlas UI or API.
Project Data Access Admin or higher role to create and manage Atlas Search analyzers and indexes using the Atlas UI or API.

Procedure¶

Navigate to the Atlas Cluster Overview page.¶

Click the cluster name to view cluster details.¶

Click the Search tab.¶

Click the name of the index that you wish to view.¶

← Create an Atlas Search Index Edit an Atlas Search Index →