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