- Reference >
mongo
Shell Methods >- Sharding Methods >
- sh.status()
sh.status()¶
On this page
Definition¶
-
sh.
status
()¶ When run on a
mongos
instance, prints a formatted report of the sharding configuration and the information regarding existing chunks in a sharded cluster. The default behavior suppresses the detailed chunk information if the total number of chunks is greater than or equal to 20.The
sh.status()
method has the following parameter:Parameter Type Description verbose
Boolean Optional. If true
, the method displays details of the document distribution across chunks when you have 20 or more chunks.See also
Output Examples¶
The Sharding Version section displays information on the config database:
The Shards section lists information on the shard(s). For each shard, the section displays the name, host, and the associated tags, if any.
The Databases section lists information on the database(s). For each database, the section displays the name, whether the database has sharding enabled, and the primary shard for the database.
The Sharded Collection section provides information on the sharding details for sharded collection(s). For each sharded collection, the section displays the shard key, the number of chunks per shard(s), the distribution of documents across chunks [1], and the tag information, if any, for shard key range(s).
Output Fields¶
Sharding Version¶
-
sh.status.sharding-version.
version
¶ The
version
is the version of the config server for the sharded cluster.
-
sh.status.sharding-version.
minCompatibleVersion
¶ The
minCompatibleVersion
is the minimum compatible version of the config server.
-
sh.status.sharding-version.
currentVersion
¶ The
currentVersion
is the current version of the config server.
Shards¶
The
tags
displays all the tags for the shard. The field only displays if the shard has tags.
Databases¶
-
sh.status.databases.
partitioned
¶ The
partitioned
displays whether the database has sharding enabled. Iftrue
, the database has sharding enabled.
-
sh.status.databases.
primary
¶ The
primary
displays the primary shard for the database.
Sharded Collection¶
-
sh.status.databases.
chunks
¶ The
chunks
lists all the shards and the number of chunks that reside on each shard.
-
sh.status.databases.
chunk-details
¶ The
chunk-details
lists the details of the chunks [1]:- The range of shard key values that define the chunk,
- The shard where the chunk resides, and
- The last modified timestamp for the chunk.
-
sh.status.databases.
tag
¶ The
tag
lists the details of the tags associated with a range of shard key values.
[1] | (1, 2) The sharded collection section, by default,
displays the chunk information if the total number of chunks is less
than 20. To display the information when you have 20 or more chunks,
call the sh.status() methods with the verbose parameter
set to true , i.e. sh.status(true) . |