planCacheClearFilters (original) (raw)
planCacheClearFilters
Removes index filters on a collection. Although index filters only exist for the duration of the server process and do not persist after shutdown, you can also clear existing index filters with the planCacheClearFilterscommand.
Specify the plan cache query shape to remove a specific index filter. Omit the plan cache query shape to clear all index filters on a collection.
Starting in MongoDB 8.0, use query settings instead of addingindex 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, seesetQuerySettings.
This command is available in deployments hosted in the following environments:
- MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud
Important
This command is not supported in M0, M2, M5, and Flex clusters. For more information, see Unsupported Commands.
- MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
- MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB
The command has the following syntax:
db.runCommand(
{
planCacheClearFilters: <collection>,
query: <query pattern>,
sort: <sort specification>,
projection: <projection specification>,
collation: { <collation> },
comment: <any>
}
)
The command has the following fields:
| Field | Type | Description |
|---|---|---|
| planCacheClearFilters | string | The name of the collection to remove the index filters from. |
| query | document | Optional. The query predicate for the index filter to remove. If omitted, the command clears all index filters from the collection.The values in the query predicate do not:Determine the plan cache query shape.Need to match the values returned byplanCacheListFilters. |
| sort | document | Optional. The sort for the index filter to remove, if any. |
| projection | document | Optional. The projection for the index filter to remove, if any. |
| collation | document | Specifies the collation to use for the operation.Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.The collation option has the following syntax:collation: { locale: , caseLevel: , caseFirst: , strength: , numericOrdering: , alternate: , maxVariable: , backwards: }When specifying collation, the locale field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.If the collation is unspecified but the collection has a default collation (see db.createCollection()), the operation uses the collation specified for the collection.If no collation is specified for the collection or for the operations, MongoDB uses the simple binary comparison used in prior versions for string comparisons.You cannot specify multiple collations for an operation. For example, you cannot specify different collations per field, or if performing a find with a sort, you cannot use one collation for the find and another for the sort.Starting in MongoDB 6.0, an index filter uses the collation previously set using the planCacheSetFiltercommand.Starting in MongoDB 8.0, use query settings instead of addingindex 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, seesetQuerySettings. |
| comment | any | Optional. A user-provided comment to attach to this command. Once set, this comment appears alongside records of this command in the following locations:mongod log messages, in theattr.command.cursor.comment field.Database profiler output, in the command.comment field.currentOp output, in the command.comment field.A comment can be any valid BSON type(string, integer, object, array, etc). |
A user must have access that includes theplanCacheIndexFilter action.
The orders collection contains the following index filters:
{
"query" : { "status" : "A" },
"sort" : { "ord_date" : -1 },
"projection" : { },
"indexes" : [ { "status" : 1, "cust_id" : 1 } ]
}
{
"query" : { "status" : "A" },
"sort" : { },
"projection" : { },
"indexes" : [ { "status" : 1, "cust_id" : 1 } ]
}
{
"query": { "item": "Movie" },
"collation": { locale: "en_US" },
"indexes": [ { "item": 1, "order_date": 1 , "quantity": 1 } ]
}
Note
Starting in MongoDB 6.0, an index filter uses the collation previously set using the planCacheSetFiltercommand.
Starting in MongoDB 8.0, use query settings instead of addingindex 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, seesetQuerySettings.
The following command removes the second index filter only:
db.runCommand(
{
planCacheClearFilters: "orders",
query: { "status" : "A" }
}
)
Because the values in the query predicate are insignificant in determining the plan cache query shape, the following command would also remove the second index filter:
db.runCommand(
{
planCacheClearFilters: "orders",
query: { "status" : "P" }
}
)
The following example clears all index filters on the orderscollection:
db.runCommand(
{
planCacheClearFilters: "orders"
}
)
The following example clears the index filter containing the query onMovie and the collation en_US for the orders collection:
db.runCommand(
{
planCacheClearFilters: "orders",
query: { item: "Movie" },
collation: { locale: "en_US" }
}
)
See also: