planCacheListFilters¶

On this page

Definition
Required Access
Output

Definition¶

planCacheListFilters¶

New in version 2.6.

Lists the index filters associated with query shapes for a collection.

The command has the following syntax:

db.runCommand( { planCacheListFilters: <collection> } )

The planCacheListFilters command has the following field:

Field	Type	Description
`planCacheListFilters`	string	The name of the collection.

Returns:	Document listing the index filters. See Output.

Required Access¶

A user must have access that includes the planCacheIndexFilter action.

Output¶

The planCacheListFilters command returns the document with the following form:

copy

{
   "filters" : [
      {
         "query" : <query>
         "sort" : <sort>,
         "projection" : <projection>,
         "indexes" : [
            <index1>,
            ...
         ]
      },
      ...
   ],
   "ok" : 1
}

planCacheListFilters.filters¶

The array of documents that contain the index filter information.

Each document contains the following fields:

planCacheListFilters.filters.query¶

The query predicate associated with this filter. Although the query shows the specific values used to create the index filter, the values in the predicate are insignificant; i.e. query predicates cover similar queries that differ only in the values.

For instance, a query predicate of { "type": "electronics", "status" : "A" } covers the following query predicates:

copy

{ type: "food", status: "A" }
{ type: "utensil", status: "D" }

Together with the sort and the projection, the query make up the query shape for the specified index filter.

planCacheListFilters.filters.sort¶

The sort associated with this filter. Can be an empty document.

Together with the query and the projection, the sort make up the query shape for the specified index filter.

planCacheListFilters.filters.projection¶

The projection associated with this filter. Can be an empty document.

Together with the query and the sort, the projection make up the query shape for the specified index filter.

planCacheListFilters.filters.indexes¶: The array of indexes for this query shape. To choose the optimal query plan, the query optimizer evaluates only the listed indexes and the collection scan.

planCacheListFilters.ok¶: The status of the command.