timw4mail/node-query
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Timothy Warren 2016-01-12 15:46:37 -05:00
parent c1b03a9814
commit 4b24771716
1 changed files with 60 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

117
README.md
View File

@ -1,57 +1,60 @@
#CI-Node-query #CI-Node-query
A node query builder for various SQL databases, based on CodeIgniter's query builder. A node query builder for various SQL databases, based on CodeIgniter's query builder.
[![Build Status](https://travis-ci.org/timw4mail/node-query.svg?branch=master)](https://travis-ci.org/timw4mail/node-query) [![Build Status](https://jenkins.timshomepage.net/buildStatus/icon?job=node-query)](https://jenkins.timshomepage.net/job/node-query/)
[![Build Status](https://travis-ci.org/timw4mail/node-query.svg?branch=master)](https://travis-ci.org/timw4mail/node-query)
### Supported adapters [![Code Climate](https://codeclimate.com/github/timw4mail/node-query/badges/gpa.svg)](https://codeclimate.com/github/timw4mail/node-query)
[![Test Coverage](https://codeclimate.com/github/timw4mail/node-query/badges/coverage.svg)](https://codeclimate.com/github/timw4mail/node-query/coverage)
* mysql
* mysql2 ### Supported adapters
* pg
* dblite * mysql
* node-firebird * mysql2
* pg
### Installation * dblite
* node-firebird
npm install ci-node-query
### Installation
### Basic use
npm install ci-node-query
var nodeQuery = require('ci-node-query');
### Basic use
var connection = ... // Database module connection
var nodeQuery = require('ci-node-query');
// Three arguments: database type, database connection, database connection library
var query = nodeQuery.init('mysql', connection, 'mysql2'); var connection = ... // Database module connection
// The third argument is optional if the database connection library has the same name as the adapter, eg.. // Three arguments: database type, database connection, database connection library
nodeQuery.init('mysql', connection, 'mysql'); var query = nodeQuery.init('mysql', connection, 'mysql2');
// Can be instead
nodeQuery.init('mysql', connection); // The third argument is optional if the database connection library has the same name as the adapter, eg..
nodeQuery.init('mysql', connection, 'mysql');
// You can also retrieve the instance later // Can be instead
query = nodeQuery.getQuery(); nodeQuery.init('mysql', connection);
query.select('foo') // You can also retrieve the instance later
.from('bar') query = nodeQuery.getQuery();
.where('x', 3)
.orWhere({y: 2}) query.select('foo')
.join('baz', 'baz.boo = bar.foo', 'left') .from('bar')
.orderBy('x', 'DESC') .where('x', 3)
.limit(2, 3) .orWhere({y: 2})
.get(function(/* Adapter dependent arguments */) { .join('baz', 'baz.boo = bar.foo', 'left')
// Database module result handling .orderBy('x', 'DESC')
}); .limit(2, 3)
.get(function(/* Adapter dependent arguments */) {
### Security notes // Database module result handling
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. });
### Security notes
### Additional help 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.
* Generated documentation is in the docs/ folder
* `tests/query-builder-base.js` contains a lot of usage examples ### Additional help
* 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](https://github.timshomepage.net/node-query/docs/) * 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](https://github.timshomepage.net/node-query/docs/)