mongo Shell Method

This page documents the mongo shell method, and does not refer to the MongoDB Node.js driver (or any other driver) method. For corresponding MongoDB driver API, refer to your specific MongoDB driver documentation instead.

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.

This method provides a wrapper around the totalIndexSize output of the collStats (i.e. db.collection.stats()) operation.

Starting in MongoDB 4.4, to run on a replica set member, collStats operations require the member to be in PRIMARY or SECONDARY state. If the member is in another state, such as STARTUP2, the operation errors.

In previous versions, the operations can also be run when the member is in STARTUP2. However, the operations wait until the member transitions to RECOVERING.