planCacheListFilters

本页

定义

兼容性
语法
命令字段
所需访问权限
输出

定义

planCacheListFilters

返回:	列出索引过滤器的文档。参见输出.

查询设置

从MongoDB 8.0开始，使用查询设置而不是添加索引过滤器。从MongoDB 8.0开始，索引过滤器已被弃用。

查询设置比索引过滤器具有更多功能。此外，索引过滤器不可持久，并且您无法轻松为所有集群节点创建索引过滤器。要添加查询设置并查看示例，请参阅setQuerySettings。

兼容性

此命令在以下环境中托管的应用程序中可用

MongoDB Atlas：云中MongoDB部署的全托管服务

重要

此命令不支持M0、M2和M5集群。有关更多信息，请参阅不支持命令。

MongoDB Enterprise：基于订阅的、自管理的MongoDB版本
MongoDB Community：源代码可用、免费使用且自管理的MongoDB版本

语法

该命令具有以下语法

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

命令字段

该命令具有以下字段

字段	类型	描述
`planCacheListFilters`	string	集合的名称。
`comment`	any	可选。用户提供的注释，可附加到此命令。一旦设置，此注释将出现在以下位置的相关命令记录中 mongod 日志消息中的`attr.command.cursor.comment`字段。数据库分析器输出，在`command.comment`字段。 `currentOp`输出，在`command.comment`字段。注释可以是任何有效的BSON类型（字符串、整数、对象、数组等）。

所需权限

用户必须拥有包括planCacheIndexFilter操作的访问权限。

输出

planCacheListFilters命令返回以下格式的文档

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

planCacheListFilters.filters

包含索引过滤器信息的文档数组。

每个文档包含以下字段

planCacheListFilters.filters.query

与此过滤器关联的查询谓词。尽管 query 显示用于创建索引过滤器的特定值，但谓词中的值是无关紧要的；即查询谓词覆盖了具有不同值的类似查询。

例如，一个 query 谓词为 { "type": "electronics", "status" : "A" } 覆盖以下查询谓词

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

planCacheListFilters.filters.sort: 与此过滤器关联的排序。可以是空文档。

planCacheListFilters.filters.projection: 与该过滤器关联的投影。可能是一个空文档。

planCacheListFilters.filters.collation: 与该过滤器关联的排序规则。可能是一个空文档。

planCacheListFilters.filters.indexes

计划缓存查询形状的索引数组。

计划缓存查询形状是以下字段的组合

查询
排序
投影
排序规则

为了选择最佳查询计划，查询优化器评估indexes 和集合扫描。

planCacheListFilters.ok: 命令的状态。

提示

另请参阅

planCacheClearFilters

planCacheSetFilter