Mongoose Query.prototype.explain()用法及代碼示例

Query.prototype.explain() 函數用於設置解釋選項，從而使此查詢返回詳細的執行統計信息而不是實際查詢結果。

用法:

Query.prototype.explain()

參數：該函數有一個可選的詳細參數。返回值：該函數返回查詢對象。

安裝 Mongoose ：

npm install mongoose

安裝 mongoose 模塊後，您可以使用命令在命令提示符下檢查您的 mongoose 版本。

npm mongoose --version

現在，創建一個文件夾並添加一個文件，例如 index.js，如下所示。

數據庫：這裏使用的示例數據庫如下所示：

項目結構：項目結構如下所示。

範例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)
});

使用以下命令運行index.js文件：

node index.js

輸出：

[
  {
    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
  }
]

範例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")
});

使用以下命令運行index.js文件：

node index.js

輸出：

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

參考：
https://mongoosejs.com/docs/api/query.html#query_Query-explain