Explicação de resultados

queryPlanner

explain.queryPlanner detalha o plano selecionado pelo otimizador de query.

Os exemplos a seguir podem combinar a saída dos mecanismos de execução clássicos e baseados em slots e não são representativos. Sua saída pode ser diferente.

queryPlanner: {
   namespace: <string>,
   indexFilterSet: <boolean>,
   parsedQuery: {
      ...
   },
   planCacheShapeHash: <hexadecimal string>,
   planCacheKey: <hexadecimal string>,
   maxIndexedOrSolutionsReached: <boolean>,
   maxIndexedAndSolutionsReached: <boolean>,
   maxScansToExplodeReached: <boolean>,
   winningPlan: {
     stage: <STAGE1>,
     type: <string>,
     inputStage: {
       stage: <string>,
       ...
     }
   },
   rejectedPlans: [
     <candidate plan1>,
   ]
}

{
   queryPlanner: {
      mongosPlannerVersion: <int>
      winningPlan: {
         stage: <STAGE1>,
         type: <string>,
         shards: [
         {
            shardName: <string>,
            connectionString: <string>,
            serverInfo: {
               ...
            },
            namespace: <string>,
            indexFilterSet: <boolean>,
            parsedQuery: {
               ...
            },
            querySettings: {
               ...
            },
            planCacheShapeHash: <hexadecimal string>,
            planCacheKey: <hexadecimal string>,
            maxIndexedOrSolutionsReached: <boolean>,
            maxIndexedAndSolutionsReached: <boolean>,
            maxScansToExplodeReached: <boolean>,
            winningPlan: {
               stage: <STAGE1>,
               type: <string>,
               inputStage: {
                  stage: <string>,
                  ...
               }
            },
            rejectedPlans: [
              <candidate plan1>,
            ]
         }
         ]
      }
   }
}

explain.queryPlanner

Contém informações sobre o plano de query selecionado pelo otimizador de query.

explain.queryPlanner.namespace

String que especificou o namespace do banco de dados e a coleção acessada pela query, no formato <database>.<collection>.

explain.queryPlanner.indexFilterSet

Um booleano que especifica se o MongoDB aplicou um filtro de índice para a forma de query de cache do plano.

explain.queryPlanner.querySettings

Se as configurações de query forem definidas, querySettings conterá detalhes sobre as configurações de query aplicadas à forma de query.

Para adicionar configurações de query e explorar exemplos, que incluem saída explain() com querySettings, consulte setQuerySettings.

Novidades na versão 8.0.

explain.queryPlanner.planCacheShapeHash

A partir do MongoDB 8.0, o campo queryHash existente é duplicado em um novo campo chamado planCacheShapeHash. Se você estiver usando uma versão anterior do MongoDB , verá apenas o campo queryHash. As futuras versões do MongoDB removerão o campo queryHash obsoleto, e você precisará usar o campo planCacheShapeHash em seu lugar.

string hexadecimal. Hash da forma de query do cache do plano, dependente somente da forma de query do cache do plano. Use-o para encontrar queries lentas com a mesma forma de query cache do plano.

Observação

As colisões de hash entre diferentes formas de query do cache do plano são possíveis, mas improváveis.

Para obter mais informações sobre planCacheShapeHash e planCacheKey, consulte planCacheShapeHash e planCacheKey.

explain.queryPlanner.planCacheKey

Hash da chave de entrada do cache do plano. Ao contrário de explain.queryPlanner.planCacheShapeHash, esse valor é uma função da forma de query e dos índices atualmente disponíveis. Adicionar ou descartar índices de suporte pode alterar o planCacheKey, mas não planCacheShapeHash.

Para obter mais informações sobre planCacheShapeHash e planCacheKey, consulte planCacheShapeHash e planCacheKey.

explain.queryPlanner.optimizationTimeMillis

Milissegundos gastos na otimização de queries. Não inclui queries$lookup internas com otimização de tempo.

explain.queryPlanner.optimizedPipeline

Um booleano que indica que toda a operação de aggregation pipeline foi otimizada e, em vez disso, cumprida por uma árvore de estágios de execução do plano de query.

Por exemplo, a seguinte operação de agregação pode ser realizada pela árvore de execução do plano de query em vez de usar o pipeline de agregação.

db.example.aggregate([ { $match: { someFlag: true } } ] )

O campo só está presente se o valor for true e só se aplica para explicar as operações de aggregation pipeline. Quando true, como o pipeline foi otimizado, nenhuma informação do estágio de aggregation aparece no resultado.

explain.queryPlanner.winningPlan

Documento com o plano selecionado pelo otimizador de query.

explain.queryPlanner.winningPlan.stage

String que indica o nome do estágio. Cada estágio contém informações específicas para seu tipo (por exemplo, IXSCAN inclui limites do índice). Estágios com estágios filhos têm um campo inputStage ou inputStages.

Presente quando a operação usou o mecanismo de execução de query clássico.

explain.queryPlanner.winningPlan.type

Se stage estiver definido como "EOF", type será uma string que indica a razão do estágio EOF:

• "nonExistentNamespace": o namespace da query não existe.

• "predicateEvalsToFalse": a simplificação da expressão determina que a query não corresponde a nenhum documento.

explain.queryPlanner.winningPlan.inputStage

Documento que descreve o estágio filho que fornece documentos ou chaves de índice para seu pai. Presente quando o pai tem exatamente um filho.

explain.queryPlanner.winningPlan.inputStages

Array de documentos que descrevem os estágios filhos. Os estágios filhos fornecem os documentos ou chaves de índice para o estágio pai. Presente quando o pai tem vários nós filhos, como em uma expressão $or.

Presente quando a operação usou o mecanismo de execução de query clássico.

explain.queryPlanner.winningPlan.isCached

Um booleano que indica se o vencedor do Plano está no cache do plano.

No máximo um plano (vencedor ou rejeitado) tem este campo definido como true. Se não existir nenhum plano em cache, o campo será false para todos os planos.

explain.queryPlanner.winningPlan.queryPlan

Documento com o plano selecionado pelo otimizador de query, apresentado como uma árvore de estágios.

Presente quando a query usou o mecanismo de query de execução baseado em slot.

Novidades na versão 5.1.

explain.queryPlanner.winningPlan.queryPlan.stage

Uma string que indica o nome do estágio.

Cada estágio contém informações específicas para seu tipo. Por exemplo, IXSCAN inclui limites de índice.

explain.queryPlanner.winningPlan.queryPlan.type

Se stage estiver definido como "EOF", type será uma string que indica a razão do estágio EOF:

• "nonExistentNamespace": indica que o namespace da query não existe.

• "predicateEvalsToFalse": indica que a simplificação da expressão determina que a query não corresponderá a nenhum documento.

explain.queryPlanner.winningPlan.queryPlan.planNodeId

Campo inteiro exclusivo que identifica cada estágio do plano de execução. O campo está incluído em todos os estágios dos resultados explain.

Novidades na versão 5.1.

explain.queryPlanner.winningPlan.queryPlan.inputStage

Consulte explain.queryPlanner.winningPlan.inputStage.

explain.queryPlanner.winningPlan.slotBasedPlan

Documente com informações sobre a árvore e os estágios do plano de execução da query baseada em slot. Para uso interno do MongoDB.

Novidades na versão 5.1.

explain.queryPlanner.winningPlan.slotBasedPlan.stages

String que inclui informações sobre cada estágio do plano de execução da query baseada em slots, incluindo ordem de execução, operações e atribuições de slots. Para uso interno do MongoDB.

A partir do MongoDB 8.0, se uma query usar processamento em bloco, block_to_row e ts_bucket_to_cellblock aparecerão na saída stages.

Alterado na versão 8.0.

explain.queryPlanner.rejectedPlans

Array de planos candidatos considerados e rejeitados pelo otimizador de query. A array pode estar vazia se não houver outros planos candidatos.

Os planos rejeitados têm os mesmos campos que explain.queryPlanner.winningPlan.

A partir do MongoDB 8.0, os planos de query rejeitados contêm apenas a parte find da query. Em versões anteriores, os planos rejeitados podem conter estágios de agregação como $group. Esses estágios de agregação não são usados pelo planejador de query para escolher o plano vencedor, portanto, o campo rejectedPlans contém apenas a parte da query que foi usada para escolher o plano vencedor.

executionStats

As informações explain.executionStats retornadas detalham a execução do plano vencedor. Para incluir executionStats nos resultados, você deve executar a explicação em:

• executionStats ou

• Modo de detalhamento allPlansExecution . Utilize o modo allPlansExecution para incluir dados de execução parcial capturados durante a seleção de plano.

Esses exemplos podem combinar as estruturas de saída dos mecanismos de execução clássicos e baseados em slots do MongoDB. Eles não pretendem ser representativos. Sua saída pode diferir significativamente.

executionStats: {
   executionSuccess: <boolean>,
   nReturned: <int>,
   executionTimeMillis: <int>,
   totalKeysExamined: <int>,
   totalDocsExamined: <int>,
   executionStages: {
      stage: <STAGE1>
      nReturned: <int>,
      executionTimeMillisEstimate: <int>,
      opens: <int>, // Starting in MongoDB 5.1
      closes: <int>, // Starting in MongoDB 5.1
      works: <int>,
      advanced: <int>,
      needTime: <int>,
      needYield: <int>,
      saveState: <int>,
      restoreState: <int>,
      isEOF: <boolean>,
      ...
      inputStage: {
         stage: <STAGE2>,
         nReturned: <int>,
         ...
         numReads: <int>, // Starting in MongoDB 5.1
         ...
         executionTimeMillisEstimate: <int>,
         ...
         spills: <long long>,
         spilledBytes: <long long>,
         spilledRecords: <long long>,
         spilledDataStorageSize: <long long>,
         ...
         inputStage: {
            ...
         }
      }
   },
   allPlansExecution: [
      {
         nReturned: <int>,
         executionTimeMillisEstimate: <int>,
         totalKeysExamined: <int>,
         totalDocsExamined: <int>,
         score: <double>,
         executionStages: {
            stage: <STAGEA>,
            nReturned: <int>,
            executionTimeMillisEstimate: <int>,
            ...
            inputStage: {
               stage: <STAGEB>,
               ...
               inputStage: {
                 ...
               }
            }
         }
      },
      ...
   ]
   operationMetrics: {
      cpuNanos: <int>,
      cursorSeeks: <int>,
      docBytesRead: <int>,
      docBytesWritten: <int>,
      docUnitsRead: <int>,
      docUnitsReturned: <int>,
      docUnitsWritten: <int>,
      idxEntryBytesRead: <int>,
      idxEntryBytesWritten: <int>,
      idxEntryUnitsRead: <int>,
      idxEntryUnitsWritten: <int>,
      totalUnitsWritten: <int>,
      keysSorted: <int>,
      sorterSpills: <int>
   }
}

executionStats: {
   nReturned: <int>,
   executionTimeMillis: <int>,
   totalKeysExamined: <int>,
   totalDocsExamined: <int>,
   executionStages: {
      stage: <STAGE1>
      nReturned: <int>,
      executionTimeMillis: <int>,
      opens: <int>, // Starting in MongoDB 5.1
      closes: <int>, // Starting in MongoDB 5.1
      totalKeysExamined: <int>,
      totalDocsExamined: <int>,
      totalChildMillis: <NumberLong>,
      shards: [
         {
            shardName: <string>,
            executionSuccess: <boolean>,
            executionStages: {
               stage: <STAGE2>,
               nReturned: <int>,
               executionTimeMillisEstimate: <int>,
               ...
               chunkSkips: <int>,
               inputStage: {
                  stage: <STAGE3>,
                  ...
                  numReads: <int>, // Starting in MongoDB 5.1
                  ...
                  spills: <long long>,
                  spilledBytes: <long long>,
                  spilledRecords: <long long>,
                  spilledDataStorageSize: <long long>,
                  ...
                  inputStage: {
                     ...
                  }
               }
            }
         },
         ...
      ]
   }
   allPlansExecution: [
      {
         shardName: <string>,
         allPlans: [
            {
               nReturned: <int>,
               executionTimeMillisEstimate: <int>,
               totalKeysExamined: <int>,
               totalDocsExamined:<int>,
               executionStages: {
                  stage: <STAGEA>,
                  nReturned: <int>,
                  executionTimeMillisEstimate: <int>,
                  ...
                  inputStage: {
                     stage: <STAGEB>,
                     ...
                     inputStage: {
                       ...
                     }
                  }
               }
            },
            ...
         ]
      },
      {
         shardName: <string>,
         allPlans: [
          ...
         ]
      },
      ...
   ]
}

explain.executionStats

Contém estatísticas que descrevem a execução da query concluída para o plano vencedor. Para operações de gravação, a execução da query concluída refere-se às modificações que seriam executadas, mas não aplicam as modificações no banco de dados.

explain.executionStats.nReturned

Número de documentos retornados pelo plano de query vencedor. nReturned corresponde ao campo n retornado pelo cursor.explain() em versões anteriores do MongoDB.

explain.executionStats.executionTimeMillis

Tempo total em milissegundos necessário para a seleção do plano de query e a execução da query. Inclui o tempo necessário para executar a parte da fase de avaliação do processo de seleção do plano, mas não inclui o tempo de rede para transmitir os dados de volta ao cliente.

O tempo relatado por explain.executionStats.executionTimeMillis não é necessariamente representativo do tempo real da query. Durante operações de estado estacionário (quando o plano de query é armazenado em cache) ou ao usar cursor.hint() com cursor.explain(), o MongoDB ignora o processo de seleção do plano, resultando em um tempo real mais rápido, levando a um valor explain.executionStats.executionTimeMillis mais baixo.

explain.executionStats.totalKeysExamined

Número de entradas de índices verificadas. explain.executionStats.totalKeysExamined corresponde ao campo nscanned retornado por cursor.explain() em versões anteriores do MongoDB.

explain.executionStats.totalDocsExamined

Número de documentos examinados durante a execução da query. As etapas comuns de execução de query que examinam documentos são COLLSCAN e FETCH.

Observação

explain.executionStats.totalDocsExamined refere-se ao número total de documentos examinados e não ao número de documentos devolvidos. Por exemplo, um estágio pode examinar um documento para aplicar um filtro. Se o documento for filtrado, ele foi examinado, mas não será retornado como parte do conjunto de resultados da query.

Se um documento for analisado várias vezes durante a execução da consulta, explain.executionStats.totalDocsExamined contará cada análise. Ou seja, explain.executionStats.totalDocsExamined não é uma contagem do número total de documentos exclusivos analisados.

explain.executionStats.executionStages

Detalha a execução completa do plano vencedor como uma árvore de estágios; ou seja, um estágio pode ter um inputStage ou vários inputStages.

A partir do MongoDB 5.1, um estágio pode ter estes estágios de entrada:

• thenStage

• elseStage

• innerStage

• outerStage

Cada estágio consiste em informações de execução específicas do estágio.

explain.executionStats.executionStages.executionTimeMillisEstimate

O tempo estimado em milissegundos para a execução da query.

explain.executionStats.executionStages.opens

A partir do MongoDB 5.1, o número de vezes que um estágio foi aberto durante a execução de query

explain.executionStats.executionStages.closes

A partir do MongoDB 5.1, o número de vezes que um estágio foi fechado durante a execução de query.

explain.executionStats.executionStages.works

Especifica o número de "unidades de trabalho" executadas pelo estágio de execução da query. A execução da query divide seu trabalho em pequenas unidades. Uma "unidade de trabalho" pode consistir em examinar uma única chave de índice, buscar um único documento da collection, aplicar uma projeção a um único documento ou fazer uma contabilidade interna.

Este campo aparece se a operação utilizou o mecanismo de execução de query clássico.

explain.executionStats.executionStages.saveState

O número de vezes que o estágio da query suspendeu o processamento e salvou seu estado de execução atual, por exemplo, na preparação para gerar travas.

explain.executionStats.executionStages.restoreState

O número de vezes que o estágio da query restaurou um estado de execução salvo, por exemplo, depois de recuperar travas que ele havia gerado anteriormente.

explain.executionStats.executionStages.isEOF

Especifica se o estágio de execução atingiu o fim do fluxo:

• Se true ou 1, o estágio de execução chegou ao fim do fluxo.

• Se false ou 0, o estágio ainda pode ter resultados para retornar. Por exemplo, considere uma query com um limite cujos estágios de execução consistem em um estágio LIMIT com um estágio de entrada de IXSCAN para a query. Se a query retornar mais do que o limite especificado, o estágio LIMIT informará isEOF: 1, mas o estágio IXSCAN subjacente informará isEOF: 0.

explain.executionStats.executionStages.opType

