Go to file
Timothy Warren 8f0b394d3c Remove Firebird. 2016-03-11 16:15:23 -05:00
docs First version with library-managed connections 2016-03-11 10:41:04 -05:00
lib Remove Firebird. 2016-03-11 16:15:23 -05:00
test Remove Firebird. 2016-03-11 16:15:23 -05:00
.eslintrc Move eslint settings to .eslintrc, and fix minor code style issues 2016-03-11 13:29:01 -05:00
.gitignore Update some metadata config files 2015-11-19 14:17:01 -05:00
.jscsrc Start of some code style cleanup 2015-12-07 15:58:31 -05:00
.npmignore Update some metadata to publish to npm 2014-10-28 09:46:27 -04:00
.travis.yml Update CI settings a little bit 2016-03-11 13:51:22 -05:00
API.md First version with library-managed connections 2016-03-11 10:41:04 -05:00
CHANGELOG.md First version with library-managed connections 2016-03-11 10:41:04 -05: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
README.md Remove bluebird dependency, add public query method, and re-add tests for node-firebird 2016-02-12 11:40:21 -05:00
gulpfile.js Move eslint settings to .eslintrc, and fix minor code style issues 2016-03-11 13:29:01 -05:00
package.json Remove bluebird dependency, add public query method, and re-add tests for node-firebird 2016-02-12 11:40:21 -05:00
sonar-project.properties Increment sonarqube version 2016-01-26 20:25:53 -05:00

README.md

CI-Node-query

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

Build Status Build Status Code Climate Test Coverage

Features

  • Callback and Promise API for making database calls.

Supported adapters

  • mysql
  • mysql2
  • pg
  • dblite
  • node-firebird (Not supported as of version 3.1.0, as the adapter is very difficult to test)

Installation

npm install ci-node-query

NPM

Basic use

var nodeQuery = require('ci-node-query');

var connection = ... // Database module connection

// Three arguments: database type, database connection, database connection library
var query = nodeQuery.init('mysql', connection, 'mysql2');

// The third argument is optional if the database connection library has the same name as the adapter, eg..
nodeQuery.init('mysql', connection, 'mysql');
// Can be instead
nodeQuery.init('mysql', connection);

// You can also retrieve the instance later
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(/* Adapter dependent arguments */) {
		// Database module result handling
	});

// As of version 3.1.0, you can also get promises
var 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
});

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