Package Exports

sql-bricks

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (sql-bricks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SQL Bricks.js

SQL Bricks.js is a transparent, schemaless library for building and composing SQL statements.

Supports all SQL-92 clauses for select/insert/update/delete (plus some postgres & sqlite additions)
Over 175 tests
Easy-to-use, comprehensive docs
Single straightforward source file (less than 1,000 lines), easy to understand & debug

Comparison with popular SQL-generation libraries:

library	lines	files	schema	language	other notes
Knex	3500	30	schema	javascript	transactions, migrations, promises, connection pooling
Squel	1000	3	schemaless	coffeescript
node-sql	2600	59	schema	javascript
mongo-sql	1700	49	schemaless	javascript
gesundheit	1600	21	schemaless	coffeescript	uses Any-DB to wrap the DB driver
sql-bricks	750	1	schemaless	javascript

Use

SQLBricks' only dependency is Underscore.js.

In the browser:

var select = SqlBricks.select;

select().from('person').where({last_name: 'Rubble'});
// SELECT * FROM person WHERE last_name = 'Rubble'

In node:

var select = require('sql-bricks').select;

select().from('person').where({last_name: 'Rubble'});
// SELECT * FROM person WHERE last_name = 'Rubble'

Examples

The SQLBricks API is comprehensive, supporting all of SQL-92 for select/insert/update/delete. It is also quite flexible; in most places arguments can be passed in a variety of ways (arrays, objects, separate arguments, etc). That said, here are some of the most common operations:

// convenience variables (for node; for the browser: "var sql = SqlBricks;")
var sql = require('sql-bricks');
var select = sql.select, insert = sql.insert, update = sql.update;
var or = sql.or, like = sql.like, lt = sql.lt;

// WHERE: (.toString() is optional; JS will call it automatically in most cases)
select().from('person').where({last_name: 'Rubble'}).toString();
// SELECT * FROM person WHERE last_name = 'Rubble'

// JOINs:
select().from('person').join('address').on({'person.addr_id': 'address.id'});
// SELECT * FROM person INNER JOIN address ON person.addr_id = address.id

// Nested WHERE criteria:
select('*').from('person').where(or(like('last_name', 'Flint%'), {'first_name': 'Fred'}));
// SELECT * FROM person WHERE last_name LIKE 'Flint%' OR first_name = 'Fred'

// GROUP BY / HAVING
select('city', 'max(temp_lo)').from('weather')
  .groupBy('city').having(lt('max(temp_lo)', 40))
// SELECT city, max(temp_lo) FROM weather
// GROUP BY city HAVING max(temp_lo) < 40

// INSERT
insert('person', {'first_name': 'Fred', 'last_name': 'Flintstone'});
// INSERT INTO person (first_name, last_name) VALUES ('Fred', 'Flintstone')

// UPDATE
update('person', {'first_name': 'Fred', 'last_name': 'Flintstone'});
// UPDATE person SET first_name = 'Fred', last_name = 'Flintstone'


// Parameterized SQL
update('person', {'first_name': 'Fred'}).where({'last_name': 'Flintstone'}).toParams();
// {"text": "UPDATE person SET first_name = $1 WHERE last_name = $2", "values": ["Fred", "Flintstone"]}

// SQLite-style params
update('person', {'first_name': 'Fred'}).where({'last_name': 'Flintstone'}).toParams({placeholder: '?%d'});
// {"text": "UPDATE person SET first_name = ?1 WHERE last_name = ?2", "values": ["Fred", "Flintstone"]}

// MySQL-style params
update('person', {'first_name': 'Fred'}).where({'last_name': 'Flintstone'}).toParams({placeholder: '?'});
// {"text": "UPDATE person SET first_name = ? WHERE last_name = ?", "values": ["Fred", "Flintstone"]}

Documentation: http://csnw.github.io/sql-bricks

License: MIT