Starts, returns, and stops query sampling on one namespace of one 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.
Sampled queries feed the shard key analysis for the namespace.
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for querySampling |
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 querySampling createClusterQuerySampling - Starts query sampling on one namespace of the specified cluster.
atlas api querySampling deleteClusterQuerySampling - Stops query sampling on one namespace of the specified cluster.
atlas api querySampling getClusterQuerySampling - Returns the query sampling state of one namespace of the specified cluster, including counters for the operations sampled so far.