$shardedDataDistribution (aggregation)
On this page
Definition
$shardedDataDistribution
New in version 6.0.3.
Returns information on the distribution of data in sharded collections.
Note
This aggregation stage is only available on
mongos
.This aggregation stage must be run on the
admin
database. The user must have theshardedDataDistribution
privilege action.
Syntax
The shardedDataDistribution
stage has the following syntax:
db.aggregate( [ { $shardedDataDistribution: { } } ] )
Output Fields
The $shardedDataDistribution
stage outputs an array of documents
for each sharded collection in the database. These documents contain the
following fields:
Field Name | Data Type | Description |
---|---|---|
ns | string | The namespace of the sharded collection. |
shards | array | Lists the shards in the collection with data distribution information
on each shard. |
shards.numOrphanedDocs | integer | Number of orphaned documents in the shard. |
shards.numOwnedDocuments | integer | Number of documents owned by the shard. |
shards.orphanedSizeBytes | integer | Amount of storage in bytes used by orphaned documents in the shard. |
shards.ownedSizeBytes | integer | Amount of storage in bytes used by owned documents in the shard. |
Examples
db.aggregate( [ { $shardedDataDistribution: { } } ] )
Example output:
[ { "ns": "test.names", "shards": [ { "shardName": "shard-1", "numOrphanedDocs": 0, "numOwnedDocuments": 6, "ownedSizeBytes": 366, "orphanedSizeBytes": 0 }, { "shardName": "shard-2", "numOrphanedDocs": 0, "numOwnedDocuments": 6, "ownedSizeBytes": 366, "orphanedSizeBytes": 0 } ] } ]