Returns, adds, edits, and removes Atlas Search indexes for the specified cluster.
The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
Also returns and updates user-defined analyzers for the specified cluster.
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for atlasSearch |
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. |
Related Commands
atlas api atlasSearch createClusterFtsIndex - Creates one Atlas Search index on the specified collection.
atlas api atlasSearch createClusterSearchDeployment - Creates Search Nodes for the specified cluster.
atlas api atlasSearch createClusterSearchIndex - Creates one Atlas Search index on the specified collection.
atlas api atlasSearch deleteClusterFtsIndex - Removes one Atlas Search index that you identified with its unique ID.
atlas api atlasSearch deleteClusterSearchDeployment - Deletes the Search Nodes for the specified cluster.
atlas api atlasSearch deleteClusterSearchIndex - Removes one Atlas Search index that you identified with its unique ID.
atlas api atlasSearch deleteIndexByName - Removes one Atlas Search index that you identified with its database, collection, and name.
atlas api atlasSearch getClusterFtsIndex - Returns one Atlas Search index in the specified project.
atlas api atlasSearch getClusterSearchDeployment - Returns the Search Nodes for the specified cluster.
atlas api atlasSearch getClusterSearchIndex - Returns one Atlas Search index that you identified with its unique ID.
atlas api atlasSearch getIndexByName - Returns one Atlas Search index that you identified with its database, collection name, and index name.
atlas api atlasSearch listClusterFtsIndex - Returns all Atlas Search indexes on the specified collection.
atlas api atlasSearch listClusterSearchIndexes - Returns all Atlas Search indexes on the specified cluster.
atlas api atlasSearch listSearchIndex - Returns all Atlas Search indexes on the specified collection.
atlas api atlasSearch updateClusterFtsIndex - Updates one Atlas Search index that you identified with its unique ID.
atlas api atlasSearch updateClusterSearchDeployment - Updates the Search Nodes for the specified cluster.
atlas api atlasSearch updateClusterSearchIndex - Updates one Atlas Search index that you identified with its unique ID.
atlas api atlasSearch updateIndexByName - Updates one Atlas Search index that you identified with its database, collection name, and index name.