候補となるシャードキーが、クラスターのシャード全体にコレクションをどれだけ適切に分散できるかを分析します。
atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメント リンクから確認できます。
シャードキーの分析は、稼働中のクラスタ上のドキュメントをサンプリングするため、1つのリクエストでは完了しません。そのため、長時間実行される操作として送信されます。リクエストはポーリングする操作を返し、完了した分析は、その操作がリンクする別のリソースとなります。最も一般的なシャードキーの値を取得するには、プロジェクトデータアクセス読み取り専用ロール以上が必要です。そうでない場合、MongoDB Cloud はこれらの値を省略します。これは、これらの値がコレクションの統計情報ではなく、コレクションのデータから取得されるためです。
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-h, --help | false | shardKeyAnalyzer のヘルプ |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
関連コマンド
atlas api shardKeyAnalyzer createShardKeyAnalysis - 候補となるシャードキーが、指定されたクラスターのシャード全体にコレクションをどれだけ適切に分散できるかを分析します。
atlas api shardKeyAnalyzer getAnalysisOperation - 指定されたクラスターの 1 つのシャード キー分析の進行状況を返します。
atlas api shardKeyAnalyzer getShardKeyAnalysis - 指定されたクラスターの完了したシャードキー分析を 1 つ返します。
atlas api shardKeyAnalyzer listAnalysisOperations - 指定されたクラスターのすべてのシャードキー分析試行を、実行中の試行と失敗した試行を含めて、最新のものから順に返します。
atlas api shardKeyAnalyzer listShardKeyAnalyses - 指定されたクラスターに対して完了したすべてのシャードキー分析を、新しい順に返します。