Mongoose Document Model.prototype.model() API
Last Updated :
28 Apr, 2025
The Mongoose Document API Model.prototype.model() method of the Mongoose API is used on the Document model. It allows to get the model instance. We can call this method on any model object and by providing another model name to the method parameter we will get the new instance of that model. Let us understand the model() method using an example.
Syntax:
document.model( model );
Parameters: This method accepts a single parameter as discussed below:
- model: It is used to specify the name of the model.
Return Value: This method return the new instance of model, we send as a parameter to the method.
Setting up Node.js application:
Step 1: Create a Node.js application using the following command:
npm init
Step 2: After creating the NodeJS application, Install the required module using the following command:
npm install mongoose
Project Structure: The project structure will look like this:
Database Structure: The database structure will look like this, the following documents are present in the collection.
Example 1: In this example, we are illustrating the functionality of model() method. We have defined a DUMMYMODEL, using the object of dummymodel we are creating new instance of Customer model and at the end fetching one record from the database.
Filename: app.js
JavaScript
// 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 Customer = connectionObject.model(
"Customer",
new mongoose.Schema({
name: String,
address: String,
orderNumber: Number,
})
);
const DUMMYMODEL = connectionObject.model(
"DUMMYMODEL",
new mongoose.Schema({
name: String,
})
);
const doc = new DUMMYMODEL();
doc.$model("Customer").find({ name: "Chintu" }).then(res => {
console.log(res);
}).catch(err => {
console.log(err);
});
Step to run the program: To run the application execute the below command from the root directory of the project:
node app.js
Output:
[
{
_id: new ObjectId("639ede899fdf57759087a655"),
name: 'Chintu',
address: 'IND',
orderNumber: 9,
__v: 0
}
]
Example 2: In this example, we are illustrating the functionality of model() method. At the end, we are comparing the newly instantiated object with original Customer model.
Filename: app.js
JavaScript
// 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 Customer = connectionObject.model(
"Customer",
new mongoose.Schema({
name: String,
address: String,
orderNumber: Number,
})
);
const DUMMYMODEL = connectionObject.model(
"DUMMYMODEL",
new mongoose.Schema({
name: String,
})
);
const doc = new DUMMYMODEL();
const newInstance = doc.$model("Customer")
console.log(newInstance.modelName === Customer.modelName);
Step to run the program: To run the application execute the below command from the root directory of the project:
node app.js
Output:
true
Reference: https://mongoosejs.com/docs/api/model.html#model_Model-model
Similar Reads
Mongoose Document Model() API The Mongoose Document APIModel() method of the Mongoose API is used on the Document model. It allows to create a MongoDB class. Using this method we can create model that can interact with MongoDB for all operations. Let us understand the APIModel() method using an example. Syntax: mongoose.model( d
3 min read
Mongoose Document Model.bulkWrite() API When working with MongoDB and Mongoose in Node.js, handling multiple database operations one by one can be slow and inefficient. Thatâs where the Model.bulkWrite() method comes in handy. This powerful API lets you execute multiple write operations (insert, update, delete, replace) in a single comman
4 min read
Mongoose Document Model.count() API The Model.count() method of the Mongoose API is used to count the number of documents present in the collection based on the given filter condition. It returns the query object and count of documents present in the collection.Syntax:Model.count()Parameters: The Model.count() method accepts two param
2 min read
Mongoose Document Model.countDocuments() API The Model.countDocuments() method of the Mongoose API is used to count the number of document present in a collection. The countDocument() method count the number of documents in a collection based on matching filter. Model.countDocuments() method accepts four parameters: filter:Â It is an object to
3 min read
Mongoose Model.create() API In Node.js applications, Mongoose provides an effective way to interact with MongoDB, allowing developers to define models and schemas to store and retrieve data. One of the essential methods provided by Mongoose is Model.create(), which is used to create one or more documents in a MongoDB collectio
5 min read
Mongoose Document Model.deleteMany() API The Model.deleteMany() method of the Mongoose API is used to delete more than one document in the collection at a time in one go. We can provide an object which contains a condition to the deleteMany() and can be executed on the model object. It will delete all the documents from the collection that
3 min read
Mongoose Document Model.deleteOne() API The Model.deleteOne() method of the Mongoose API is used to delete a document from the collection. We can provide an object of the field to the deleteOne() and can be executed on the model object. It will delete the first document that matches the condition from the collection. Syntax: Model.deleteO
3 min read
Mongoose Document Model.estimatedDocumentCount() API The Model.estimatedDocumentCount() method of the Mongoose API is used to count the number of documents in the MongoDB collection. It is useful for large collections. It is faster than other methods provided by mongoose because it collects metadata instead of scanning the entire collection.Syntax:Mod
2 min read
Mongoose Document Model.events API The Model.events property of Mongoose API is used to return the model's events instance. The instance of the event contains the fields like _events, _eventsCount, and _maxListeners. Syntax: Model_Name.events Return Value: The Model.events property returns the events instance of the model. Setting up
3 min read
Understanding Mongoose Model.exists() API for Efficient Document Search Mongoose, a well-known Object Data Modeling (ODM) library for MongoDB and Node.js. It gives a convenient method of dealing with MongoDB data. One of its critical APIs is the Model.exists() API that facilitates the efficient identification of whether a document exists in a collection by certain condi
4 min read