db.collection.getPlanCache()¶

On this page

Definition¶

db.collection.getPlanCache()¶

Important

mongosh Method

This page documents a mongosh method. This is not the documentation for a language-specific driver such as Node.js.

For MongoDB API drivers, refer to the language-specific :driver:`MongoDB driver documentation </>`.

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

Returns an interface to access the query plan cache for a collection. The interface provides methods to view and clear the query plan cache.

Returns:	Interface to access the query plan cache.

The query optimizer only caches the plans for those query shapes that can have more than one viable plan.

The following methods are available through the interface:

Name	Description
`PlanCache.help()`	Displays the methods available for a collection’s query plan cache. Accessible through the plan cache object of a specific collection, i.e. `db.collection.getPlanCache().help()`.
`PlanCache.clearPlansByQuery()`	Clears the cached query plans for the specified query shape. Accessible through the plan cache object of a specific collection, i.e. `db.collection.getPlanCache().clearPlansByQuery()`
`PlanCache.clear()`	Clears all the cached query plans for a collection. Accessible through the plan cache object of a specific collection, i.e. `db.collection.getPlanCache().clear()`.
`PlanCache.list()`	Returns the plan cache information for a collection. Accessible through the plan cache object of a specific collection, i.e. `db.collection.getPlanCache().list()`. New in version 4.4.

← Query Plan Cache Methods PlanCache.clear() →