sqorn's Introduction

Sqorn ·

Sqorn is a Javascript library for building SQL queries.

Ergonomic: Sqorn's intuitive API might make you forget you're building SQL.

Composable: Build complex queries from simple parts. Chain, extend, and embed queries.

Boilerplate free: Sqorn provides concise syntax for common CRUD operations.

Fast: 10x faster than Knex.js and 200x faster than Squel

Install

Sqorn requires Node version 8 or above.

npm install --save sqorn
npm install --save pg # only Postgres is currently supported

Then read the tutorial and try the online demo.

Examples

CRUD Operations are dead simple.

const sq = require('sqorn')()

const Person = sq`person`, Book = sq`book`

// SELECT
const children = await Person`age < ${13}`
// "select * from person where age < 13"

// DELETE
const [deleted] = await Book.del({ id: 7 })`title`
// "delete from book where id = 7 returning title"

// INSERT
await Person.ins({ firstName: 'Rob' })
// "insert into person (first_name) values ('Rob')"

// UPDATE
await Person({ id: 23 }).set({ name: 'Rob' })
// "update person where id = 23 set name = 'Rob'"

Build complex queries from simple parts.

// CHAIN QUERIES
sq.frm`book`
  .ret`distinct author`
  .whr({ genre: 'Fantasy' })
  .whr({ language: 'French' })
// select distinct author from book
// where language = 'French' and genre = 'Fantsy'

// EXTEND QUERIES
sq.ext(
  sq.frm`book`,
  sq.ret`distinct author`,
  sq.whr({ genre: 'Fantasy' }),
  sq.whr({ language: 'French' })
)
// select distinct author from book
// where language = 'French' and genre = 'Fantsy'

// EMBED Queries
sq.ret`now() today, ${sq.ret`now() + '1 day'`} tomorrow`
// select now() today, (select now() + '1 day') tomorrow