explain (comando de base de datos)

Definición

explain

El comandoexplainproporciona información sobre la ejecución de los siguientes comandos: aggregate, count, distinct, find, findAndModify, delete, mapReduceyupdate.

Tip

mongoshEn, este comando también se puede ejecutar a través de los métodos auxiliares db.collection.explain() cursor.explain() y.

Los métodos auxiliares son convenientes para mongosh los usuarios de, pero es posible que no devuelvan el mismo nivel de información que los comandos de la base de datos. En los casos en que no se necesite la conveniencia o se requieran los campos de retorno adicionales, utilice el comando de la base de datos.

Nota

El uso de explain ignora todas las entradas existentes en la caché del plan e impide que el planificador de query de MongoDB cree una nueva entrada en la caché del plan.

Compatibilidad

Este comando está disponible en implementaciones alojadas en los siguientes entornos:

• MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

• MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB

• MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Acceso requerido

Para usar explain, se debe tener permiso para ejecutar el comando subyacente.

Sintaxis

El comando tiene la siguiente sintaxis:

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

Campos de comandos

El comando toma los siguientes campos:

Comportamiento

Salida

explain Las operaciones pueden devolver información sobre:

• explainVersion, la versión del formato de salida (por ejemplo, "1").

• command, que detalla el comando que se está explicando.

• queryShapeHash, comenzando en MongoDB 8.0, que es una string hexadecimal con el hash de una forma del query. Para obtener detalles, consulta Formas del query, Hash de Forma del query y explain.queryShapeHash.

• queryPlanner, que detalla el plan seleccionado por el optimizador del query y enumera los planes rechazados.

• executionStats, que detalla la ejecución del plan ganador y de los planes rechazados.

• serverInfo, que proporciona información sobre la instancia de MongoDB.

• serverParameters, que detalla los parámetros internos.

El nivel de verbosidad (es decir, queryPlanner, executionStats, allPlansExecution) determina si los resultados incluyen executionStats y si executionStats incluye datos capturados durante la selección del plan.

La salida de la explicación está limitada por la profundidad máxima de anidación para documentos BSON, que es de 100 niveles de anidación. Explicar que la salida que excede el límite se trunca.

Para obtener más detalles sobre la salida, consultar Explicación de resultados.

Ejemplos

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 } }
           }
        ]
     }
   }
)