Sequelize Datatables

Server-side datatables with Sequelize.

Support

• Node.js v7.6 & later
• Sequelize v5

Instalation

npm install sequelize-datatables

API

datatable(
  model: SequelizeModel required,
  config: Object required,
  params: Object,
  options: Object
) -> Promise<Object>

This function takes three arguments to produce output for datatables.

• model - required - is the sequelize model.
• config - required - is config sent by jQuery datatables to our server.
• params - options for sequelize query.
• options - library specific options. See below

Options

• caseInsensitive: Boolean - A flag for postgresql dialec. If this is set to true, ILIKE will be used instead of LIKE Default to false.
• replaceRegexp - A workaround in case dialect does not support native regex, but you need to search for list of exact matches, passed as regex expression, ^((?!debug|info.*)$. See working example: http://live.datatables.net/kopafape/1/edit

Example Usage

const datatable = require(`sequelize-datatable`);
const model = require(`./path/to/sequelize-model`); // Sequelize model

// assuming you are using express

route.get(`/datasource`, (req, res) => {
  datatable(model, req.query, {})
    .then((result) => {
      // result is response for datatables
      res.json(result);
    });
});

Todo

• [X] Test with postgresql database
• [X] Test with mysql database
• [X] Test with sqlite database
• [X] Support global search
• [X] Support individual column search
• [X] Support nested relation search & ordering
• [ ] Test with another database server (mssql)
• [X] More tests!

Testing

You must have docker installed on your system if you want to test this module on your machine.

git clone https://github.com/alwint3r/sequelize-datatable-node.git
cd sequelize-datatable-node
npm install

# It's recommended to test this library using dockerized database engine
DIALECT=mysql npm run test:setup

# or

DIALECT=postgres npm run test:setup

# on another terminal, enter command
DIALECT=postgres npm test

# or

DIALECT=mysql npm test