psqljs

A minimal sql generator for nodejs and postgres

Get Started

$ npm install psqljs --save

// Require the module
var sql = require('psqljs');

Examples

Select

// { text: "select * from users", values: [] }
sql.select().from('users').toQuery();

// {text: "select id from users", values: [] }
sql.select('id').from('users').toQuery();

// { text: "select id, name from users", values: [] }
sql.select('id', 'name').from('users').toQuery();

Where

// { text: "select * from users where id = $1", values: [1] }
sql.select().from('users').where('id = $1', 1).toQuery();

// { text: "select * from users where firstName = $1 and lastName = $2", values: ['Johnny', 'Appleseed'] }
sql.select().from('users').where('firstName = $1 and lastName = $2', 'Johnny', 'Appleseed').toQuery();

// { text: "select * from users where firstName = $1 or lastName = $2", values: ['Johnny', 'Appleseed'] }
sql.select().from('users').where('firstName = $1 or lastName = $2', 'Johnny', 'Appleseed').toQuery();

Insert

// { text: "insert into users (firstName, lastName) values ($1, $2)", values: ['Johnny', 'Appleseed'] }
sql.insert('users', { firstName: 'Johnny', lastName: 'Appleseed' }).toQuery();

Update

// { text: "update users set firstName = $1 where firstName = $2", values: ['Sally', 'Johnny'] }
sql.update('users', { firstName: 'Sally' }).where('firstName = $1', 'Johnny').toQuery();

// { text: "update users set salary = $1, house = $2 where job = $3", values: ['billions', 'private island', 'CEO'] }
sql.update('users', { salary: 'billions', house: 'private island' }).where('job = $1', 'CEO').toQuery();

Delete

// { text: "delete from users where firstName = $1", values: ['Johnny'] }
sql.delete('users').where('firstName = $1', 'Johnny').toQuery();

Returning

// { text: "insert into users (firstName, lastName) values ($1, $2) returning *", values: ['Johnny', 'Appleseed'] }
sql.insert('users', { firstName: 'Johnny', lastName: 'Appleseed' }).returning().toQuery();

// { text: "insert into users (firstName, lastName) values ($1, $2) returning firstName, lastName", values: ['Johnny', 'Appleseed'] }
sql.insert('users', { firstName: 'Johnny', lastName: 'Appleseed' }).returning('firstName', 'lastName').toQuery();

Order

// { text: "select * from users order by createdAt desc", values: [] }
sql.select().from('users').order('createdAt desc').toQuery();

// { text: "select * from users order by createdAt desc, id asc", values: [] }
sql.select().from('users').order('createdAt desc', 'id asc').toQuery();

Limit/Offset

// { text: "select * from users limit 10", values: [] }
sql.select().from('users').limit(10).toQuery();

// { text: "select * from users limit 10 offset 5", values: [] }
sql.select().from('users').limit(10).offset(5).toQuery();

Run the Tests

$ npm test