Docs Menu
Docs Home
/
MongoDB Ops Manager
/
Create Deployments
/
Data Explorer

Manage Indexes in Data Explorer

On this page

  • Required Roles
  • View Indexes
  • Create an Index
  • Drop an Index

You can use the Data Explorer to manage indexes on your collections.

To access the Data Explorer:

  1. Click Deployment in the left navigation.

  2. Select the desired MongoDB deployment.

  3. Select the Data Explorer tab.

Required Roles

To create or drop indexes, you must have access provided by at least one of the following roles:

View Indexes

From the Collections tab, you can view index information for a collection. To view index information for a collection:

1

Select the database for the collection.

The main panel and Namespaces on the left side list the collections in the database.

Screenshot highlighting databases in Data Explorer.
click to enlarge
2

Select the collection on the left-hand side or in the main panel.

The main panel displays the Find, Indexes, and Aggregation views.

3

Select the Indexes view.

The indexes table lists the indexes and associated index information for the collection. Index information includes the index definition, the size, and the usage frequency.

Screenshot highlighting index view in Data Explorer.
click to enlarge

Create an Index

Tip

When you create indexes, keep the ratio of reads to writes on the target collection in mind. Indexes come with a performance cost, but are more than worth the cost for frequent queries on large data sets. To learn more about indexing strategies, see Indexing Strategies.

To create an index for a collection through the Data Explorer:

1

Go to the Indexes tab.

  1. Click the collection you wish to index.

  2. Click the Indexes tab under the collection name.

2

Click Create Index.

In the Create Index modal, enter the index key specification document in the Fields box:

{ <field1>: <index type>, ... }

Example

To create a compound index on the fields category (ascending order) and score (descending order), specify the index specification document:

{ category: 1, score: -1 }

For more information on indexes, see Indexes.

3

(Optional) Specify the index options.

{ <option1>: <value1>, ... }

Example

To set the unique option and a name for the new index, enter this document:

{ unique: true, name: "myUniqueIndex" }
4

(Optional) Set the Collation options.

Use collation to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. The collation document contains a locale field which indicates the ICU Locale code, and may contain other fields to define collation behavior.

Example

The following collation option document specifies a locale value of fr for a French language collation:

{ "locale": "fr" }

To review the list of locales that MongoDB collation supports, see the list of languages and locales. To learn more about collation options, including which are enabled by default for each locale, see Collation in the MongoDB manual.

5

(Optional) Build indexes with rolling builds.

Warning

Due to critical issue SERVER-68925, Ops Manager deployments using certain versions of the MongoDB Agent should not perform automated rolling index builds on clusters running the following MongoDB versions:

  • MongoDB 4.2.19-4.2.22

  • MongoDB 4.4.13-4.4.16

  • MongoDB 5.0.6-5.0.11

  • MongoDB 6.0.0-6.0.1

You can continue to perform manual rolling index builds safely on your clusters. To perform automated rolling index builds safely, upgrade the MongoDB Agent to 12.0.11.7606 or later or upgrade your clusters to:

  • MongoDB 4.2.23 or later

  • MongoDB 4.4.17 or later

  • MongoDB 5.0.12 or later

  • MongoDB 6.0.2 or later

Important

Rolling index builds succeed only when they meet certain conditions. To ensure your index build succeeds, avoid the following design patterns that commonly trigger a restart loop:

Note

Data Explorer does not support building indexes in a rolling fashion for standalone deployments.

Building indexes in a rolling fashion reduces the performance impact of building indexes on replica sets and sharded clusters. To maintain cluster availability, Ops Manager removes one node from the cluster at a time starting with a secondary.

After you build an index in a rolling fashion, if your MongoDB database runs with an FCV less than 4.2, resync the head database to ensure that the head database takes the new index into account. runs with an FCV less than 4.2, resync the head database to ensure that the head database takes the new index into account.

Ops Manager automatically cancels rolling index builds that do not succeed on all nodes. When a rolling index build completes on some nodes, but fails on others, Ops Manager cancels the build and removes the index from any nodes that it was successfully built on.

In the event of a rolling index build cancellation, Ops Manager generates an activity feed event and sends a notification email to the project owner with the following information:

  • Name of the cluster on which the rolling index build failed

  • Namespace on which the rolling index build failed

  • Project containing the cluster and namespace

  • Organization containing the project

  • Link to the activity feed event

To learn more about rebuilding indexes, see Build Indexes on Replica Sets.

Note

The following index options are incompatible with building indexes in a rolling fashion:

Ops Manager ignores these options if you specify them in the Options pane.

6

Click Create.

7

Confirm your index.

The Confirm Operation modal appears.

  • If your index creation looks correct, click Confirm. This closes the modal and create the index.

  • If your index creation looks incorrect, click Cancel. This closes the modal without creating the index.

Drop an Index

To drop an index from a collection through the Data Explorer:

1

Go to the Indexes tab.

Select the collection whose index you wish to drop, and go to the Indexes tab.

2

Click the Drop Index button for the index to drop.

3

Confirm action.

Confirm by typing the name of the index, and click Drop.

Note

You cannot delete the _id index.

Back

Manage Documents

Next

Build Aggregation Pipelines