db.collection.analyzeShardKey()

項目一覧

定義

構文
フィールド
動作
アクセス制御
出力
例
詳細

定義

db.collection.analyzeShardKey(key, opts): シャーディングされていないコレクションまたはシャーディングされたコレクションのシャードキーを評価するためのメトリクスを計算します。メトリクスは、サンプリングされたクエリに基づいています。 configureQueryAnalyzerを使用して、コレクションのクエリサンプリングを構成できます。

構文

db.collection.analyzeShardKey() の構文は次のとおりです。

db.collection.analyzeShardKey(
   <shardKey>,
   {
     keyCharacteristics: <bool>,
     readWriteDistribution: <bool>,
     sampleRate: <double>,
     sampleSize: <int>
   }
 )

フィールド

フィールド	タイプ	必要性	説明
`key`	ドキュメント	必須	分析するシャードキー。これは、シャーディングされていないコレクションまたはシャーディングされたコレクションの候補シャードキー、またはシャーディングされたコレクションの現在のシャードキーです。デフォルト値はありません。
`opts.keyCharacteristics`	ブール値	任意	シャードキーの特性に関するメトリクスを計算するかどうか。詳細については、「キーの特性」を参照してください。デフォルトは `true` です。
`opts.readWriteDistribution`	ブール値	任意	読み取りと書込みの分布に関するメトリクスを計算するかどうか。詳しくは、「 readWriteDistribution 」を参照してください。デフォルトは `true` です。
`opts.sampleRate`	double	任意	シャードキーの特性に関するメトリクスを計算するときにサンプリングするコレクション内のドキュメントの割合。 `sampleRate`を設定した場合、 `sampleSize`は設定できません。 `01`より大きく、以下である必要があります。デフォルト値はありません。
`opts.sampleSize`	integer	任意	シャードキーの特性に関するメトリクスを計算するときにサンプリングするドキュメントの数。 `sampleSize`を設定した場合、 `sampleRate`は設定できません。指定されておらず、かつ`sampleRate`が指定されていない場合、サンプルサイズはデフォルトで`analyzeShardKeyCharacteristicsDefaultSampleSize`で設定されたサンプルサイズになります。

動作

動作については、 analyzeShardKey の動作を参照してください。

アクセス制御

詳細については、「 analyzeShardKey アクセス制御」を参照してください。

出力

出力の例については、「 analyzeShardKey 出力」を参照してください。

例

例については、「 analyzeShardKey の例」を参照してください。

詳細

戻る

db.collection.aggregate

db.collection.bulkWrite