pg 6.0.2 → 6.1.0

package/CHANGELOG.md

@@ -4,6 +4,10 @@ For richer information consult the commit log on github with referenced pull req
 
 We do not include break-fix version release in this file.
 
+### v6.1.0
+
+- Add optional callback parameter to the pure JavaScript `client.end` method.  The native client already supported this.
+
 ### v6.0.0
 
 #### Breaking Changes

package/README.md

@@ -2,6 +2,8 @@
 
 [![Build Status](https://secure.travis-ci.org/brianc/node-postgres.svg?branch=master)](http://travis-ci.org/brianc/node-postgres)
 [![Dependency Status](https://david-dm.org/brianc/node-postgres.svg)](https://david-dm.org/brianc/node-postgres)
+<span class="badge-npmversion"><a href="https://npmjs.org/package/pg" title="View this project on NPM"><img src="https://img.shields.io/npm/v/pg.svg" alt="NPM version" /></a></span>
+<span class="badge-npmdownloads"><a href="https://npmjs.org/package/pg" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/pg.svg" alt="NPM downloads" /></a></span>
 
 Non-blocking PostgreSQL client for node.js.  Pure JavaScript and optional native libpq bindings.
 
@@ -20,7 +22,7 @@ var pg = require('pg');
 
 // instantiate a new client
 // the client will read connection information from
-// the same environment varaibles used by postgres cli tools
+// the same environment variables used by postgres cli tools
 var client = new pg.Client();
 
 // connect to our database
@@ -109,26 +111,6 @@ It's __highly recommended__ you read the documentation for [pg-pool](https://git
 
 [Here is an up & running quickly example](https://github.com/brianc/node-postgres/wiki/Example)
 
-### connect to self signed Postgresql server
-
-Use following config to connect a Postgresql Server self signed:
-
-```
-var config = {
-    database : 'database-name', //env var: PGDATABASE
-    host     : "host-or-ip",    //env var: PGPORT
-    port     : 5432,            //env var: PGPORT
-    max      : 100,             // max number of clients in the pool
-    idleTimeoutMillis: 30000,
-    ssl : {
-        rejectUnauthorized : false,
-        ca   : fs.readFileSync("/path/to/server-certificates/maybe/root.crt").toString(),
-        key  : fs.readFileSync("/path/to/client-key/maybe/postgresql.key").toString(),
-        cert : fs.readFileSync("/path/to/client-certificates/maybe/postgresql.crt").toString(),
-    }
-};
-
-```
 
 For more information about `config.ssl` check [TLS (SSL) of nodejs](https://nodejs.org/dist/latest-v4.x/docs/api/tls.html)
 
@@ -157,7 +139,17 @@ var Pool = pg.Pool // good! a pool bound to the native client
 var Client = pg.Client // good! this client uses libpq bindings
 ```
 
-node-postgres abstracts over the pg-native module to provide exactly the same interface as the pure JavaScript version. Care has been taken to keep the number of api differences between the two modules to a minimum; however, it is recommended you use either the pure JavaScript or native bindings in both development and production and don't mix & match them in the same process - it can get confusing!
+#### API differences
+
+node-postgres abstracts over the pg-native module to provide the same interface as the pure JavaScript version. Care has been taken to keep the number of api differences between the two modules to a minimum.  
+However, currently some differences remain, especially :
+* the error object in pg-native is different : notably, the information about the postgres error code is not present in field `code` but in the field `sqlState` , and the name of a few other fields is different (see https://github.com/brianc/node-postgres/issues/938, https://github.com/brianc/node-postgres/issues/972).
+So for example, if you rely on error.code in your application, your will have to adapt your code to work with native bindings.
+* the notification object has a few less properties  (see https://github.com/brianc/node-postgres/issues/1045)
+* column objects have less properties (see https://github.com/brianc/node-postgres/issues/988)
+* the modules https://github.com/brianc/node-pg-copy-streams and https://github.com/brianc/node-pg-query-stream do not work with native bindings (you will have to require 'pg' to use them).
+
+Thus, it is recommended you use either the pure JavaScript or native bindings in both development and production and don't mix & match them in the same process - it can get confusing!
 
 ## Features
 

package/lib/client.js

@@ -336,8 +336,11 @@ Client.prototype.query = function(config, values, callback) {
   return query;
 };
 
-Client.prototype.end = function() {
+Client.prototype.end = function(cb) {
   this.connection.end();
+  if (cb) {
+    this.connection.once('end', cb);
+  }
 };
 
 Client.md5 = function(string) {

package/lib/connection.js

@@ -122,6 +122,9 @@ Connection.prototype.attachListeners = function(stream) {
       packet = self._reader.read();
     }
   });
+  stream.on('end', function() {
+    self.emit('end');
+  });
 };
 
 Connection.prototype.requestSsl = function() {

package/lib/index.js

@@ -68,13 +68,13 @@ PG.prototype.connect = function(config, callback) {
 
   this._pools[poolName] = this._pools[poolName] || new this.Pool(config);
   var pool = this._pools[poolName];
-  pool.connect(callback);
   if(!pool.listeners('error').length) {
     //propagate errors up to pg object
     pool.on('error', function(e) {
       this.emit('error', e, e.client);
     }.bind(this));
   }
+  return pool.connect(callback);
 };
 
 // cancel the query running on the given client

package/lib/native/query.js

@@ -34,8 +34,8 @@ var NativeQuery = module.exports = function(native) {
 
 util.inherits(NativeQuery, EventEmitter);
 
-NativeQuery.prototype.then = function(callback) {
-  return this.promise().then(callback);
+NativeQuery.prototype.then = function(onSuccess, onFailure) {
+  return this.promise().then(onSuccess, onFailure);
 };
 
 NativeQuery.prototype.catch = function(callback) {

package/lib/query.js

@@ -40,8 +40,8 @@ var Query = function(config, values, callback) {
 
 util.inherits(Query, EventEmitter);
 
-Query.prototype.then = function(callback) {
-  return this.promise().then(callback);
+Query.prototype.then = function(onSuccess, onFailure) {
+  return this.promise().then(onSuccess, onFailure);
 };
 
 Query.prototype.catch = function(callback) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg",
-  "version": "6.0.2",
+  "version": "6.1.0",
   "description": "PostgreSQL client - pure javascript & libpq with the same API",
   "keywords": [
     "postgres",
@@ -23,11 +23,12 @@
     "pg-connection-string": "0.1.3",
     "pg-pool": "1.*",
     "pg-types": "1.*",
-    "pgpass": "0.0.6",
+    "pgpass": "1.x",
     "semver": "4.3.2"
   },
   "devDependencies": {
     "async": "0.9.0",
+    "co": "4.6.0",
     "jshint": "2.5.2",
     "lodash": "4.13.1",
     "pg-copy-streams": "0.3.0",