db.collection.totalIndexSize()
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.
For the legacy
mongo
shell documentation, refer to the documentation for the corresponding MongoDB Server release: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.Starting in MongoDB 4.4, 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.In previous versions, the operations also run when the member is in
STARTUP2
. The operations wait until the member transitioned toRECOVERING
.