sql-crud v0.2.5

sql-crud

A module for help with basic CRUD operations for most of the sql databases.

Important

This is not a stable version. I'm just working since March 2017, you can read the concept below

If you are interested Watch him on github

Collaboration is open.

Install

npm install --save-dev sql-crud

Concept

Despite there are several libraries for operate with sql databases, every one has a specific way to do the same operations.

For example:

mysql

//Select something
connection.query('SELECT 1 + 1 AS solution', function (error, results, fields) {
  if (error) throw error;
  console.log('The solution is: ', results[0].solution);
});
.
.
.

mssql

.
.
.
    new sql.Request().query('select * from mytable').then(function(recordset) {
        console.dir(recordset);
    }).catch(function(err) {
        // ... Errors
    });
 .
 .
 .

As you can see every module has a different way to do the same work.

So why not unify using the same methods?

Usage

Just pass your favorite SQL database as first parameter, the options of the query you want as second parameter, and if you want use an asyncronized function.

var mysql = require('mysql') //Require your db module, in this case, we're using mysql.
var connection = mysql.createConnection({
  host     : 'gk90usy5ik2otcvi.cbetxkdyhwsb.us-east-1.rds.yourhost.com',
  user     : 'ekk1j4ep3qnun9wm',
  password : 'a8mojldmf0cbr8i6',
  database : 'w7yh7cpln9w2enpc'
});

var sql = require('sql-crud');
var crud = new sql('mysql');  //or mssql, postgres, sqlite

//Select something
crud.select(connection, {select: 'id, name, lastname', where: {id:2}});
//Update something while plays something cool asynchronously
crud.update(connection, {update: 'users', set: {lastname: 'Rodriguez'}}, function(error, results) {
//Do something
});

API

The options explained below are available for use it. If you find some problem please consider open a issue in github.

Select:

crud.select(connection, {select: string, where: object, innerJoin: object}, callback, logs );

Parameters:

• connectionrequired: The connection object that provides your sql module (mysql, mssql, etc)
• select Required: A string that contains the elements that you want to select. In example: select: '*' or select: 'name, lastname'
• where optional: An object with the values you want to filter. Momentarily and, or options are not supported. In example: where: {id:2}
• innerJoin optional An Object that contains the next following properties:

{
table: string, 
on: string
}

In example: innerJoin: {table: 'USERS', on: 'USERS.id = COMPANY.name'
will generate INNER JOIN USERS ON USERS.id = COMPANY.name; within the query.

Insert

crud.insert(connection, [{options}], callback, logs);

Parameters:

• connection required:
  The connection object that provides your sql module (mysql, mssql, etc)
• options object:
  • insertInto string: The table

  • values object

• callback function: function(error, results) {}
• logs boolean: Turn on a console.log by query.

Update

crud.update(connection, [{options}], callback, logs);

Parameters:

• connection required:
  The connection object that provides your sql module (mysql, mssql, etc)
• options object:
  • table string
  • values object

  • where object

    • Example: {table: 'users', values: {name: 'Cesar'}, where: {id:1} }
• callback function: function(error, results) {}
• logs boolean: Turn on a console.log by query.

Delete

crud.delete(connection, [{options}], callback, logs);

Parameters:

• connection required:
  The connection object that provides your sql module (mysql, mssql, etc)
• options object:
  • from string: The database table

  • where object

• callback function: function(error, results) {}
• logs boolean: Turn on a console.log by query.

Last Updates

• 14-10-2017 v0.2.5 Fixed fatal error in delete operations.
• 09-10-2017 v0.2.4 mysql library was updated from 2.13.0 to 2.15.0 .
• 09-10-2017 v0.2.4 INNER JOIN clause was re structured.
• 23-05-2017 v0.2.3 INNER JOIN clause is updated.
• 09-05-2017 v0.2.2 WHERE clause now supports 2 or more parameters concatening with AND (OR will be supported later).
• 02-05-2017 v0.2.1 Now DELETE queries are enabled.
• 02-05-2017 v0.2.0 Now INSERT queries are enabled.
• 01-05-2017 Bug in select module related to innerJoin absence.
• 11-04-2017 Update (with update, set and where clauses within) queries are now available.
• 31-03-2017 Now you can use {select, where, innerJoin clauses} within a select Query!