PlanCache.clearPlansByQuery()
On this page
Definition
PlanCache.clearPlansByQuery( <query>, <projection>, <sort> )
Clears the cached query plans for the specified query shape.
Important
mongo Shell Method
This page documents a
mongo
method. This is not the documentation for database commands or language-specific drivers, such as Node.js. To use the database command, see theplanCacheClear
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 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 query shape. Required if specifying thesort
parameter.sort
documentOptional. The sort associated with the query shape.To see the query shapes for which cached query plans exist, see List Query Shapes.
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 query shape:
{ "query" : { "qty" : { "$gt" : 10 } }, "sort" : { "ord_date" : 1 }, "projection" : { }, "queryHash" : "9AAD95BE" // Available starting in MongoDB 4.2 }
The following operation removes the query plan cached for the shape:
db.orders.getPlanCache().clearPlansByQuery( { "qty" : { "$gt" : 10 } }, { }, { "ord_date" : 1 } )