Timothy J. Warren 9fa2ddefa1 Version 5.0.0 2 months ago
docs Update documentation 2 months ago
documentation Update documentation 2 months ago
lib Remove unused variable, update docblock 2 months ago
test Add updateBatch method to query builder 2 months ago
.editorconfig No more callbacks in the public interface/New implementation to allow multiple adapters for a database type 1 year ago
.eslintrc Add updateBatch method to query builder 2 months ago
.gitignore Update gitignore 1 year ago
.gitlab-ci.yml update gitlab tests to run on newer node versions 2 months ago
.npmignore Update some metadata to publish to npm 3 years ago
API.md Update documentation 2 months ago
CHANGELOG.md Update docs, changelog, and readme 1 year ago
LICENSE.md Remove bluebird dependency, add public query method, and re-add tests for node-firebird 2 years ago
README.md Update documentation 2 months ago
docker-compose.yml Make helpers a class of static functions, add helper methods to run a full file of sql queries 1 year ago
package.json Add updateBatch method to query builder 2 months ago

README.md

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

// As of version 3.1.0, you can also get promises
// Version 5.0.0 removes all callback interfaces
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