Docs Menu
Docs Home
/
MongoDB Atlas
/ /

View an Atlas Search Index

On this page

  • Required Access
  • View an Atlas Search Index

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.

The following table shows the modes of access each role supports.

Role
Action
Atlas UI
Atlas API
Atlas Search API
Atlas CLI
Project Data Access Read Only or higher role
To view Atlas Search analyzers and indexes.
To create and manage Atlas Search analyzers and indexes, and assign the role to your API Key.
To create access list entries for your API Key and send the request from a client that appears in the access list for your API Key.
To create, view, edit, and delete Atlas Search indexes using the Atlas UI or API.

You can retrieve your Atlas Search indexes in the Atlas UI, or programmatically by using mongosh, the Atlas CLI, the API, or a supported MongoDB Driver in your preferred language.

Note

You can't use the mongosh command or driver helper methods to retrieve Atlas Search indexes on M0, M2, or M5 Atlas clusters. To create and manage Atlas Search indexes using mongosh or the driver, upgrade to a dedicated cluster tier.

You must have at least the readAnyDatabase role or read access to the database that contains the indexes. To learn more, see Built-in Roles or Specific Privileges.


Use the Select your language drop-down menu to set the language of the example in this section.


← Resume or Delete a Draft
Edit →