Go to file
Timothy J Warren 9fa2ddefa1 Version 5.0.0
* Remove callback interface
* Add updateBatch command
2018-02-12 15:37:33 -05:00
docs Update documentation 2018-02-12 14:58:50 -05:00
documentation Update documentation 2018-02-12 14:58:50 -05:00
lib Remove unused variable, update docblock 2018-02-12 14:57:58 -05:00
test Add updateBatch method to query builder 2018-02-09 17:29:26 -05:00
.editorconfig No more callbacks in the public interface/New implementation to allow multiple adapters for a database type 2016-11-18 21:59:22 -05:00
.eslintrc Add updateBatch method to query builder 2018-02-09 17:29:26 -05:00
.gitignore Update gitignore 2016-11-14 20:26:26 -05:00
.gitlab-ci.yml update gitlab tests to run on newer node versions 2018-02-12 15:11:59 -05:00
.npmignore Update some metadata to publish to npm 2014-10-28 09:46:27 -04:00
API.md Update documentation 2018-02-12 14:58:50 -05:00
CHANGELOG.md Update docs, changelog, and readme 2016-11-18 22:15:56 -05:00
docker-compose.yml Make helpers a class of static functions, add helper methods to run a full file of sql queries 2016-11-22 16:03:46 -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
package.json Add updateBatch method to query builder 2018-02-09 17:29:26 -05:00
README.md Update documentation 2018-02-12 14:58:50 -05:00


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

Build Status


  • Callback and Promise API for making database calls.

Supported databases

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


npm install ci-node-query


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

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

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