PlanCache.clearPlansByQuery() (método mongosh)

Definição

PlanCache.clearPlansByQuery( <query>, <projection>, <sort> )

Limpa os planos de query em cache para a forma de query especificada.

Importante

Método mongosh

Esta página documenta um método mongosh. Esta não é a documentação de comandos de banco de dados nem drivers específicos de linguagem, como Node.js.

Para o comando do banco de dados, consulte o comando planCacheClear.

Para drivers de API do MongoDB, consulte a documentação do driver do MongoDB específica da linguagem.

O método está disponível somente a partir do plan cache object de uma collection específica; p ex.,

db.collection.getPlanCache().clearPlansByQuery( <query>, <projection>, <sort> )

O método PlanCache.clearPlansByQuery() aceita os seguintes parâmetros:

Parâmetro	Tipo	Descrição
query	documento	O predicado de query da forma de query. Somente a estrutura do predicado, incluindo os nomes dos campos, é significativa para a forma; os valores no predicado de query são insignificantes.
projection	documento	Opcional. A projeção associada à forma de query. Obrigatório ao especificar o parâmetro sort .
sort	documento	Opcional. A classificação associada à forma de query.

Para ver as formas de consulta para as quais existem planos de consulta em cache, consulte Exemplos.

Acesso necessário

Em sistemas executados com authorization, um usuário deve ter acesso que inclua a ação planCacheWrite.

Exemplo

Se uma collection orders tiver a seguinte forma de query:

{
  "query" : { "qty" : { "$gt" : 10 } },
  "sort" : { "ord_date" : 1 },
  "projection" : { },
  "queryHash" : "9AAD95BE"
}

A seguinte operação remove o plano de query armazenado em cache para a forma:

db.orders.getPlanCache().clearPlansByQuery(
   { "qty" : { "$gt" : 10 } },
   { },
   { "ord_date" : 1 }
)