Menu Docs

Página inicial do Docs → Desenvolver aplicações → Manual do MongoDB

cursor.explain()

Nesta página

  • Definição
  • Comportamento
  • Saída
  • Exemplo

Definição

cursor.explain(verbosity)

Importante

Método mongosh

Esta página documenta um método mongosh . Esta não é a documentação para um driver específico de idioma, como Node.js.

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

Fornece informações sobre o plano de query para o método db.collection.find() .

O método explain() tem o seguinte formulário:

db.collection.find().explain()

O método explain() tem o seguinte parâmetro:

Parâmetro
Tipo
Descrição
verbose
string

Opcional. Especifica o modo de verbosidade para o resultado de explicação. O modo afeta o comportamento de explain() e determina a quantidade de informações a serem retornadas. Os modos possíveis são: "queryPlanner", "executionStats" e "allPlansExecution".

O modo padrão é "queryPlanner".

Para compatibilidade com versões anteriores do cursor.explain(), MongoDB interpreta true como "allPlansExecution" e false como "queryPlanner".

Para obter mais informações sobre os modos, consulte Modos de Verbosidade.

O método explain() retorna um documento com o plano de query e, opcionalmente, as estatísticas de execução.

Comportamento

Observação

O uso do explain ignora todas as entradas de cache do plano existentes e impede que o planejador de query do MongoDB crie uma nova entrada de cache do plano.

Modos de Verbosidade

O comportamento de cursor.explain() e a quantidade de informações retornadas dependem do modo verbosity .

queryPlanner Modo

Por padrão, o cursor.explain() executa no modo de verbosidade do queryPlanner .

O MongoDB executa o otimizador de query para escolher o plano vencedor para a operação em avaliação. cursor.explain() retorna as informações queryPlanner do método avaliado.

executionStats Modo

O MongoDB executa o otimizador de query para escolher o plano vencedor, executa o plano vencedor até a conclusão e retorna estatísticas que descrevem a execução do plano vencedor.

cursor.explain() retorna as informações queryPlanner e executionStats do método avaliado. No entanto, o executionStats não fornece informações de execução da query para os planos rejeitados.

allPlansExecution Modo

O MongoDB executa o otimizador de query para escolher o plano vencedor e executar o plano vencedor para conclusão. No modo "allPlansExecution", MongoDB retorna estatísticas descrevendo a execução do plano vencedor, bem como estatísticas para os outros planos candidatos capturados durante a seleção do plano.

cursor.explain() retorna as informações queryPlanner e executionStats do método avaliado. O executionStats inclui as informações de execução da query concluídas para o plano vencedor.

Se o otimizador de query considerar mais de um plano, as informaçõesexecutionStats também incluirão as informações de execução parcial capturadas durante a fase de seleção do plano para os planos de candidatos vencedores e rejeitados.

db.collection.explain().find()

db.collection.explain().find() é semelhante ao db.collection.find().explain() com as seguintes diferenças principais:

Consulte db.collection.explain() para mais informações.

Saída

cursor.explain() as operações podem retornar informações sobre:

  • explainVersion, a versão do formato de saída (por exemplo, "1").

  • command, que detalha o comando a ser explicado.

  • queryPlanner, que detalha o plano selecionado pelo otimizador de query e lista os planos rejeitados.

  • executionStats, que detalha a execução do plano vencedor e os planos rejeitados.

  • serverInfo, que fornece informações sobre a instância MongoDB.

  • serverParameters, que detalha os parâmetros internos.

O modo de verbosidade (ou seja, queryPlanner, executionStats, allPlansExecution) determina se os resultados incluem executionStats e se executionStats inclui dados capturados durante a seleção do plano.

A saída de explicação é limitada pela profundidade máxima aninhada para documentos BSON, que é de 100 níveis de aninhamento. A saída de explicações que excede o limite é truncada.

Para obter detalhes sobre o resultado, consulte Explicar os resultados.

Exemplo

O exemplo a seguir funciona cursor.explain() no modo verbosidade "executionStats" para retornar as informações de planejamento e execução da query para a operação db.collection.find() especificada:

db.products.find(
   { quantity: { $gt: 50 }, category: "apparel" }
).explain("executionStats")
← cursor.count()
cursor.forEach() →

Nesta página