ANNOUNCEMENT: Voyage AI joins MongoDB to power more accurate and trustworthy AI applications on Atlas.
Learn more
Menu Docs

planCacheListFilters

planCacheListFilters

Lista 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.

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.

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, M2, M5 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

O comando tem a seguinte sintaxe:

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

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).

O usuário deve ter acesso que inclua a ação planCacheIndexFilter .

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 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:

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.

Veja também: