MongoDB Collection Total Index Size

In MongoDB, the totalIndexSize operation is used to retrieve the total size of all indexes for a collection. This method is essential for understanding the storage utilization of indexes within MongoDB collections.

Syntax

db.collection.totalIndexSize()

The totalIndexSize method does not take any parameters and returns the total size in bytes of all indexes on the specified collection.

Example MongoDB Collection Total Index Size

Let's look at an example of how to use the totalIndexSize method in the programGuru collection in MongoDB:

1. Retrieve Total Index Size

db.programGuru.totalIndexSize()

This command retrieves the total size of all indexes for the programGuru collection.

Full Example

Let's go through a complete example that includes switching to a database, creating a collection, creating indexes, and retrieving the total index size of the collection.

Step 1: Switch to a Database

This step involves switching to a database named myDatabase.

use myDatabase

In this example, we switch to the myDatabase database.

Step 2: Create a Collection

This step involves creating a new collection named programGuru in the myDatabase database.

db.createCollection("programGuru")

Here, we create a collection named programGuru.

Step 3: Insert Documents into the Collection

This step involves inserting documents into the programGuru collection.

db.programGuru.insertMany([
    { name: "John Doe", age: 30, email: "john.doe@example.com" },
    { name: "Jane Smith", age: 25, email: "jane.smith@example.com" },
    { name: "Jim Brown", age: 35, email: "jim.brown@example.com" }
])

We insert multiple documents into the programGuru collection.

Step 4: Create Indexes

This step involves creating multiple indexes in the programGuru collection.

db.programGuru.createIndexes([
    { key: { name: 1 }, name: "name_index" },
    { key: { age: -1 }, name: "age_index" },
    { key: { email: 1 }, name: "email_index", unique: true }
])

We create three indexes: an ascending index on the name field, a descending index on the age field, and a unique index on the email field.

Step 5: Retrieve Total Index Size

This step involves using the totalIndexSize method to retrieve the total size of all indexes on the programGuru collection.

db.programGuru.totalIndexSize()

We retrieve the total size of all indexes for the programGuru collection.

Conclusion

The MongoDB totalIndexSize operation is crucial for understanding the storage utilization of indexes within collections. Understanding how to use this method allows you to efficiently manage and optimize the index storage of your MongoDB collections.

◀ Previous Next ▶

MongoDB Databases

MongoDB Collections

Document CRUD Ops

mongosh Collection Methods

MongoDB Collection Total Index Size