Index

# CI-Node-query

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

### Supported adapters

- mysql
- mysql2
- pg
- dblite
- sqlite3

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

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

### 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
- The documentation generated for the latest dev build is also Available