atlas api rollingIndex createRollingIndex

On this page

Syntax

Options
Inherited Options
Examples

Public Preview: please provide feedback at: Creates an index on the cluster identified by its name in a rolling manner.

Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createRollingIndex.

For more information and examples, see the referenced API documentation linked above.

Syntax

Command Syntax

atlas api rollingIndex createRollingIndex [options]

Options

Name	Type	Required	Description
--clusterName	string	true	Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.
--envelope	envelope	false	Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
--file	string	false	path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.
--groupId	string	true	Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
-h, --help		false	help for createRollingIndex
--output	string	false	preferred api format, can be ["json", go-template] This value defaults to "json".
--output-file	string	false	file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
--pretty		false	Flag that indicates whether the response body should be in the prettyprint format.
--version	string	false	api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".

Inherited Options

Name	Type	Required	Description
-P, --profile	string	false	Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Examples

Create the file below and save it as payload.json

# 2dspere Index
{
  "collation": {
    "alternate": "non-ignorable",
    "backwards": false,
    "caseFirst": "lower",
    "caseLevel": false,
    "locale": "af",
    "maxVariable": "punct",
    "normalization": false,
    "numericOrdering": false,
    "strength": 3
  },
  "collection": "accounts",
  "db": "sample_airbnb",
  "keys": [
    {
      "property_type": "1"
    }
  ],
  "options": {
    "name": "PartialIndexTest",
    "partialFilterExpression": {
      "limit": {
        "$gt": 900
      }
    }
  }
}

After creating payload.json, run the command below in the same directory.

# 2dspere Index
atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8

Create the file below and save it as payload.json

# Partial Index
{
  "collation": {
    "alternate": "non-ignorable",
    "backwards": false,
    "caseFirst": "lower",
    "caseLevel": false,
    "locale": "af",
    "maxVariable": "punct",
    "normalization": false,
    "numericOrdering": false,
    "strength": 3
  },
  "collection": "accounts",
  "db": "sample_airbnb",
  "keys": [
    {
      "property_type": "1"
    }
  ],
  "options": {
    "name": "PartialIndexTest",
    "partialFilterExpression": {
      "limit": {
        "$gt": 900
      }
    }
  }
}

After creating payload.json, run the command below in the same directory.

# Partial Index
atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8

Create the file below and save it as payload.json

# Sparse Index
{
  "collation": {
    "alternate": "non-ignorable",
    "backwards": false,
    "caseFirst": "lower",
    "caseLevel": false,
    "locale": "af",
    "maxVariable": "punct",
    "normalization": false,
    "numericOrdering": false,
    "strength": 3
  },
  "collection": "accounts",
  "db": "sample_airbnb",
  "keys": [
    {
      "test_field": "1"
    }
  ],
  "options": {
    "name": "SparseIndexTest",
    "sparse": true
  }
}

After creating payload.json, run the command below in the same directory.

# Sparse Index
atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8

Back

rollingIndex

root