db.collection.getPlanCache()
On this page
This version of the documentation is archived and no longer
supported. View the current documentation to learn how to
upgrade your version of MongoDB.
Definition
db.collection.getPlanCache()Important
mongo Shell Method
This page documents the
mongoshell method, and does not refer to the MongoDB Node.js driver (or any other driver) method. For corresponding MongoDB driver API, refer to your specific MongoDB driver documentation instead.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.
Methods
The following methods are available through the interface:
Name | Description |
|---|---|
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(). | |
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() | |
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(). | |
Returns the plan cache information for a collection. Accessible
through the plan cache object of a specific collection, i.e.
New in version 4.4. |