b5b49eb895
This adds deprecations in preparation for `pg@7.0` - deprecate using event emitters on automatically created results from client.query. - deprecate query.promise() - it should never have been a public method and it's not documented. I need to do better about using _ prefix on private methods in the future. - deprecate singleton pool on the `pg` object. `pg.connect`, `pg.end`, and `pg.cancel`.
115 lines
3.4 KiB
JavaScript
115 lines
3.4 KiB
JavaScript
/**
|
|
* Copyright (c) 2010-2017 Brian Carlson (brian.m.carlson@gmail.com)
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* README.md file in the root directory of this source tree.
|
|
*/
|
|
|
|
var EventEmitter = require('events').EventEmitter;
|
|
var util = require('util');
|
|
var Client = require('./client');
|
|
var defaults = require('./defaults');
|
|
var Connection = require('./connection');
|
|
var ConnectionParameters = require('./connection-parameters');
|
|
var poolFactory = require('./pool-factory');
|
|
|
|
var PG = function(clientConstructor) {
|
|
EventEmitter.call(this);
|
|
this.defaults = defaults;
|
|
this.Client = clientConstructor;
|
|
this.Query = this.Client.Query;
|
|
this.Pool = poolFactory(this.Client);
|
|
this._pools = [];
|
|
this.Connection = Connection;
|
|
this.types = require('pg-types');
|
|
};
|
|
|
|
util.inherits(PG, EventEmitter);
|
|
|
|
PG.prototype.end = util.deprecate(function() {
|
|
var self = this;
|
|
var keys = Object.keys(this._pools);
|
|
var count = keys.length;
|
|
if(count === 0) {
|
|
self.emit('end');
|
|
} else {
|
|
keys.forEach(function(key) {
|
|
var pool = self._pools[key];
|
|
delete self._pools[key];
|
|
pool.pool.drain(function() {
|
|
pool.pool.destroyAllNow(function() {
|
|
count--;
|
|
if(count === 0) {
|
|
self.emit('end');
|
|
}
|
|
});
|
|
});
|
|
});
|
|
}
|
|
}, 'PG.end is deprecated - please see the upgrade guide at https://node-postgres.com/guides/upgrading');
|
|
|
|
PG.prototype.connect = util.deprecate(function(config, callback) {
|
|
if(typeof config == "function") {
|
|
callback = config;
|
|
config = null;
|
|
}
|
|
if (typeof config == 'string') {
|
|
config = new ConnectionParameters(config);
|
|
}
|
|
|
|
config = config || {};
|
|
|
|
//for backwards compatibility
|
|
config.max = config.max || config.poolSize || defaults.poolSize;
|
|
config.idleTimeoutMillis = config.idleTimeoutMillis || config.poolIdleTimeout || defaults.poolIdleTimeout;
|
|
config.log = config.log || config.poolLog || defaults.poolLog;
|
|
|
|
var poolName = JSON.stringify(config);
|
|
this._pools[poolName] = this._pools[poolName] || new this.Pool(config);
|
|
var pool = this._pools[poolName];
|
|
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);
|
|
}, 'PG.connect is deprecated - please see the upgrade guide at https://node-postgres.com/guides/upgrading');
|
|
|
|
// cancel the query running on the given client
|
|
PG.prototype.cancel = util.deprecate(function(config, client, query) {
|
|
if(client.native) {
|
|
return client.cancel(query);
|
|
}
|
|
var c = config;
|
|
//allow for no config to be passed
|
|
if(typeof c === 'function') {
|
|
c = defaults;
|
|
}
|
|
var cancellingClient = new this.Client(c);
|
|
cancellingClient.cancel(client, query);
|
|
}, 'PG.cancel is deprecated - use client.cancel instead');
|
|
|
|
if(typeof process.env.NODE_PG_FORCE_NATIVE != 'undefined') {
|
|
module.exports = new PG(require('./native'));
|
|
} else {
|
|
module.exports = new PG(Client);
|
|
|
|
//lazy require native module...the native module may not have installed
|
|
module.exports.__defineGetter__("native", function() {
|
|
delete module.exports.native;
|
|
var native = null;
|
|
try {
|
|
native = new PG(require('./native'));
|
|
} catch (err) {
|
|
if (err.code !== 'MODULE_NOT_FOUND') {
|
|
throw err;
|
|
}
|
|
console.error(err.message);
|
|
}
|
|
module.exports.native = native;
|
|
return native;
|
|
});
|
|
}
|