¿Cómo funciona Query.prototype.explain() en Mongoose?

La función Query.prototype.explain() se usa para establecer la opción de explicación, lo que hace que esta consulta devuelva estadísticas de ejecución detalladas en lugar del resultado real de la consulta.

Sintaxis:

Query.prototype.explain()

Parámetros: esta función tiene un parámetro detallado opcional .
Valor de retorno: esta función devuelve el objeto de consulta.
 

Instalación de mangosta: 

npm install mongoose

Después de instalar el módulo mongoose, puede verificar su versión mongoose en el símbolo del sistema usando el comando. 

npm mongoose --version

Ahora, cree una carpeta y agregue un archivo, por ejemplo, index.js como se muestra a continuación.

Base de datos: La base de datos de muestra utilizada aquí se muestra a continuación: 
 

Estructura del proyecto: La estructura del proyecto se verá así.

Ejemplo 1:

const mongoose = require('mongoose');
  
// Database connection
mongoose.connect('mongodb://127.0.0.1:27017/geeksforgeeks', {
    useNewUrlParser: true,
    useCreateIndex: true,
    useUnifiedTopology: true
});
  
// User model
const User = mongoose.model('User', { 
    name: { type: String },
    age: { type: Number }
});
  
var query = User.find({age: 5}).explain('queryPlanner')
query.exec(function(err, res){
    if(err) console.log(err.message)
    else console.log(res)
});

Ejecute el archivo index.js usando el siguiente comando:

node index.js

Salida : 

[
  {
    queryPlanner: {
      plannerVersion: 1,
      namespace: 'geeksforgeeks.users',
      indexFilterSet: false,
      parsedQuery: [Object],
      queryHash: '3838C5A3',
      planCacheKey: '38305F3',
      winningPlan: [Object],
      rejectedPlans: []
    },
    executionStats: {
      executionSuccess: true,
      nReturned: 1,
      executionTimeMillis: 0,
      totalKeysExamined: 0,
      totalDocsExamined: 4,
      executionStages: [Object],
      allPlansExecution: []
    },
    serverInfo: {
      host: 'Lenovo530S',
      port: 27017,
      version: '4.2.0',
      gitVersion: 'a4b751dcf51dd249c58812b390cfd1c0129c30'
    },
    ok: 1
  }
]

Ejemplo 2:

const express = require('express');
const mongoose = require('mongoose');
const app = express()
  
// Database connection
mongoose.connect('mongodb://127.0.0.1:27017/geeksforgeeks', {
    useNewUrlParser: true,
    useCreateIndex: true,
    useUnifiedTopology: true
});
  
// User model
const User = mongoose.model('User', { 
    name: { type: String },
    age: { type: Number }
});
  
var query = User.find({age: 5}).explain('allPlansExecution')
query.exec(function(err, res){
    if(err) console.log(err.message)
    else console.log(res)
});
  
app.listen(3000, function(error ) {
    if(error) console.log(error)
    console.log("Server listening on PORT 3000")
});

Ejecute el archivo index.js usando el siguiente comando:

node index.js

Salida : 

Server listening on PORT 3000
[
  {
    queryPlanner: {
      plannerVersion: 1,
      namespace: 'geeksforgeeks.users',
      indexFilterSet: false,
      parsedQuery: [Object],
      queryHash: '3838SF3',
      planCacheKey: '3238C5F3',
      winningPlan: [Object],
      rejectedPlans: []
    },
    executionStats: {
      executionSuccess: true,
      nReturned: 1,
      executionTimeMillis: 0,
      totalKeysExamined: 0,
      totalDocsExamined: 4,
      executionStages: [Object],
      allPlansExecution: []
    },
    serverInfo: {
      host: 'Lenovo530S',
      port: 27017,
      version: '4.2.0',
      gitVersion: 'a4b751dcf51sd249c5865812b390cfd1c0129c30'
    },
    ok: 1
  }
]

Referencia:  
https://mongoosejs.com/docs/api/query.html#query_Query-explain