sequelize-query-handler

SEQUELIZE QUERY HANDLER

Dynamically handling queries with sequelize can be a pain. This package provides you with a function to query your database as you wish

API Reference

Method	Type	Return
handleQuery	function	object

Usage/Examples

In your request body, make a GET request like this:

{
    "_query": {
        "attributes": [
            "id",
            "email",
            "username",
            "birthdate",
            "created_at"
        ],
        "order": [
            [
                "created_at",
                "desc"
            ]
        ],
        "include": ["Post"],
    },
    "page": 2,
    "pageSize": 10
}

• Use page and pageSize together to paginate.

• Use include keyword to include associated models.

• Use where keyword to make where clause query.

• Use order keyword to order items

for more, refer to Sequelize Model Querying - Basics

Using findAll method:

// imports
const models = require("./models");
const { handleQuery } = require("sequelize-query-handler");

const getAll = async (req, res) => {
  try {
    await models.User.findAll(handleQuery(req)).then((users) =>
      res.send(users)
    );
  } catch (err) {
    console.log(err);
  }
};

Using findOne method:

// imports
const models = require("./models");
const { handleQuery } = require("sequelize-query-handler");

const getOne = async (req, res) => {
  try {
    await models.User.findOne(handleQuery(req)).then((user) => res.send(user));
  } catch (err) {
    console.log(err);
  }
};

Using findByPk method:

// imports
const models = require("./models");
const { handleQuery } = require("sequelize-query-handler");

const getById = async (req, res) => {
  try {
    await models.User.findByPk(1, handleQuery(req)).then((user) =>
      res.send(user)
    );
  } catch (err) {
    console.log(err);
  }
};

Using with own query method:

// imports
const models = require("./models");
const { handleQuery } = require("sequelize-query-handler");
const { Op } = require("sequelize");

const getById = async (req, res) => {
  try {
    const filters = handleQuery(req);

    // adding where clause to fetch user with age >= 18
    filters.where = {
      ...filters.where,
      age: {
        [Op.gte]: 18,
      },
    };

    await models.User.findAll(filters).then((user) => res.send(user));
  } catch (err) {
    console.log(err);
  }
};

Author

• @marcusholloway17