explicar (comando de banco de dados)

Definição

explain

The explain command provides information on the execution of the following commands: aggregate, count, distinct, find, findAndModify, delete, mapReduce, and update.

Dica

In mongosh, this command can also be run through the db.collection.explain() and cursor.explain() helper methods.

Helper methods are convenient for mongosh users, but they may not return the same level of information as database commands. In cases where the convenience is not needed or the additional return fields are required, use the database command.

Observação

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

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

• 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

Acesso necessário

Para utilizar o explain, você deve ter permissão para executar o comando subjacente.

Sintaxe

O comando tem a seguinte sintaxe:

db.runCommand(
   {
     explain: <command>,
     verbosity: <string>,
     comment: <any>
   }
)

Campos de comando

O comando utiliza os seguintes campos:

Comportamento

Saída

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.

• queryShapeHash, começando no MongoDB 8.0, que é uma string hexadecimal com o hash de uma forma de consulta. Para obter detalhes, consulte Formas de consulta, Hash de forma de consulta e explain.queryShapeHash.

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

Exemplos

db.runCommand(
   {
     explain: { count: "products", query: { quantity: { $gt: 50 } } },
     verbosity: "queryPlanner"
   }
)

db.runCommand(
   {
      explain: { count: "products", query: { quantity: { $gt: 50 } } },
      verbosity: "executionStats"
   }
)

db.runCommand(
   {
     explain: {
        update: "products",
        updates: [
           {
               q: { quantity: 1057, category: "apparel" },
               u: { $set: { reorder: true } }
           }
        ]
     }
   }
)