db.collection.totalIndexSize()
db.collection.totalIndexSize()
Important
mongosh Method
This is a
mongosh
method. This is not the documentation forNode.js
or other programming language specific driver methods.In most cases,
mongosh
methods work the same way as the legacymongo
shell methods. However, some legacy methods are unavailable inmongosh
.For the legacy
mongo
shell documentation, refer to the documentation for the corresponding MongoDB Server release: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.This method provides a wrapper around the
totalIndexSize
output of thecollStats
(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 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
.