sql-bricks

Transparent, Schemaless SQL Generation

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 (postgres extensions are at https://github.com/Suor/sql-bricks-postgres, sqlite extensions are at https://github.com/CSNW/sql-bricks-sqlite)
  • Over 200 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:

librarylinesfilesschemalanguageother notes
Knex350030schemajavascripttransactions, migrations, promises, connection pooling
Squel10003schemalesscoffeescript
node-sql260059schemajavascript
mongo-sql170049schemalessjavascript
gesundheit160021schemalesscoffeescriptuses Any-DB to wrap the DB driver
sql-bricks8001schemalessjavascript

Related Libraries

  • sql-bricks-postgres adds postgres-dialect extensions:
    • LIMIT and OFFSET
    • RETURNING
    • UPDATE ... FROM
    • DELETE ... USING
    • FROM VALUES
  • pg-bricks adds:
    • connections
    • transactions
    • query execution
    • data accessors
  • sql-bricks-sqlite adds sqlite-dialect extensions:
    • LIMIT and OFFSET
    • OR REPLACE, OR ABORT, OR ROLLBACK, OR FAIL

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