db.collection.totalIndexSize()
On this page
db.collection.totalIndexSize()
Important
mongosh Method
This page documents a
mongosh
method. This is not the documentation for database commands or language-specific drivers, such as Node.js.For the database command, see the
totalIndexSize
field returned by thecollStats
command.For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.
Returns: The total size of all indexes for the collection. If an index uses prefix compression (which is the
default for WiredTiger
), the returned size reflects the compressed size.To run on a replica set member,
collStats
operations require the member to be inPRIMARY
orSECONDARY
state. If the member is in another state, such asSTARTUP2
, the operation errors.
Compatibility
This method is available in deployments hosted in the following environments:
MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud
Note
This command is supported in all MongoDB Atlas clusters. For information on Atlas support for all commands, see Unsupported Commands.
MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB