Explique los resultados

queryPlanner

La información de explain.queryPlanner detalla el plan seleccionado por el optimizador del query.

Estos ejemplos pueden combinar las estructuras de salida de los motores de ejecución clásicos y basados en ranuras de MongoDB. No están destinados a ser representativos. La salida puede diferir significativamente.

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

Contiene información sobre la selección del plan del query por parte del optimizador del query.

explain.queryPlanner.namespace

Una string que especifica el namespace con los nombres de la base de datos y la colección a los que accede la query. El namespace tiene el formato <database>.<collection>.

explain.queryPlanner.indexFilterSet

Un valor booleano que especifica si MongoDB aplicó un filtro de índice para la forma del query de la caché del plan.

explain.queryPlanner.querySettings

Si se establecen las configuraciones de query, querySettings contiene detalles sobre las configuraciones del query que se aplican a la forma del query.

Para añadir la configuración del query y explorar ejemplos, que incluyen la salida explain() con querySettings, se puede consultar setQuerySettings.

Nuevo en la versión 8.0.

explain.queryPlanner.planCacheShapeHash

A partir de MongoDB 8.0, el campo queryHash existente se duplica en un nuevo campo llamado planCacheShapeHash. Si estás utilizando una versión anterior de MongoDB, solo verás el campo queryHash. Las versiones futuras de MongoDB removerán el campo queryHash obsoleto y deberás utilizar el campo planCacheShapeHash en su lugar.

Un string hexadecimal que representa el hash de la forma del query de caché del plan y depende solo de las formas del query de la caché del plan. planCacheShapeHash puede ayudar a identificar queries lentos (incluido el filtro de query de las operaciones de escritura) con la misma forma del query de la caché del plan.

Nota

Como con cualquier función hash, dos formas diferentes de formas del query en caché del plan pueden dar lugar al mismo valor hash. Sin embargo, es poco probable que ocurran colisiones de hash entre diferentes formas del query de la caché del plan.

Para obtener más información sobre planCacheShapeHash y planCacheKey, consulte planCacheShapeHash y planCacheKey.

explain.queryPlanner.planCacheKey

Un hash de la clave para la entrada de caché del plan asociada con el query.

A diferencia del explain.queryPlanner.planCacheShapeHash, el explain.queryPlanner.planCacheKey es una función tanto de la forma del query en la caché del plan como de los índices actualmente disponibles para esa forma. Específicamente, si se añaden o eliminan índices que pueden soportar la forma del query, el valor planCacheKey puede cambiar, pero el valor planCacheShapeHash no cambiaría.

Para obtener más información sobre planCacheShapeHash y planCacheKey, consulte planCacheShapeHash y planCacheKey.

explain.queryPlanner.optimizationTimeMillis

Tiempo en milisegundos que el planificador del query dedicó a la optimización del query. Este resultado no incluye el tiempo dedicado a optimizar las queries internas $lookup.

explain.queryPlanner.optimizedPipeline

Un valor booleano que indica que toda la operación del pipeline de agregación se ha optimizado y, en su lugar, se ha completado mediante un árbol de etapas de ejecución del plan de queries.

Por ejemplo, la siguiente operación de agregación puede cumplirse mediante el árbol de ejecución del plan del query en lugar de usar el pipeline de agregación.

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

El campo solo está presente si el valor es true y solo se aplica para explicar en las operaciones del pipeline de agregación. Cuando true, dado que el pipeline fue optimizado, no aparece información sobre la etapa de agregación en la salida.

explain.queryPlanner.winningPlan

Un documento que detalla el plan seleccionado por el optimizador del query.

explain.queryPlanner.winningPlan.stage

Una string que indica el nombre de la etapa.

Cada etapa consta de información específica de la etapa. Por ejemplo, una etapa IXSCAN incluye los límites del índice junto con otros datos específicos de la exploración del índice. Si una etapa tiene una etapa secundaria o varias etapas secundarias, la etapa tendrá un inputStage o inputStages.

Este campo aparece si la operación utilizó el motor de ejecución de query clásico.

explain.queryPlanner.winningPlan.type

Si stage se establece en "EOF", type es una string que indica el motivo de la etapa EOF:

• "nonExistentNamespace": indica que el namespace del query no existe.

• "predicateEvalsToFalse": indica que la simplificación de la expresión determina que el query no coincidirá con ningún documento.

explain.queryPlanner.winningPlan.inputStage

Un documento que describe la etapa secundaria, que proporciona los documentos o claves de índice a su etapa principal. El campo está presente si la etapa principal tiene solo una secundaria.

explain.queryPlanner.winningPlan.inputStages

Un arreglo de documentos que describen las etapas secundarias. Las etapas secundarias proporcionan los documentos o las claves de índice a la etapa principal. El campo está presente si la etapa principal tiene múltiples nodos secundarios. Por ejemplo, las etapas para expresiones $or podrían consumir entradas de múltiples fuentes.

Este campo aparece si la operación utilizó el motor de ejecución de query clásico.

explain.queryPlanner.winningPlan.isCached

Un valor booleano que indica si el winningPlan está en la caché del plan.

Este campo es true para un máximo de un plan entre el plan ganador y los planes rechazados. Si el query no tiene un plan en caché, el campo es false para el plan ganador y los planes rechazados.

explain.queryPlanner.winningPlan.queryPlan

Un documento que detalla el plan seleccionado por el optimizador del query. MongoDB presenta el plan como un árbol de etapas.

Este documento aparece si el query utilizó el motor de ejecución de queries basado en slots.

Nuevo en la versión 5.1.

explain.queryPlanner.winningPlan.queryPlan.stage

Una string que indica el nombre de la etapa.

Cada etapa consta de información específica para esa etapa. Por ejemplo, una etapa IXSCAN incluye los límites del índice junto con otros datos específicos de la exploración del índice.

explain.queryPlanner.winningPlan.queryPlan.type

Si stage se establece en "EOF", type es una string que indica el motivo de la etapa EOF:

• "nonExistentNamespace": indica que el namespace del query no existe.

• "predicateEvalsToFalse": indica que la simplificación de la expresión determina que el query no coincidirá con ningún documento.

explain.queryPlanner.winningPlan.queryPlan.planNodeId

Campo entero único que identifica cada etapa en el plan de ejecución. El campo se incluye en todas las etapas a lo largo de los resultados del explain.

Nuevo en la versión 5.1.

explain.queryPlanner.winningPlan.queryPlan.inputStage

Se puede consultar explain.queryPlanner.winningPlan.inputStage.

explain.queryPlanner.winningPlan.slotBasedPlan

Documento con información sobre el árbol del plan de ejecución del query basado en ranuras y sus etapas. Para uso interno de MongoDB.

Nuevo en la versión 5.1.

explain.queryPlanner.winningPlan.slotBasedPlan.stages

String que incluye información sobre cada etapa en el plan de ejecución del query basado en ranuras, incluyendo el orden de ejecución, las operaciones y las asignaciones de ranuras. Para uso interno de MongoDB.

A partir de MongoDB 8.0, si un query utiliza procesamiento de bloques, block_to_row y ts_bucket_to_cellblock aparecen en la salida stages.

Cambiado en la versión 8.0.

explain.queryPlanner.rejectedPlans

Arreglo de planes candidatos considerados y rechazados por el optimizador del query. El arreglo puede estar vacío si no hay otros planes candidatos.

Los planes rechazados tienen los mismos campos que explain.queryPlanner.winningPlan.

A partir de MongoDB 8.0, los planes del query rechazados solo contienen la parte find del query. En versiones anteriores, los planes rechazados podían incluir etapas de agregación como $group. El planificador del query no utiliza esas etapas de agregación para elegir el plan ganador, por lo que el campo rejectedPlans solo incluye la parte del query que se utilizó para elegir el plan ganador.

executionStats

La información devuelta explain.executionStats detalla la ejecución del plan ganador. Para incluir executionStats en los resultados, se debe ejecutar la explicación en:

• executionStats o

• Modo de verbosidad de allPlansExecution. Se puede utilizar el modo allPlansExecution para incluir los datos de ejecución parcial capturados durante la selección del plan.

Estos ejemplos pueden combinar las estructuras de salida de los motores de ejecución clásicos y basados en ranuras de MongoDB. No están destinados a ser representativos. La salida puede 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

Contiene estadísticas que describen la ejecución del query completada para el plan ganador. Para las operaciones de guardado, la ejecución del query completada se refiere a las modificaciones que se realizarían, pero no aplica las modificaciones a la base de datos.

explain.executionStats.nReturned

Número de documentos devueltos por el plan del query ganador. nReturned corresponde al campo n devuelto por cursor.explain() en versiones anteriores de MongoDB.

explain.executionStats.executionTimeMillis

Tiempo total en milisegundos requerido para la selección del plan del query y la ejecución del query. Incluye el tiempo que se tarda en ejecutar la fase de prueba del proceso de selección del plan, pero no incluye el tiempo de red necesario para transmitir los datos de vuelta al cliente.

El tiempo reportado por explain.executionStats.executionTimeMillis no es necesariamente representativo del tiempo real del query. Durante las operaciones en estado estacionario (cuando el plan del query está almacenado en caché), o al usar cursor.hint() con cursor.explain(), MongoDB evita el proceso de selección del plan, lo que resulta en un tiempo real más rápido, llevando a un valor menor de explain.executionStats.executionTimeMillis .

explain.executionStats.totalKeysExamined

Número de entradas de índice escaneadas. explain.executionStats.totalKeysExamined corresponde al campo nscanned devuelto por cursor.explain() en versiones anteriores de MongoDB.

explain.executionStats.totalDocsExamined

Número de documentos examinados durante la ejecución del query. Las etapas comunes de ejecución del query que examinan documentos son COLLSCAN y FETCH.

Nota

explain.executionStats.totalDocsExamined se refiere al número total de documentos examinados y no al número de documentos devueltos. Por ejemplo, una etapa puede examinar un documento para aplicar un filtro. Si el documento es filtrado, entonces ha sido examinado pero no será devuelto como parte del conjunto de resultados del query.

Si un documento se examina varias veces durante la ejecución del query, explain.executionStats.totalDocsExamined cuenta cada examen. Es decir, explain.executionStats.totalDocsExamined no es un conteo del número total de documentos únicos examinados.

explain.executionStats.executionStages

Detalla la ejecución completa del plan ganador como un árbol de etapas; es decir, una etapa puede tener un inputStage o múltiples inputStages.

A partir de MongoDB 5.1, una etapa puede tener las siguientes etapas de entrada:

• thenStage

• elseStage

• innerStage

• outerStage

Cada etapa consta de información de ejecución específica para esa etapa.

explain.executionStats.executionStages.executionTimeMillisEstimate

El tiempo estimado en milisegundos para la ejecución de la query.

explain.executionStats.executionStages.opens

A partir de MongoDB 5.1, el número de veces que se abrió una etapa durante la ejecución del query.

explain.executionStats.executionStages.closes

A partir de MongoDB 5.1, el número de veces que se cerró una etapa durante la ejecución del query.

explain.executionStats.executionStages.works

Especifica el número de "unidades de trabajo" realizadas por la etapa de ejecución del query. La ejecución del query divide su trabajo en pequeñas unidades. Una "unidad de trabajo" puede consistir en examinar una única clave de índice, obtener un único documento de la colección, aplicar una proyección a un único documento o realizar una parte de la contabilidad interna.

Este campo aparece si la operación utilizó el motor de ejecución de query clásico.

explain.executionStats.executionStages.saveState

El número de veces que la etapa de query suspendió el Procesamiento y guardó su estado de ejecución actual, por ejemplo, en preparación para ceder sus bloqueos.

explain.executionStats.executionStages.restoreState

El número de veces que la etapa del query realizó la restauración de un estado de ejecución guardado, por ejemplo, recuperando los bloqueos que había cedido anteriormente.

explain.executionStats.executionStages.isEOF

Especifica si la etapa de ejecución ha alcanzado el final del flujo de datos:

• Si true o 1, la etapa de ejecución ha alcanzado el final del flujo.

• Si false o 0, la etapa aún puede tener resultados para devolver. Por ejemplo, considere un query con un límite cuyas etapas de ejecución consisten en una etapa LIMIT con una etapa de entrada de IXSCAN para el query. Si el query devuelve más del límite especificado, la etapa LIMIT informará isEOF: 1, pero su etapa subyacente IXSCAN informará isEOF: 0.

explain.executionStats.executionStages.opType

Para las operaciones en colecciones de series de tiempo, el tipo de operación.

explain.executionStats.executionStages.bucketFilter

Para operaciones en colecciones de series de tiempo, el filtro se utiliza para reducir el número de grupos de queries en el catálogo de grupos.

explain.executionStats.executionStages.residualFilter

Para las operaciones en colecciones de series de tiempo, el filtro utilizado para la query del catálogo de grupos.

explain.executionStats.executionStages.nBucketsUnpacked

Para las operaciones en colecciones de series de tiempo, el número de grupos desempaquetados para resolver la operación.

explain.executionStats.executionStages.nMeasurementsDeleted

Para operaciones en colecciones de series de tiempo, el número de documentos borrados.

explain.executionStats.executionStages.nMeasurementsInserted

Para las operaciones en colecciones de series de tiempo, el número de documentos insertados.

explain.executionStats.executionStages.nMeasurementsMatched

Para operaciones en colecciones de series de tiempo, el número de documentos coincidentes.

explain.executionStats.executionStages.nMeasurementsModified

Para las operaciones en colecciones de series de tiempo, el número de documentos modificados.

explain.executionStats.executionStages.nMeasurementsUpserted

Para operaciones en colecciones de series de tiempo, el número de documentos actualizados o insertados.

explain.executionStats.executionStages.inputStage

Cada inputStage puede tener diferentes campos según el valor de inputStage.stage. La siguiente tabla describe los campos posibles y las etapas en las que pueden aparecer.

Cada inputStage puede tener otro inputStage como un campo. Consultar Explicar la estructura de salida.

Campo	Descripción	Etapas aplicables
docsExamined	Especifica el número de documentos escaneados durante la etapa de ejecución de la query.	COLLSCAN, FETCH
keysExamined	Para las etapas de ejecución del query que escanean un índice, keysExamined es el número total de claves dentro y fuera de los límites que se examinan durante el proceso de escaneo del índice. Si el escaneo de índice consiste en un único rango contiguo de claves, solo es necesario examinar las claves dentro de los límites. Si los límites del índice consisten en varios rangos de claves, el proceso de ejecución del escaneo del índice puede examinar claves fuera de los límites para saltar desde el final de un rango al inicio del siguiente.	IXSCAN
numReads	El número de documentos escaneados o claves de índice examinadas durante la etapa de ejecución del query. Nuevo en la versión 5.1.	COLLSCAN, IXSCAN
seeks	El número de veces que tuvimos que mover el cursor del índice a una nueva posición para completar el escaneo del índice.	IXSCAN
usedDisk	Si la etapa guardó en el disco. Novedades en la versión 5.3.	GROUP
spills	El número de veces que la etapa se volcó al disco. Nuevo en la versión 8.2.	GROUP, SORT
spilledBytes	La cantidad total de datos escrita en el disco en bytes. Nuevo en la versión 8.2.	GROUP, SORT
spilledRecords	El número total de registros individuales volcados en el disco. Nuevo en la versión 8.2.	GROUP, SORT
spilledDataStorageSize	El espacio total en el disco, en bytes, utilizado por los datos volcados. Nuevo en la versión 8.2.	GROUP, SORT

explain.executionStats.allPlansExecution

Contiene información parcial de ejecución capturada durante la fase de selección de planes para los planes ganadores y rechazados. El campo solo está presente si explain se ejecuta en la moda de nivel de verbosidad allPlansExecution.

explain.executionStats.operationMetrics

Contiene estadísticas de consumo de recursos, siempre y cuando no sean cero. El campo está presente solo si explain se ejecuta en el nivel de verbosidad executionStats o superior y si profileOperationResourceConsumptionMetrics está habilitado.

Advertencia

MongoDB 8.2 remueve profileOperationResourceConsumptionMetrics. Por lo tanto, el código que depende de operationMetrics no 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>
 }
 ...