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

Mongoose 查詢API.prototype.orFail() 方法Mongoose API 的函數用於查詢對象。如果沒有文檔匹配給定的過濾條件，它允許我們拋出自定義錯誤。此方法接受一個參數來提供自定義錯誤消息。如果我們不提供任何參數並且沒有文檔符合過濾條件orFail()方法會拋出DocumentNotFoundError錯誤。讓我們了解一下orFail()使用示例的方法。

用法:

query.find(...).orFail( error_message );

參數：此方法接受單個參數，如下所述：

• error:它用於指定新的自定義錯誤對象。

返回值：該方法返回 Query 對象，我們可以在該對象上調用回調函數。

設置 Node.js Mongoose 模塊：

步驟 1：使用以下命令創建 Node.js 應用程序：

npm init

步驟 2：創建 NodeJS 應用程序後，使用以下命令安裝所需的模塊：

npm install mongoose

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

數據庫結構：數據庫結構如下所示，以下數據庫存在於 MongoDB 中。

示例 1：下麵的示例說明了 Mongoose Connection 的基本函數orFail()方法。在此示例中，我們正在獲取具有值的文檔“Student4”對於現場名字但集合中沒有找到該文檔。因此，最後我們得到DocumentNotFoundError錯誤。

文件名：app.js

// Require mongoose module 
const mongoose = require("mongoose"); 
  
// Set Up the Database connection 
const URI = "mongodb://localhost:27017/geeksforgeeks"; 
  
const connectionObject = mongoose.createConnection(URI, { 
    useNewUrlParser: true, 
    useUnifiedTopology: true, 
}); 
  
const studentSchema = new mongoose.Schema({ 
    name: { type: String, required: true }, 
    age: Number, 
    rollNumber: { type: Number, required: true } 
}); 
  
const StudentModel = connectionObject.model( 
    'Student', studentSchema 
); 
  
const query = StudentModel.find(); 
query.find({ name: "Student4" }).orFail() 
query.exec((error, result) => { 
    if (error) { 
        console.log("Error -", error); 
    } else { 
        console.log("Result -", result); 
    } 
})

運行程序的步驟：要運行應用程序，請從項目的根目錄執行以下命令：

node app.js

輸出：

Error - DocumentNotFoundError: No document found for query “{ name: ‘Student4’ }” on model “Student”
   at _orFailError (D:\GeeksforGeeks\Articles\Sakshi\Mongoose Query API.prototype.orFail()\node_modules\mongoose\lib\query.js:4870:11)
   at D:\GeeksforGeeks\Articles\Sakshi\Mongoose Query API.prototype.orFail()\node_modules\mongoose\lib\query.js:4813:17
   at D:\GeeksforGeeks\Articles\Sakshi\Mongoose Query API.prototype.orFail()\node_modules\mongoose\lib\query.js:4973:15
   at cb (D:\GeeksforGeeks\Articles\Sakshi\Mongoose Query API.prototype.orFail()\node_modules\mongoose\lib\query.js:2258:14)
   at D:\GeeksforGeeks\Articles\Sakshi\Mongoose Query API.prototype.orFail()\node_modules\mongodb\lib\utils.js:349:28
   at processTicksAndRejections (internal/process/task_queues.js:93:5) {
 result: undefined,
 numAffected: undefined,
 filter: { name: ‘Student4’ },
 query: { name: ‘Student4’ }
}

示例 2：下麵的示例說明了 Mongoose Connection 的基本函數orFail()方法。在此示例中，我們正在獲取具有值的文檔“101”對於現場卷號但集合中沒有找到該文檔。因此，最後我們發送自定義錯誤消息。

文件名：app.js

// Require mongoose module 
const mongoose = require("mongoose"); 
  
// Set Up the Database connection 
const URI = "mongodb://localhost:27017/geeksforgeeks"; 
  
const connectionObject = mongoose.createConnection(URI, { 
    useNewUrlParser: true, 
    useUnifiedTopology: true, 
}); 
  
  
const studentSchema = new mongoose.Schema({ 
    name: { type: String, required: true }, 
    age: Number, 
    rollNumber: { type: Number, required: true } 
}); 
  
const StudentModel = connectionObject.model('Student', studentSchema); 
  
const query = StudentModel.find(); 
query.find({ rollNumber: 101 }).orFail( 
    new Error("Roll number entered incorrected.") 
) 
query.then((res => { 
    console.log(res); 
})).catch((err) => { 
    console.log(err); 
})

運行程序的步驟：要運行應用程序，請從項目的根目錄執行以下命令：

node app.js

輸出：

Error: Roll number entered incorrected.
   at Object.<anonymous> (D:\GeeksforGeeks\Articles\Sakshi\Mongoose Query API.prototype.orFail()\app.js:22:38)
   at Module._compile (internal/modules/cjs/loader.js:1063:30)
   at Object.Module._extensions..js (internal/modules/cjs/loader.js:1092:10)
   at Module.load (internal/modules/cjs/loader.js:928:32)
   at Function.Module._load (internal/modules/cjs/loader.js:769:14)
   at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:72:12)
   at internal/main/run_main_module.js:17:47

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