Mongoose Query prototype.skip() API

Mongoose is an Object Data Modeling (ODM) library for MongoDB. It defines a strongly-typed schema, with default values and schema validations which are later mapped to a MongoDB document. 

The Mongoose Query API skip method is used to determine how many documents to skip after applying the Mongoose Query. Let’s understand more about this with some examples.

Syntax:

Query.prototype.skip()

Parameters: It takes one parameter.

• val: It is a number that determines how many documents to skip

Return type: It returns the Query object.

Creating node application And Installing Mongoose:

Step 1: Create a node application using the following command:

mkdir folder_name
cd folder_name
npm init -y
touch main.js

Step 2: After creating the ReactJS application, Install the required module using the following command

npm install mongoose

Project Structure: It will look like the following.

GUI Representation of the  Database using MongoDB Compass: Currently, the collection has no data.

Example 1: In this example, we will use the Query API skip() method to skip one document after the query is applied

Filename: main.js

Javascript

const mongoose = require('mongoose')

// Database connection
mongoose.connect(
'mongodb://localhost:27017/query-helpers',
{
    dbName: 'event_db',
    useNewUrlParser: true,
    useUnifiedTopology: true
}, err => err ? console.log(err)
 : console.log('Connected to database'));

const personSchema = new mongoose.Schema({
    name: {
        type: String,
    },
    age: {
        type: Number,
    }
});

const personsArray = [
    {
        name: 'Luffy',
        age: 22
    },
    {
        name: 'Nami',
        age: 30
    },
    {
        name: 'Zoro',
        age: 15
    }
]

const Person = mongoose.model('Person', personSchema);

(async () => {
    await Person.insertMany(personsArray);

    const query = Person.find()

    const persons = await query.skip(1)

    console.log(persons);
})()

Step to Run Application: Run the application using the following command from the root directory of the project:

node main.js

Output: We see that the value remains unchanged in the result.

GUI Representation of the Database using MongoDB Compass:

Example 2: In this example, we will use the Query API skip() method to skip one document after the query is applied, and then limit the number of documents to one.

Filename: main.js

Javascript

const mongoose = require('mongoose')

// Database connection
mongoose.connect('mongodb://localhost:27017/query-helpers', {
    dbName: 'event_db',
    useNewUrlParser: true,
    useUnifiedTopology: true
}, err => err ? console.log(err)
 : console.log('Connected to database'));

const personSchema = new mongoose.Schema({
    name: {
        type: String,
    },
    age: {
        type: Number,
    }
});

const personsArray = [
    {
        name: 'Luffy',
        age: 22
    },
    {
        name: 'Nami',
        age: 30
    },
    {
        name: 'Zoro',
        age: 15
    }
]

const Person = mongoose.model('Person', personSchema);

(async () => {
    await Person.insertMany(personsArray);

    const query = Person.find()

    const persons = await query.skip(1).limit(1)

    console.log(persons);
})()

Step to Run Application: Run the application using the following command from the root directory of the project:

node main.js

Output: We see that the value remains unchanged in the result.

GUI Representation of the  Database using MongoDB Compass:

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