node-query/README.md

33 lines
811 B
Markdown
Raw Normal View History

2014-10-20 16:56:45 -04:00
#Node-query
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)
2014-10-28 09:46:27 -04:00
### Supported adapters
* mysql
* mysql2
* pg
2014-10-23 10:53:16 -04:00
### Basic use
2014-10-20 16:56:45 -04:00
2014-10-23 10:53:16 -04:00
var nodeQuery = require('node-query');
var connection = ... // Database module connection
2014-10-23 10:53:16 -04:00
// Three arguments: database type, database connection, database connection library
var query = nodeQuery('mysql', connection, 'mysql2');
2014-10-20 16:56:45 -04:00
2014-10-23 10:53:16 -04:00
query.select('foo')
2014-10-20 16:56:45 -04:00
.from('bar')
.where('x', 3)
2014-10-27 17:08:18 -04:00
.orWhere({y: 2})
2014-10-27 15:47:22 -04:00
.join('baz', 'baz.boo = bar.foo', 'left')
2014-10-27 17:08:18 -04:00
.orderBy('x', 'DESC')
2014-10-20 16:56:45 -04:00
.limit(2, 3)
2014-10-27 15:47:22 -04:00
.get(function(/* Adapter dependent arguments */) {
2014-10-23 10:53:16 -04:00
// Database module result handling
});
2014-10-20 16:56:45 -04:00