Mongoose Query.prototype.maxTimeMS() API

The Mongoose Query API.prototype.maxTimeMS() method of the Mongoose API is used on the Query objects. It allows us to set the maximum time limit for any operation to be performed on the model object. Using this method we can tell MongoDB to abort any operation if it takes more than specified using this method. Let us understand maxTimeMS() method using an example.

Syntax:

query.maxTimeMS( <ms> );

Parameters: This method accepts a single parameter as discussed below:

• ms: It is used to specify the time in milliseconds.

Return Value: This method returns the query object on which we can call the callback function.

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 maxTimeMS() method. In the end, we set the max time value as 1000. Now, within 1 sec this operation needs to be completed else this method will throw an error.

Filename: app.js

Javascript

// Require mongoose module
const mongoose = require("mongoose");

// Set Up the Database connection
const URI = "mongodb://localhost:27017/geeksforgeeks";

let connectionObject = mongoose.createConnection(URI, {
    useNewUrlParser: true,
    useUnifiedTopology: true,
});

let Customer = connectionObject.model(
    "Customer",
    new mongoose.Schema({
        name: String,
        address: String,
        orderNumber: Number,
    })
);

let query = Customer.find();
query.maxTimeMS(1000);
query.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: 'Indore',
        orderNumber: 15,
        __v: 0
    },
    {
        _id: new ObjectId("639ede899fdf57759087a653"),
        name: 'Aditya',
        address: 'Mumbai',
        orderNumber: 20,
        __v: 0
    },
    {
        _id: new ObjectId("63bcfcc2876922405349b69d"),
        name: 'Bhavesh',
        address: 'Mhow',
        orderNumber: 65,
        __v: 0
    }
]

Example 2: In this example, we are illustrating the functionality of the maxTimeMS() method. 

Filename: app.js

Javascript

// Require mongoose module
const mongoose = require("mongoose");

// Set Up the Database connection
const URI = "mongodb://localhost:27017/geeksforgeeks";

let connectionObject = mongoose.createConnection(URI, {
    useNewUrlParser: true,
    useUnifiedTopology: true,
});

let Customer = connectionObject.model(
    "Customer",
    new mongoose.Schema({
        name: String,
        address: String,
        orderNumber: Number,
    })
);

let query = Customer.find({ name: "Chintu" });
query.update({}, { orderNumber: 0 })
query.maxTimeMS(100);
query.exec((error, result) => {
    if (error) {
        console.log("Error -", error);
    } else {
        console.log("Result -", result);
    }
});

Step to run the program: To run the application execute the below command from the root directory of the project:

node app.js

Output:

Result - {
    acknowledged: true,
    modifiedCount: 1,
    upsertedId: null,
    upsertedCount: 0,
    matchedCount: 1
}

Reference: https://mongoosejs.com/docs/api/query.html#query_Query-maxTimeMS