simple-sql-get

Simple SQL Get

Get data from a SQL databases (select statements only).

A very thin wrapper for the excellent sequelize library.

Installation

$ npm install --save simple-sql-get

Usage

import SimpleSQLGet from 'simple-sql-get';
import settings from './settings';

// create a connection to your SQL database
const db = new SimpleSQLGet(settings.db);


// simple query
const sql = `
  select id_num as idNum
    , first_name as firstName
    , last_name as lastName
  from users
`;

db.get(sql)
  .then((data) => {
    console.log(data);
  })
  .catch(console.error);

/*
  [
    {
      idNum: 1,
      firstName: 'Cosmo',
      lastName: 'Kramer'
    },
    {
      idNum: 2,
      firstName: 'Elaine',
      lastName: 'Benes'
    }
  ]
*/


// query with named parameters
const emailListSql = `
  select first_name as firstName
    , last_name as lastName
    , email
  from users
  where last_name like :lastName
`;

db.get(emailListSql, {lastName: 'Benes'})
  .then((data) => {
    console.log(data);
  })
  .catch(console.error);

/*
  [{
    firstName: 'Elaine',
    lastName: 'Benes',
    email: '[e-mail]'
  }]
*/

Settings

See Sequelize docs for more information.

// settings.js
{
  db: {
    {
      dbName: 'MyDB',
      username: 'root',
      password: 'root',
      config: {
        host: 'localhost',
        dialect: 'mssql',
        pool: {
          max: 5,
          min: 0,
          idle: 10000,
        },
        // global defaults for define method
        define: {
          timestamps: false,
          freezeTableName: true,
        },
        // turn off logging sql queries to console.log
        // remove this line if you are interested in this
        logging: null,
      },
    }
  }
}