For AI agents: a documentation index is available at https://www.mongodb.com/ja-jp/docs/llms.txt — markdown versions of all pages are available by appending .md to any URL path.

atlas api shardKeyAnalyzer

Analyzes how well a candidate shard key would distribute a collection across the shards of a 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.

Analyzing a shard key samples documents on a live cluster and does not finish within one request, so it is submitted as a long-running operation: the request returns an operation to poll, and the completed analysis is a separate resource that the operation links to. To receive the most common shard key values, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud omits those values, because they come from the collection's data rather than from statistics about it.

Name
Type
Required
Description

-h, --help

false

help for shardKeyAnalyzer

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.