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`	布尔	Optional	是否计算有关分片键特征的指标。有关详细信息，请参阅keyCharacteristics。默认值为 `true`。
`opts.readWriteDistribution`	布尔	Optional	是否计算读写分布的指标。有关详细信息，请参阅readWriteDistribution。默认值为 `true`。
`opts.sampleRate`	双精度浮点数	Optional	计算有关分片键特征的指标时，集合中要进行采样的文档所占的比例。如果设置`sampleRate` ，则无法设置`sampleSize` 。必须大于 `0`，直至并包括 `1`。没有默认值。
`opts.sampleSize`	整型	Optional	计算分片密钥特征相关指标时要采样的文档数量。如果设置 `sampleSize`，则无法设置 `sampleRate`。如果未指定，且未指定 `sampleRate`，则样本大小默认为 `analyzeShardKeyCharacteristicsDefaultSampleSize` 设置的样本大小。

行为

有关行为，请参阅 analyzeShardKey 行为。

访问控制

有关详细信息，请参阅analyzeShardKey 访问控制。

输出

有关输出示例，请参阅analyzeShardKey 输出。

举例

有关示例，请参阅analyzeShardKey 示例。

了解详情

← 集合方法

db.collection.aggregate() →