Navigation
This is an upcoming (i.e. in progress) version of the manual.

PlanCache.getPlansByQuery()

Definition

PlanCache.getPlansByQuery(<query>, <projection>, <sort>)

Note

MongoDB 4.2 adds a new aggregation pipeline stage $planCacheStats that provides plan cache information for a collection.

The $planCacheStats aggregation stage is preferred over the PlanCache.getPlansByQuery() method/planCacheListPlans command and PlanCache.listQueryShapes() method/planCacheListQueryShapes command.

Displays the cached query plans for the specified query shape.

To help identify slow queries with the same query shape, starting in MongoDB 4.2, each query shape is associated with a queryHash. The queryHash is a hexadecimal string that represents a hash of the query shape and is dependent only on the query shape.

Note

As with any hash function, two different query shapes may result in the same hash value. However, the occurrence of hash collisions between different query shapes is unlikely.

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

The method is only available from the plan cache object of a specific collection; i.e.

db.collection.getPlanCache().getPlansByQuery( <query>, <projection>, <sort> )

The PlanCache.getPlansByQuery() method accepts the following parameters:

Parameter Type Description
query document The 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 document Optional. The projection associated with the query shape. Required if specifying the sort parameter.
sort document Optional. The sort associated with the query shape.
Returns:Array of cached query plans for a query shape.

To see the query shapes for which cached query plans exist, use the PlanCache.listQueryShapes() method.

New in version 3.6: The PlanCache.getPlansByQuery() method returns the same output as the planCacheListPlans database command.

Required Access

On systems running with authorization, a user must have access that includes the planCacheRead 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 displays the query plan cached for the shape:

db.orders.getPlanCache().getPlansByQuery(
   { "qty" : { "$gt" : 10 } },
   { },
   { "ord_date" : 1 }
)