db.collection.totalIndexSize()¶

db.collection.totalIndexSize()¶

Important

mongosh Method

This page documents a mongosh method. This is not the documentation for a language-specific driver such as Node.js.

For MongoDB API drivers, refer to the language-specific :driver:`MongoDB driver documentation </>`.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

:v4.4:`mongo shell v4.4 </mongo>`
mongo shell v4.2

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 also run when the member is in STARTUP2. The operations wait until the member transitioned to RECOVERING.

← db.collection.storageSize() db.collection.totalSize() →