Para operações em coleções de séries temporais, o tipo de operação.

explain.executionStats.executionStages.bucketFilter

Para operações em coleções de séries temporais, o filtro usado para reduzir o número de buckets consultados no catálogo de buckets.

explain.executionStats.executionStages.residualFilter

Para operações em coleções de séries temporais, o filtro usado para consultar o catálogo de buckets.

explain.executionStats.executionStages.nBucketsUnpacked

Para operações em coleções de séries temporais, o número de buckets descompactados para resolver a operação.

explain.executionStats.executionStages.nMeasurementsDeleted

Para operações em coleções de séries temporais, o número de documentos excluídos.

explain.executionStats.executionStages.nMeasurementsInserted

Para operações em coleções de séries temporais, o número de documentos inseridos.

explain.executionStats.executionStages.nMeasurementsMatched

Para operações em coleções de séries temporais, o número de documentos correspondentes.

explain.executionStats.executionStages.nMeasurementsModified

Para operações em coleções de séries temporais, o número de documentos modificados.

explain.executionStats.executionStages.nMeasurementsUpserted

Para operações em coleções de séries temporais, o número de documentos atualizados com upsert.

explain.executionStats.executionStages.inputStage

Cada inputStage pode ter campos diferentes dependendo do valor de inputStage.stage. A tabela a seguir descreve possíveis campos e em quais estágios eles podem aparecer.

Cada inputStage pode ter outro inputStage como um campo. Consulte Explicar estrutura de saída.

Campo	Descrição	Estágios aplicáveis
docsExamined	Especifica o número de documentos verificados durante o estágio de execução da query.	COLLSCAN, FETCH
keysExamined	Para estágios de execução de queries que analisam um índice keysExamined é o número total de chaves dentro e fora dos limites que são examinadas no processo de varredura do índice. Se a varredura do índice consistir em uma única faixa contígua de chaves, somente as chaves dentro dos limites precisarão ser examinadas. Se os limites do índice consistirem em várias faixas de chaves, o processo de execução de varredura do índice poderá examinar chaves fora dos limites para pular do final de uma faixa para o início da próxima.	IXSCAN
numReads	O número de documentos verificados ou chaves de índice examinadas durante o estágio de execução da query. Novidades na versão 5.1.	COLLSCAN, IXSCAN
seeks	O número de vezes que tivemos que buscar o cursor do índice para uma nova posição para concluir a varredura do índice.	IXSCAN
usedDisk	Se o estágio foi gravado em disco. Novidades na versão 5.3.	GROUP
spills	O número de vezes que o estágio passou para o disco. Novidades na versão 8.2.	GROUP, SORT
spilledBytes	A quantidade total de dados gravados no disco em bytes. Novidades na versão 8.2.	GROUP, SORT
spilledRecords	O número total de registros individuais transferidos para o disco. Novidades na versão 8.2.	GROUP, SORT
spilledDataStorageSize	O espaço total em disco, em bytes, usado pelos dados derramados. Novidades na versão 8.2.	GROUP, SORT

explain.executionStats.allPlansExecution

Contém informações de execução parcial capturadas durante a fase de seleção do plano para os planos vencedores e rejeitados. O campo está presente somente se o explain executar no modo de detalhamentoallPlansExecution.

explain.executionStats.operationMetrics

Contém estatísticas de consumo de recursos, desde que não sejam zero. O campo está presente somente se explain executar no modo de detalhamento executionStats ou superior e se profileOperationResourceConsumptionMetrics estiver ativado.

Aviso

O MongoDB 8.2 remove profileOperationResourceConsumptionMetrics. Portanto, o código que depende de operationMetrics não funciona.

serverInfo

serverInfo: {
   host: <string>,
   port: <int>,
   version: <string>,
   gitVersion: <string>
}

queryPlanner: {
   ...
   winningPlan: {
      stage: <STAGE1>,
      shards: [
         {
            shardName: <string>,
            connectionString: <string>,
            serverInfo: {
               host: <string>,
               port: <int>,
               version: <string>,
               gitVersion: <string>
            },
            ...
         }
         ...
      ]
   }
 },
 serverInfo: {      // serverInfo for mongos
   host: <string>,
   port: <int>,
   version: <string>,
   gitVersion: <string>
 }
 ...