manage-indexes

For the complete MongoDB documentation index, see www.mongodb.com/docs/llms.txt

<!-- Tab options on this page. Append to the .md URL to filter: ?tabs=<id,...> select specific tabs (e.g. ?tabs=nodejs,shell) ?allTabs=true include every tab (no param) default: one tab per tabset

Available tabs: other tabs: fts-vs, data-explorer, vib, jsonib, create-one, create-multiple -->

Manage MongoDB Search Indexes

A MongoDB Search index is a data structure that maps documents from your Atlas cluster to the terms that are extracted from those documents. MongoDB Search indexes enable efficient full-text searches of your database with MongoDB Search queries.

This page describes how to create, view, update, or delete MongoDB Search indexes using the Atlas UI or one of our supported clients.

Supported Clients

You can create and manage MongoDB Search indexes from the Atlas UI or one of the following supported clients:

• Atlas CLI, with Atlas cluster running MongoDB 7.0+

• [mongosh](https://www.mongodb.com/docs/mongodb-shell.md#mongodb-binary-bin.mongosh, with Atlas cluster running MongoDB 7.0+.

• Compass, with Atlas cluster running MongoDB 7.0+.

• Supported MongoDB Drivers:

Required Access

You can assign [Project User Roles](https://www.mongodb.com/docs/atlas/reference/user-roles.md#std-label-project-roles or [Database Built-in User Roles](https://www.mongodb.com/docs/manual/reference/built-in-roles.md#std-label-mongodb-users-roles-and-privileges to provide access to the user privileges necessary to perform the MongoDB Search index actions described in this guide:

• The following table shows the modes of access that the following [Project User Roles](https://www.mongodb.com/docs/atlas/reference/user-roles.md#std-label-project-roles support for the specified MongoDB Search actions:

Each role grants permission to call either a subset or the full set of MongoDB Search API endpoints in the Atlas Administration API. See the MongoDB Search Action column for descriptions of the API endpoints that each role grants access to.

• The following table shows the [Database Built-in User Roles](https://www.mongodb.com/docs/manual/reference/built-in-roles.md#std-label-mongodb-users-roles-and-privileges that support the specified [MongoDB Search Index Privilege Actions.](https://www.mongodb.com/docs/manual/reference/privilege-actions/#atlas-search-index-actions

To learn more, see [Built-In Roles](https://www.mongodb.com/docs/manual/reference/built-in-roles.md#std-label-atlas-user-privileges or [Built-In Roles.](https://www.mongodb.com/docs/manual/reference/built-in-roles.md#std-label-atlas-specific-privileges

Create a MongoDB Search Index

To create a MongoDB Search index using the Atlas UI:

1. In Atlas, go to the Search & Vector Search page for your cluster.

You can go the MongoDB Search page from the Search & Vector Search option, or the Data Explorer.

### Search & Vector Search

If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

If it's not already displayed, select your project from the Projects menu in the navigation bar.

In the sidebar, click Search & Vector Search under the Database heading.

• If you have no clusters, click Create cluster to create one. To learn more, see [Create an Atlas Infinite or Atlas Core Cluster.](https://www.mongodb.com/docs/atlas/tutorial/create-new-cluster.md#std-label-create-new-cluster

• If your project has multiple clusters, select the cluster you want to use from the Select cluster dropdown, then click Go to Search.

The Search & Vector Search page displays.

1. Click Create Search Index.

2. Start your index configuration.

Make the following selections on the page and then click Next.

IMPORTANT: The default index name varies by index type: your MongoDB Search index is named default, your Vector Search index is named vector_index, and your Automated Embedding index is named autoembed_index. If you are creating multiple indexes, we recommend that you maintain a consistent, descriptive naming convention across your indexes.

1. Review the default MongoDB Search index configuration settings in the Index Configurations section.

The default index definition is a [dynamic mapping](https://www.mongodb.com/docs/search/indexes/define-field-mappings.md#std-label-static-dynamic-mappings of the fields in the documents and will work with any collection.

To customize your index definition, review the following index configurations:

### Visual Editor

If you are satisfied with the default configuration, skip ahead. If you wish to refine your MongoDB Search index, proceed to the next step.

1. Refine your MongoDB Search index to configure additional settings.

### Visual Editor

Click Refine Your Index to make changes to any of the following settings.

Click Save Changes.

1. Optional. If you use the Visual Editor, you can save or delete your index definition draft.

IMPORTANT: You can't save the [default index definition](https://www.mongodb.com/docs/search/indexes/manage-indexes.md#std-label-fts-manage-indexes as a draft. If you use the Visual Editor and your index definition contains [static mappings](https://www.mongodb.com/docs/search/indexes/define-field-mappings.md#std-label-static-dynamic-mappings, you can save an index definition as a draft.

Click Cancel.

Click Save Draft or Delete Draft.

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

To learn more, see [Resume or Delete a MongoDB Search Index Draft.](https://www.mongodb.com/docs/search/indexes/manage-indexes.md#std-label-ref-resume-index

1. Click Create Search Index.

Atlas displays a Toast (brief, non-interactive notification) to let you know your index is building.

1. Check the status.

The newly created index appears on the Atlas Search tab. While the index is building, the Status field reads Building. When the index is finished building, the Status field reads Ready.

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

View MongoDB Search Indexes

To view the Atlas UI MongoDB Search page:

1. In Atlas, go to the Search & Vector Search page for your cluster.

You can go the MongoDB Search page from the Search & Vector Search option, or the Data Explorer.

###### Search & Vector Search

If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

If it's not already displayed, select your project from the Projects menu in the navigation bar.

In the sidebar, click Search & Vector Search under the Database heading.

If your project has multiple clusters, select the cluster you want to use from the Select cluster dropdown, then click Go to Atlas Search.

The Search & Vector Search page displays.

###### Data Explorer

If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

If it's not already displayed, select your project from the Projects menu in the navigation bar.

In the sidebar, click Data Explorer under the Database heading.

Expand the database and select the collection.

Click the Indexes tab for the collection.

Click the Search and Vector Search link in the banner.

The Search & Vector Search page displays.

The MongoDB Search page in the Atlas UI displays details about all of the MongoDB Search indexes on a cluster.

This page contains a table with the following details for each of your MongoDB Search indexes in each column:

By default, Atlas sorts the indexes first by database name, then collection name. To sort by multiple columns, press Shift and click the column names according to the sort priority you want.

From this table, you can open the following pages for more details about each index:

Index Overview

To open the Index Overview page from the table on the MongoDB Search page, click the Index Name of the index that you want to view.

For each index, the Index Overview page shows the [namespace](https://www.mongodb.com/docs/manual/reference/limits/#std-label-faq-dev-namespace for the index and the following configurations specified in the index definition:

To learn how to view index status details from the MongoDB Search page, see [View MongoDB Search Index Statuses.](https://www.mongodb.com/docs/search/indexes/manage-indexes.md#std-label-fts-index-statuses

View MongoDB Search Index Statuses

The MongoDB Search page in the Atlas UI displays a table of the MongoDB Search indexes for a cluster. The Status column displays the status of the MongoDB Search index on the primary node in the cluster.

Possible index statuses include:

To view index statuses for more nodes in your cluster, you can open the Status Details page by clicking View status details in the Status column.

The Status Details page contains the following sections:

Index Serving Queries

This section displays the index that is being used to serve queries.

If you have only one version of the index with this name for the collection, the section contains a link to the Index Overview where you can see the index definition for the index being used.

If you had other indexes with the same name on the collection, the section shows the latest index definition and also shows prior valid versions of the index that you can copy in different tabs.

When you update an index, different nodes apply the updates at different speeds. Therefore, some nodes might use the latest version and some might use the prior version. Atlas displays both versions of the index until the changes are applied to all the nodes.

If you attempt to update the index with an invalid index definition, the index build will fail and Atlas displays only the previous valid index definition.

Status Details by Node

This section displays the status of the index on each node of the cluster. You can see the following details about the index on each node:

Migration to Search Nodes

This section displays the status of the in-progress migration of your MongoDB Search and MongoDB Vector Search indexes to search nodes, if applicable. This section displays only if you are currently migrating to search nodes.

Click the View Migration Progress link in the information banner under the Index Status by Search Node section for details on the progress of the migration of the indexes to Search Nodes (on a per node basis).

The Atlas UI displays the following columns for each index on the cluster.

The status column displays one of the following migration statuses of the index on the Search Nodes:

Your queries can continue to use existing indexes while the new indexes are building on the Search Nodes. The migration to the Search Nodes completes only when Atlas successfully builds all the indexes on the Search Nodes. Then, your queries are automatically routed to the use the indexes on the Search Nodes.

Important:

You can [resume a change stream](https://www.mongodb.com/docs/manual/changeStreams/#resume-a-change-stream only while the oplog collection still holds the operation that its [resume token](https://www.mongodb.com/docs/manual/changeStreams/#resume-tokens-from-change-events identifies. To ensure that your applications can resume their change streams, configure a [Minimum Oplog Window](https://www.mongodb.com/docs/atlas/cluster-additional-settings/#set-oplog-min-window longer than the longest interruption you expect.

Resume or Delete a MongoDB Search Index Draft

To resume or delete a MongoDB Search index definition that you saved as a draft in the Atlas UI:

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

1. In Atlas, go to the Search & Vector Search page for your cluster.

You can go the MongoDB Search page from the Search & Vector Search option, or the Data Explorer.

###### Search & Vector Search

If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

If it's not already displayed, select your project from the Projects menu in the navigation bar.

In the sidebar, click Search & Vector Search under the Database heading.

If your project has multiple clusters, select the cluster you want to use from the Select cluster dropdown, then click Go to Atlas Search.

The Search & Vector Search page displays.

###### Data Explorer

If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

If it's not already displayed, select your project from the Projects menu in the navigation bar.

In the sidebar, click Data Explorer under the Database heading.

Expand the database and select the collection.

Click the Indexes tab for the collection.

Click the Search and Vector Search link in the banner.

The Search & Vector Search page displays.

1. Click Resume Index Creation.

2. Save or delete your index definition draft.

Click Cancel.

Click Save Draft or Delete Draft.

1. Customize your MongoDB Search index configuration settings.

Click Refine Your Index to make changes to your index configuration.

Click Save Changes.

1. Click Create Search Index.

Atlas displays a Toast (brief, non-interactive notification) to let you know your index is building.

1. Check the status.

The newly created index appears on the Atlas Search tab. While the index is building, the Status field reads Building. When the index is finished building, the Status field reads Ready.

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

Update and Rebuild an Existing MongoDB Search Index

Some MongoDB Search features require that you update the index. To update your index, you can take one of the following actions:

• Edit the index definition using the steps in [Manage MongoDB Search Indexes.](https://www.mongodb.com/docs/search/indexes/manage-indexes.md#std-label-ref-edit-index

• Do the following steps to opt-in for an index update from the Atlas UI:

Important:

If Atlas detects insufficient disk space to rebuild the index in place, it automatically provisions new nodes in the background, rebuilds the index, and swaps to the new index seamlessly.

1. In Atlas, go to the Clusters page for your project.

If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

In the sidebar, click Clusters under the Database heading.

The Clusters page displays.

1. In Atlas, go to the Search & Vector Search page for your cluster.

You can go the MongoDB Search page from the Search & Vector Search option, or the Data Explorer.

###### Search & Vector Search

If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

If it's not already displayed, select your project from the Projects menu in the navigation bar.

In the sidebar, click Search & Vector Search under the Database heading.

If your project has multiple clusters, select the cluster you want to use from the Select cluster dropdown, then click Go to Atlas Search.

The Search & Vector Search page displays.

###### Data Explorer

If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

If it's not already displayed, select your project from the Projects menu in the navigation bar.

In the sidebar, click Data Explorer under the Database heading.

Expand the database and select the collection.

Click the Indexes tab for the collection.

Click the Search and Vector Search link in the banner.

The Search & Vector Search page displays.

1. Click the name of the index that you want to update.

WARNING: If an index requires an update to enable a new feature, the Atlas UI shows a warning icon next to the index name.

1. Update your index to use the new feature.

In the Index Overview page, click Update in the banner.

Click Update Index in the confirmation window.

While your index is updating, you can continue to query your collection using your previous index.

Edit a MongoDB Search Index

You can edit a MongoDB Search index to change the [index definition](https://www.mongodb.com/docs/search/indexes/index-definitions.md#std-label-ref-index-definitions of an existing MongoDB Search index. You cannot rename an index; if you need to change an index's name, you must create a new index and delete the old one.

To edit a MongoDB Search index using the Atlas UI:

1. In Atlas, go to the Search & Vector Search page for your cluster.

You can go the MongoDB Search page from the Search & Vector Search option, or the Data Explorer.

###### Search & Vector Search

If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

If it's not already displayed, select your project from the Projects menu in the navigation bar.

In the sidebar, click Search & Vector Search under the Database heading.

If your project has multiple clusters, select the cluster you want to use from the Select cluster dropdown, then click Go to Atlas Search.

The Search & Vector Search page displays.

###### Data Explorer

If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

If it's not already displayed, select your project from the Projects menu in the navigation bar.

In the sidebar, click Data Explorer under the Database heading.

Expand the database and select the collection.

Click the Indexes tab for the collection.

Click the Search and Vector Search link in the banner.

The Search & Vector Search page displays.

1. Click and choose one of the following from the dropdown.

2. Edit With Visual Editor for a guided experience.

3. Edit With JSON Editor to edit the raw index definition.

4. Review current configuration settings and edit them as needed.

### Visual Editor

Review the following index configuration settings:

Review the following advanced configuration settings:

1. 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 MongoDB 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.

Note:

While your updated index is building, different nodes might update at varying speeds. During this period, you might experience mixed query results, reflecting both the new index definition and the previous index definition.

Delete a MongoDB Search Index

Warning: Deleting Search Indexes and Clusters Is Irreversible

Deleting Search indexes and associated clusters is a permanent action. MongoDB doesn't provide support for recovering deleted Search indexes or data. Ensure that you have taken appropriate measures, such as creating backups, to avoid data loss before proceeding.

MongoDB doesn't support requests to recover deleted Search indexes or data. You are responsible for data integrity and configurations.

To delete a MongoDB Search index using the Atlas UI:

1. In Atlas, go to the Search & Vector Search page for your cluster.

You can go the MongoDB Search page from the Search & Vector Search option, or the Data Explorer.

### Search & Vector Search

If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

If it's not already displayed, select your project from the Projects menu in the navigation bar.

In the sidebar, click Search & Vector Search under the Database heading.

• If you have no clusters, click Create cluster to create one. To learn more, see [Create an Atlas Infinite or Atlas Core Cluster.](https://www.mongodb.com/docs/atlas/tutorial/create-new-cluster.md#std-label-create-new-cluster

• If your project has multiple clusters, select the cluster you want to use from the Select cluster dropdown, then click Go to Search.

The Search & Vector Search page displays.

1. Click the ... button.

The ellipsis button is located on the right side of the panel. Click the button beside you

（本文超出站点单文档体积上限，已截断）