Definição
planCacheListFiltersLista os filtros de índice associados às formas de query do cache do plano para uma collection.
Retorna: Documento que lista os filtros de índice. Consulte Saída.
Configurações de query
A partir do MongoDB 8.0, use configurações de query em vez de adicionar filtros de índice. Os filtros de índice estão obsoletos a partir do MongoDB 8.0.
As configurações de query têm mais funcionalidades do que os filtros de índice. Além disso, os filtros de índice não são persistentes e você não pode criar facilmente filtros de índice para todos os nós de cluster. Para adicionar configurações de query e explorar exemplos, consulte setQuerySettings.
Compatibilidade
Esse comando está disponível em implantações hospedadas nos seguintes ambientes:
- MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem
Importante
Esse comando não é suportado em clusters M0 e Flex. Para obter mais informações, consulte Comandos não suportados.
MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB
MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB
Sintaxe
O comando tem a seguinte sintaxe:
db.runCommand( { planCacheListFilters: <collection> } )
Campos de comando
O comando tem os seguintes campos:
Campo | Tipo | Descrição |
|---|---|---|
| string | O nome da collection. |
| any | Opcional. Um comentário fornecido pelo usuário para anexar a este comando. Depois de definido, esse comentário aparece junto com os registros desse comando nos seguintes locais:
Um comentário pode ser qualquer tipo BSON válido (string, inteiro, objeto, array etc). |
Acesso necessário
O usuário deve ter acesso que inclua a ação planCacheIndexFilter .
Saída
The planCacheListFilters command returns the document with the following form:
{ "filters" : [ { "query" : <query> "sort" : <sort>, "projection" : <projection>, "collation" : <collation>, "indexes" : [ <index1>, ... ] }, ... ], "ok" : 1 }
planCacheListFilters.filtersA array de documentos que contêm as informações do filtro de índice.
Cada documento contém os seguintes campos:
planCacheListFilters.filters.queryThe query predicate associated with this filter. Although the
queryshows 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
querypredicate of{ "type": "electronics", "status" : "A" }covers the following query predicates:{ type: "food", status: "A" } { type: "utensil", status: "D" }
planCacheListFilters.filters.sortA classificação associada a este filtro. Pode ser um documento vazio.
planCacheListFilters.filters.projectionA projeção associada a este filtro. Pode ser um documento vazio.
planCacheListFilters.filters.collationO agrupamento associado a este filtro. Pode ser um documento vazio.
planCacheListFilters.filters.indexesA array de índices para a forma de query do cache do plano.
A forma de query do cache do plano é a combinação destes campos:
To choose the best query plan, the query optimizer evaluates the
indexesand the collection scan.