This version of the documentation is archived and no longer supported.




New in version 2.6.

Displays the cached query plans for the specified query shape.

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

The mongo shell provides the wrapper PlanCache.getPlansByQuery() for this command.

The planCacheListPlans command has the following syntax:

      planCacheListPlans: <collection>,
      query: <query>,
      sort: <sort>,
      projection: <projection>

The planCacheListPlans command has the following field:

Field 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.
sort document Optional. The sort associated with the query shape.

To see the query shapes for which cached query plans exist, use the planCacheListQueryShapes command.

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

Required Access

On systems running with authorization, a user must have access that includes the planCacheRead action.


If a collection orders has the following query shape:

  "query" : { "qty" : { "$gt" : 10 } },
  "sort" : { "ord_date" : 1 },
  "projection" : { }

The following operation displays the query plan cached for the shape:

      planCacheListPlans: "orders",
      query: { "qty" : { "$gt" : 10 } },
      sort: { "ord_date" : 1 }