Go to file
Timothy Warren d1e1d64912 Update docs and version 2014-10-28 16:47:30 -04:00
docs Update docs and version 2014-10-28 16:47:30 -04:00
lib Nearly 100% code coverage, and lots of miscellaneous fixes 2014-10-28 16:46:48 -04:00
node_modules Update docs 2014-10-28 14:43:48 -04:00
tests Nearly 100% code coverage, and lots of miscellaneous fixes 2014-10-28 16:46:48 -04:00
.gitignore A lot more tests 2014-10-24 10:30:54 -04:00
.npmignore Update some metadata to publish to npm 2014-10-28 09:46:27 -04:00
.travis.yml Add a verbose flag to mysql import to see where it is failing 2014-10-27 16:41:32 -04:00
Gruntfile.js A lot more tests 2014-10-24 10:30:54 -04:00
README.md Update README with additional help 2014-10-28 10:18:39 -04:00
package.json Update docs and version 2014-10-28 16:47:30 -04:00

README.md

#CI-Node-query

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

Build Status

Supported adapters

  • mysql
  • mysql2
  • pg

Installation

npm install ci-node-query

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('mysql', connection, 'mysql2');

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
	});

Additional help

  • Generated documentation is in the docs/ folder
  • tests/query-builder-base.js contains a lot of usage examples
  • The tests/adapters folder contains examples of how to set up a connection for the appropriate database library