PlanCache.clear()

Definition

PlanCache.clear()

Removes all cached query plans for a collection.

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 planCacheClear command.

For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.

The method is only available from the plan cache object of a specific collection; i.e.

db.collection.getPlanCache().clear()

For example, to clear the cache for the orders collection:

db.orders.getPlanCache().clear()

Compatibility

This method is available in deployments hosted in the following environments:

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB

• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB

Required Access

On systems running with authorization, a user must have access that includes the planCacheWrite action.