node-postgres/README.md

#node-postgres

Non-blocking (async) pure JavaScript PostgreSQL client for node.js written with love and TDD.

alpha version

Installation

npm install pg

Example

var Client = require('pg').Client;
var client = new Client({
  user: 'brianc',
  database: 'test',
  password: 'boom' //plaintext or md5 supported
});

client.connect();
client.on('drain', client.end.bind(client));

//queries are queued on a per-client basis and executed one at a time
client.query("create temp table user(heart varchar(10), birthday timestamptz);");

//parameters are always parsed & prepared inside of PostgreSQL server
//using unnamed prepared statement (no sql injection! yay!)
client.query({
  text: 'INSERT INTO user(heart, birthday) VALUES ($1, $2)',
  values: ['big', new Date(2031, 03, 03)]
});
client.query({
  text: 'INSERT INTO user(heart, birthday) VALUES ($1, $2)',
  values: ['filled with kisses', new Date(2010, 01, 01)]
});

var simpleQuery = client.query("select * from user where heart = 'big'");
simpleQuery.on('row', function(row){
  console.log(row.heart); //big
  console.log(row.birthday.getYear()); //2031
});

var preparedStatement = client.query({
  name: 'user by heart type',
  text: 'select * from user where heart = $1',
  values: ['big']
});

preparedStatement.on('row', function(row){
  console.log(row.heart); //big
  console.log(row.birthday.getYear()); //2031
});

var cachedPreparedStatement = client.query({
  name: 'user by heart type',
  //you can omit the text the 2nd time if using a named query
  values: ['filled with kisses']
});

cachedPreparedStatement.on('row', function(row){
  console.log(row.heart); //filled with kisses
  console.log(row.birthday.getYear()); //2010
});

Philosophy

• well tested
• no monkey patching
• no dependencies (...besides PostgreSQL)
• extreme documentation

features

• prepared statement support
  • parameters
  • query caching
• type coercion
  • date <-> timestamptz
  • integer <-> integer, smallint, bigint
  • float <-> double, numeric
  • boolean <-> boolean
• notification message support
• tested like a Toyota ~1000 assertions executed on
  • ubuntu
    • node v0.2.2, v0.2.3, v0.2.4, v0.2.5, v0.3.0, v0.3.1
    • postgres 8.4.4
  • osx
    • node v0.2.2, v0.2.3, v0.2.4, v0.2.5, v0.3.0, v0.3.1
    • postgres v8.4.4, v9.0.1 installed both locally and on networked Windows 7

Contributing

clone the repo:

 git clone git://github.com/brianc/node-postgres
 cd node-postgres
 node test/run.js

And just like magic, you're ready to contribute! <3

More info please

Documentation

PLEASE check out the WIKI. MUCH more information there.

Working?

this page is running the worlds worst (but fully functional) PostgreSQL backed, Node.js powered website.

Why did you write this?

As soon as I saw node.js for the first time I knew I had found something lovely and simple and just what I always wanted!. So...I poked around for a while. I was excited. I still am!

I drew major inspiration from postgres-js.

I also drew some major inspirrado from node-mysql and liked what I saw there.

Plans for the future?

• transparent prepared statement caching
• connection pooling
• more testings of error scenarios

License

node-postgres is licensed under the MIT license.