PlanCache.clearPlansByQuery()
On this page
Definition
PlanCache.clearPlansByQuery( <query>, <projection>, <sort> )
Clears the cached query plans for the specified plan cache query shape.
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().clearPlansByQuery( <query>, <projection>, <sort> ) The
PlanCache.clearPlansByQuery()
method accepts the following parameters:ParameterTypeDescriptionquery
documentThe query predicate of the plan cache query shape. Only the structure of the predicate, including the field names, are significant to the shape; the values in the query predicate are insignificant.projection
documentOptional. The projection associated with the plan cache query shape. Required if specifying thesort
parameter.sort
documentOptional. The sort associated with the plan cache query shape.To see the query shapes for which cached query plans exist, see Examples.
Starting in MongoDB 8.0, use query settings instead of adding index filters. Index filters are deprecated starting in MongoDB 8.0.
Query settings have more functionality than index filters. Also, index
filters aren't persistent and you cannot easily create index filters for
all cluster nodes. To add query settings and explore examples, see
setQuerySettings
.
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.
Example
If a collection orders
has the following plan cache query shape:
{ "query" : { "qty" : { "$gt" : 10 } }, "sort" : { "ord_date" : 1 }, "projection" : { }, "planCacheShapeHash" : "9AAD95BE" }
Warning
Starting in MongoDB 8.0, the pre-existing queryHash
field is renamed
to planCacheShapeHash
. If you're using an earlier MongoDB version,
you'll see queryHash
instead of planCacheShapeHash
.
The following operation removes the query plan cached for the shape:
db.orders.getPlanCache().clearPlansByQuery( { "qty" : { "$gt" : 10 } }, { }, { "ord_date" : 1 } )