Menu Docs
Página inicial do Docs
/
Manual do MongoDB
/
Referência
/
Comandos de banco de dados
/
Cache do plano de consulta

planCacheListFilters

Nesta página

  • Definição
  • Compatibilidade
  • Sintaxe
  • Campos de comando
  • Acesso necessário
  • Saída

Definição

planCacheListFilters

Lista osfiltros de índice associados às formas de query para uma collection.

Retorna:Documento que lista os filtros de índice. ConsulteSaída .

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

Este comando não é suportado em clusters M0, M2 e M5 . 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

planCacheListFilters

string

O nome da collection.

comment

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

O comando planCacheListFilters retorna o documento com o seguinte formulário:

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

A array de documentos que contêm as informações do filtro de índice.

Cada documento contém os seguintes campos:

planCacheListFilters.filters.query

O predicado de query associado a este filtro. Embora o query mostre os valores específicos utilizados para criar o filtro de índice, os valores no predicado são insignificantes; ou seja, os predicados da query abrangem queries semelhantes que diferem apenas nos valores.

Por exemplo, um predicado query de { "type": "electronics", "status" : "A" } cobre os seguintes predicados de query:

{ type: "food", status: "A" }
{ type: "utensil", status: "D" }
planCacheListFilters.filters.sort

A classificação associada a este filtro. Pode ser um documento vazio.

planCacheListFilters.filters.projection

A projeção associada a este filtro. Pode ser um documento vazio.

planCacheListFilters.filters.collation

O agrupamento associado a este filtro. Pode ser um documento vazio.

planCacheListFilters.filters.indexes

A matriz de índices para a forma de query.

A forma de query é a combinação destes campos:

Para escolher o melhor plano de query, o otimizador de query avalia o indexes e a verificação de collection.

planCacheListFilters.ok

O status do comando.

Dica

Veja também:

Voltar

planCacheClearFilters

Próximo

planCacheSetFilter