Docs Menu

Docs HomeMongoDB Manual

db.collection.totalSize()

db.collection.totalSize()

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 totalSize field returned by the collStats 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 in bytes of the data in the collection plus the size of every index on the collection.

If collection data is compressed (which is the default for WiredTiger), the returned size reflects the compressed size of the collection data.

If an index uses prefix compression (which is the default for WiredTiger), the returned size reflects the compressed size of the index.

The value returned is the sum of db.collection.storageSize() and db.collection.totalIndexSize() in bytes.

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.totalIndexSize()db.collection.unhideIndex() →
Share Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.