Docs Menu

Docs HomeMongoDB Manual

PlanCache.clear()

On this page

  • Definition
  • Required Access
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.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

mongo shell v4.4

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()

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

Tip

See also:

←  db.collection.getPlanCache()PlanCache.clearPlansByQuery() →
Share Feedback
© 2023 MongoDB, Inc.

About

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