effortless-sql

Super simple SQL client for node

• Simplest possible api
• Promise based
• Automatic connection lifecycle management
• Reasonable parameter handling by default
• Tested on SQL server
• Naive wrapper around Tedious
• Works out of the box - no native bindings/gyp builds required
• requires native promises, a promise shim or bluebird

var options = {
  userName: 'john',
  password: '******',
  server: '127.0.0.1',
  options: {
    database: 'next-hype'
  }
}
 
var sql = require('effortless-sql')(options)
 
sql.queryRows(
  'select readbility, simplicity from Stuff where coolness = @coolness',
    {coolness: 'awesome'})
  .then(function (rows) {
    rows.forEach(function (stuff) {
      console.log('%s - %s', stuff.readbility, stuff.simplicity)
    })
  })

API

Create connection

var sqlFactory = require('effortless-sql')
var sql = sqlFactory(options)

options should be compatible with Tedious, as they are passed along unmodified.

sql.queryRows([sql statement], [optional parameters])

Returns resulting rows from statement as array of objects with columns mapped to properties.

sql.querySingleRow([sql statement], [optional parameters])

Returns resulting first row or undefined if empty result.

sql.executeRows(stored procedure name, optional parameters)

Returns resulting rows from stored procedure as array of objects with columns mapped to properties.

sql.executeSingleRow(stored procedure name, optional parameters)

Returns resulting first row from stored procedure or undefined if empty result.

sql.query(sql statement, optional parameters)

Returns

{
  rows: <mapped result rows>,
  rowCount: <number of rows reported by server>,
  duration: <time taken in ms>
}

sql.execute(stored procedure name, optional parameters)

Returns

{
  rows: <mapped result rows>,
  rowCount: <number of rows reported by server>,
  duration: <time taken in ms>
}

Parameter mapping

Below, T is an alias for require('effortless-sql').TYPES which is same as require('tedious').TYPES

Testing

Tests run on my computer, but are not linked to any CI. I'm ashamed.