Giter VIP home page Giter VIP logo

sequelize-query-handler's Introduction

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

sequelize-query-handler's People

Contributors

marcusholloway17 avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.