Go to file
2016-11-14 20:23:27 -05:00
docs Make docs a little less confusing by removing an internal class 2016-09-14 21:59:18 -04:00
lib Completely promisify firebird driver 2016-11-14 20:23:27 -05:00
test Completely promisify firebird driver 2016-11-14 20:23:27 -05:00
.eslintrc Move eslint settings to .eslintrc, and fix minor code style issues 2016-03-11 13:29:01 -05:00
.gitignore Fix typo in test, remove test config file from source repo 2016-03-16 09:02:19 -04:00
.gitlab-ci.yml Attempt 2 for gitlab ci 2016-07-20 15:23:26 -04:00
.istanbul.yml Remove gulp in favor of npm scripts 2016-03-28 14:11:05 -04:00
.npmignore Update some metadata to publish to npm 2014-10-28 09:46:27 -04:00
API.md Make docs a little less confusing by removing an internal class 2016-09-14 21:59:18 -04:00
CHANGELOG.md Create standard result object. Resolves #3 2016-03-15 15:37:24 -04:00
LICENSE.md Remove bluebird dependency, add public query method, and re-add tests for node-firebird 2016-02-12 11:40:21 -05:00
package.json Really ugly progress commit 2016-11-10 22:10:45 -05:00
README.md Update dependencies and switch to Happiness code style 2016-09-14 16:50:32 -04:00

CI-Node-query

A node query builder for various SQL databases, based on CodeIgniter's query builder.

Build Status

Features

  • Callback and Promise API for making database calls.

Supported databases

  • Mysql (via mysql2)
  • PostgreSQL (via pg)
  • Sqlite (via dblite)

Installation

npm install ci-node-query

NPM

(Versions 3.x and below work differently. Their documentation is here)

Basic use


// Set the database connection details
const nodeQuery = require('ci-node-query')({
"driver": "mysql",
	"connection": {
		"host": "localhost",
		"user": "test",
		"password": "",
		"database": "test"
	}
});

// Get the query builder
const query = nodeQuery.getQuery();

query.select('foo')
	.from('bar')
	.where('x', 3)
	.orWhere({y: 2})
	.join('baz', 'baz.boo = bar.foo', 'left')
	.orderBy('x', 'DESC')
	.limit(2, 3)
	.get(function(err, result) {
		// Handle Results Here
	});

// As of version 3.1.0, you can also get promises
const queryPromise = query.select('foo')
	.from('bar')
	.where('x', 3)
	.orWhere({y: 2})
	.join('baz', 'baz.boo = bar.foo', 'left')
	.orderBy('x', 'DESC')
	.limit(2, 3)
	.get();

queryPromise.then(function(res) {
	// Handle query results
});

Result object

As of version 4, all adapters return a standard result object, which looks similar to this:

// Result object
{
    rows: [{
        columnName1: value1,
        columnName2: value2,
    }],

    columns: ['column1', 'column2'],
}

In addition to the rows, and columns properties, the result object has two methods, rowCount and columnCount. These methods return the number of rows and columns columns in the current result.

Security notes

As of version 2, where and having type methods parse the values passed to look for function calls. While values passed are still passed as query parameters, take care to avoid passing these kinds of methods unfiltered input. SQL function arguments are not currently parsed, so they need to be properly escaped for the current database.

Additional help

  • Generated documentation is in the docs/ folder
  • The API is documented in API.md
  • The tests/adapters folder contains examples of how to set up a connection for the appropriate database library
  • The documentation generated for the latest dev build is also Available

js-happiness-style