Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas api rollingIndex

Public Preview: please provide feedback: Creates one index to a database deployment in a rolling manner.

The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

Rolling indexes build indexes on the applicable nodes sequentially and may reduce the performance impact of an index build if your deployment's average CPU utilization exceeds (N-1)/N-10% where N is the number of CPU threads available to mongod of if the WiredTiger cache fill ratio regularly exceeds 90%. If your deployment does not meet this criteria, use the default index build. You can't create a rolling index on an M0 free cluster or M2/M5 shared cluster.

Name
Type
Required
Description

-h, --help

false

help for rollingIndex

Name
Type
Required
Description

-P, --profile

string

false

  • atlas api rollingIndex createRollingIndex - Public Preview: please provide feedback: Creates an index on the cluster identified by its name in a rolling manner.

On this page