# simple-sql-get

> Simple SQL Query Tool for Select statements. A very thin wrapper over Sequelize.

Latest version **0.2.5** (published 2017-04-07) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install simple-sql-get
pnpm add simple-sql-get
yarn add simple-sql-get
bun add simple-sql-get
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.2.5 |
| Published | 2017-04-07 |
| First published | 2015-12-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+8 in 1 direct dependencies) |
| Install scripts | no |
| Author | James Johnson |
| Maintainers | geekydatamonkey |

## Links

- npm: https://www.npmjs.com/package/simple-sql-get
- Repository: https://github.com/mcadonline/simple-sql-get
- Homepage: https://github.com/mcadonline/simple-sql-get#readme
- Issues: https://github.com/mcadonline/simple-sql-get/issues
- npm.io page: https://npm.io/package/simple-sql-get

## Dependencies (2)

- [tedious](https://npm.io/package/tedious.md) ^2.0.0
- [sequelize](https://npm.io/package/sequelize.md) ^3.23.4

## Recent versions

- 0.2.5 (latest) — 2017-04-07
- 0.2.4 — 2016-07-17
- 0.2.3 — 2015-12-20
- 0.2.2 — 2015-12-09
- 0.2.1 — 2015-12-09
- 0.2.0 — 2015-12-09
- 0.1.1 — 2015-12-09
- 0.1.0 — 2015-12-09

## README

# Simple SQL Get

[![Travis Build](https://img.shields.io/travis/mcadonline/simple-sql-get.svg?style=flat)](https://travis-ci.org/mcadonline/simple-sql-get)
[![NPM Version](https://img.shields.io/npm/v/simple-sql-get.svg)](https://www.npmjs.com/package/simple-sql-get)

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

A very thin wrapper for the excellent [sequelize](http://docs.sequelizejs.com/en/latest/) 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: 'ebenes@jpeterman.com'
  }]
*/

```


## Settings

See [Sequelize docs](http://docs.sequelizejs.com/en/latest/docs/getting-started/) 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,
      },
    }
  }
}
```

---
_Source: https://npm.io/package/simple-sql-get · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._