Complete access layer to node-postgres via Promises/A+.
- Supporting Promise, Bluebird, When, Q, etc.
- Transactions, functions, flexible query formatting;
- Automatic database connections;
- Strict query result filters.
Built on top of node-postgres and its connection pool, this library translates their callback interface into one based on Promises/A+, while extending the protocol to a higher level, with automated connections and transactions management.
In addition, the library provides:< 9E88 /p>
- its own, more flexible query formatting;
- complete event reporting for connectivity, errors, queries and transactions;
- declarative approach to controlling query results;
- support for all popular promise libraries.
$ npm install pg-promise
- Install project dependencies:
$ npm install
-
Make sure the tests can connect to your local test database, according to connection details in test/db/header.js. Either match your database configuration or change the connection details in that file.
-
Initialize the database with some test data:
$ node test/db/init.js
- Run tests:
$ make test
On Windows you can also run tests with test.bat
// Loading the library:
var pgpLib = require('pg-promise');// Initializing the library, with optional global settings:
var pgp = pgpLib(/*options*/);You can pass additional options parameter when initializing the library (see chapter Initialization Options for details).
Use one of the two ways to specify database connection details:
- Configuration Object:
var cn = {
host: 'localhost', // server name or IP address;
port: 5432,
database: 'my_db_name',
user: 'user_name',
password: 'user_password'
};- Connection String:
var cn = "postgres://username:password@host:port/database";This library doesn't use any of the connection's details, it simply passes them on to PG when opening a new connection. For more details see pg connection parameters in WiKi and implementation.
var db = pgp(cn); // create a new database instance from the connection detailsThere can be multiple database objects instantiated in the application from different connection details.
To get started quickly, see our Learn by Example tutorial.
And once you get it all up and running, have a look at pg-monitor, which can work a treat for monitoring queries in your application.
The library supports promise-chained queries on shared and detached connections. Choosing which one you want depends on the situation and personal preferences.
Queries in a detached promise chain maintain connection independently, they each acquire a connection from the pool, execute the query and then release the connection.
db.one("select * from users where id=$1", 123) // find the user from id;
.then(function(data){
// find 'login' records for the user found:
return db.query("select * from audit where event=$1 and userId=$2",
["login", data.id]);
})
.then(function(data){
// display found audit records;
console.log(data);
}, function(reason){
console.log(reason); // display reason why the call failed;
})In a situation where a single request is to be made against the database, a detached chain is the only one that makes sense. And even if you intend to execute multiple queries in a chain, keep in mind that even though each will use its own connection, such will be used from a connection pool, so effectively you end up with the same connection, without any performance penalty.
A promise chain with a shared connection always starts with connect(), which allocates a connection that's shared with all the
query requests down the promise chain. The connection must be released when no longer needed.
var sco; // shared connection object;
db.connect()
.then(function(obj){
sco = obj; // save the connection object;
// find active users created before today:
return sco.query("select * from users where active=$1 and created < $2",
[true, new Date()]);
})
.then(function(data){
console.log(data); // display all the user details;
}, function(reason){
console.log(reason); // display reason why the call failed;
})
.done(function(){
if(sco){
sco.done(); // release the connection, if it was successful;
}
});Shared-connection chaining is for those who want absolute control over connection, either because they want to execute lots of queries in one go, or because they like squeezing every bit of performance out of their code. Other than, the author hasn't seen any real performance difference from the detached-connection chaining.
Transactions can be executed within both shared and detached promise chains in the same way, performing the following actions:
- Acquires a new connection (detached chains only);
- Executes
BEGINcommand; - Invokes your callback function with the connection object;
- Executes
COMMIT, if the callback resolves, orROLLBACK, if the callback rejects; - Releases the connection (detached chains only);
- Resolves with the callback result, if success; rejects with the reason, if failed.
var promise = require('promise'); // or any other supported promise library;
db.tx(function(){
// creating a sequence of transaction queries:
var q1 = this.none("update users set active=$1 where id=$2", [true, 123]);
var q2 = this.one("insert into audit(entity, id) values($1, $2) returning id",
['users', 123]);
// returning a promise that determines a successful transaction:
return promise.all([q1, q2]); // all of the queries are to be resolved
}).then(function(data){
console.log(data); // printing successful transaction output
}, function(reason){
console.log(reason); // printing the reason why the transaction was rejected
});A detached transaction acquires a connection and exposes object t to let all containing queries execute on the same connection.
When executing a transaction within a shared connection chain, parameter t represents the same connection as sco from opening a shared connection,
so either one can be used inside such a transaction interchangeably.
var promise = require('promise'); // or any other supported promise library;
var sco; // shared connection object;
db.connect()
.then(function(obj){
sco = obj;
return sco.oneOrNone("select * from users where active=$1 and id=$1", [true, 123]);
})
.then(function(data){
return sco.tx(function(t){
// Since it is a transaction within a shared chain, it doesn't matter whether
// the two calls below use object `t` or `sco`, as they are exactly the same:
var q1 = t.none("update users set active=$1 where id=$2", [false, data.id]);
var q2 = sco.one("insert into audit(entity, id) values($1, $2) returning id",
['users', 123]);
// returning a promise that determines a successful transaction:
return promise.all([q1, q2]); // all of the queries are to be resolved;
});
}, function(reason){
console.log(reason); // printing the reason why the transaction was rejected;
})
.done(function(){
if(sco){
sco.done(); // release the connection, if it was successful;
}
});If you need to execute just one transaction, the detached transaction pattern is all you need. But even if you need to combine it with other queries in then a detached chain, it will work just as fine. As stated earlier, choosing a shared chain over a detached one is mostly a matter of special requirements and/or personal preference.
Similar to the shared-connection transactions, nested transactions automatically share the connection between all levels. This library sets no limitation as to the depth (nesting levels) of transactions supported.
Example:
db.tx(function () {
var queries = [
this.none("drop table users;"),
this.none("create table users(id serial not null, name text not null)")
];
for (var i = 1; i <= 100; i++) {
queries.push(this.none("insert into users(name) values($1)", "name-" + i));
}
queries.push(
this.tx(function () {
return this.tx(function(){
return this.one("select count(*) from users");
});
}));
return promise.all(queries);
})
.then(function (data) {
console.log(data); // printing transaction result;
}, function (reason) {
console.log(reason); // printing why the transaction failed;
})Things to note from the example above:
- Sub-transactions do not declare a context parameter in their callback. It is not because
they don't receive one, they all do, but they don't care in such situation because of the shared connection
chain that will result in the same
tobject as for the main callback, so they just reuse it from the parent, for simplicity; - A nested transaction cannot be disconnected from its container, i.e. it must get into the container's promise chain, or it will result in an attempt to execute against an unknown connection;
- As expected, a failure on any level in a nested transaction will
ROLLBACKandrejectthe entire chain.
SAVEPOINT in PostgreSQL caters for advanced transaction scenarios where partial ROLLBACK can be executed,
depending on the logic of the transaction.
Unfortunately, this doesn't go along with the Promises/A+ architecture that doesn't support partial reject.
The only work-around via promises is to strip a transaction into individual commands and execute them as a promise chain within a shared connection. The example below shows how this can be done.
var sco; // shared connection object;
var txErr; // transaction error;
var txData; // transaction data;
db.connect()
.then(function (obj) {
sco = obj; // save the connection object;
return promise.all([
sco.none('begin'),
sco.none('update users set name=$1 where id=$2', ['changed1', 1]),
sco.none('savepoint first'), // creating savepoint;
sco.none('update users set name=$1 where id=$2', ['changed2', 2]),
sco.none('rollback to first') // reverting to the savepoint;
])
.then(function (data) {
txData = data; // save the transaction output data;
return sco.none('commit'); // persist changes;
}, function (reason) {
txErr = reason; // save the transaction failure reason;
return sco.none('rollback'); // revert changes;
});
})
.then(function () {
if (txErr) {
console.log('Rollback Reason: ' + txErr);
} else {
console.log(txData); // successful transaction output;
}
}, function (reason) {
console.log(reason); // connection issue;
})
.done(function () {
if (sco) {
sco.done(); // release the connection, if it was successful;
}
});The issue with stripping out a transaction like this and injecting SAVEPOINT - it gets much more
complicated to control the result of individual commands within a transaction, you may need to check every
result and change the following commands accordingly. This is why it makes much more sense to do such
transactions inside SQL functions, and not on the client side.
A transaction usually relies on generic method promise.all([...]) to resolve all queries asynchronously.
The only downside of this approach is when one query fails and results in ROLLBACK, the rest of queries
will continue execution regardless. As a result, there may be some errors generated, each stating that
a query outside of transaction will be ignored, which by no means breaks the transaction logic,
just fills your error log with query failures that are of no consequence.
A transaction object has method sequence, with alias queue, to enforce a strict sequence
of queries to be executed inside your transaction, one by one, and if one fails - the rest won't execute.
In the promise architecture this is achieved by using a promise factory.
function txFactory(idx, t) {
// must create and return a promise object dynamically,
// based on the index of the sequence (parameter idx);
switch (idx) {
case 0:
return t.query("select 0");
case 1:
return t.query("select 1");
case 2:
return t.query("select 2");
}
// returning nothing or null indicates the end of the sequence;
// throwing an error will result in a reject;
}
db.tx(function (t) {
// same as calling t.queue(txFactory);
return t.sequence(txFactory);
})
.then(function (data) {
console.log(data); // print result;
}, function (reason) {
console.log(reason); // print error;
});A simpler example, using this context (version 1.4.0 or later):
db.tx(function () {
return this.sequence(function (idx) {
switch (idx) {
case 0:
return this.query("select 0");
case 1:
return this.query("select 1");
case 2:
return this.query("select 2");
}
});
})
.then(function (data) {
console.log(data); // print result;
}, function (reason) {
console.log(reason); // print error;
});Such approach guarantees strict sequence of queries execution by turning an otherwise asynchronous queue of queries into a synchronous one, which has a cost to consider.
This approach should normally be considered for transactions with many independent queries of the same nature, like bulk inserts, to reduce memory usage at the expense of synchronous execution.
NOTE: Version 1.0.3 added queryRaw(query, values) to bypass any result verification and resolve
with the Result object as provided by the PG library.
Every connection context of the library shares the same query protocol, starting with generic method query,
that's defined as shown below:
function query(query, values, qrm);query(required) - a string with support for three types of formatting, depending on thevaluespassed:- format
$1(single variable), ifvaluesis of typestring,boolean,number,Date,functionornull; - format
$1, $2, etc.., ifvaluesis an array of values; - format
$*propName*, ifvaluesis an object (not null and not Date), where*is any of the supported open-close pairs:{},(),<>,[],//;
- format
values(optional) - value/array/object to replace the variables in the query;qrm- (optional) Query Result Mask, as explained below...
When a value/property inside array/object is of type array, it is treated as a PostgreSQL Array Type,
converted into the array constructor format of array[], the same as calling method as.array().
Examples:
console.log(pgp.as.array([[1, 2, 3], [4, 5, null]]));
// will print: array[[1,2,3],[4,5,null]]
console.log(pgp.as.array([['one', 'two'], [undefined, 'four']]));
// will print: array[['one','two'],[null,'four']]
console.log(pgp.as.array([[1, 2], ['three', 'four']]));
// will print: array[[1,2],['three','four']],
// but executing it within a query will throw an error
// due to heterogeneous data type in the array.When a value/property inside array/object is of type object (except for null and Date), it is automatically
serialized into JSON, the same as calling method as.json(), except the latter would convert anything to JSON.
Raw text values can be injected by using variable name appended with symbol ^:
$1^, $2^, etc..., $*varName^*, where * is any of the supported open-close pairs: {}, (), <>, [], //
Raw text is injected without any pre-processing, which means:
- No replacing each single-quote symbol
'with two; - No wrapping text into single quotes.
This is to allow for special-case variable formatting, like in the following examples:
// injecting "John" name without quotes:
query("...WHERE name LIKE '%$1^%'", "John");
// injecting value of property 'name' without quotes:
query("...WHERE name LIKE '%${name^}%'", {name: "John"});
// injecting a CSV-formatted text without quotes:
query("...WHERE id IN($1^)", pgp.as.csv([1,2,3,4])); In order to eliminate the chances of unexpected query results and make code more robust, each request supports
parameter qrm (Query Result Mask), via type queryResult:
///////////////////////////////////////////////////////
// Query Result Mask flags;
//
// Any combination is supported, except for one + many.
queryResult = {
one: 1, // single-row result is expected;
many: 2, // multi-row result is expected;
none: 4, // no rows expected;
any: 6 // (default) = many|none = any result.
};In the following generic-query example we indicate that the call can return anything:
db.query("select * from users");which is equivalent to calling either one of the following:
db.query("select * from users", undefined, queryResult.many | queryResult.none);
db.query("select * from users", undefined, queryResult.any);
db.manyOrNone("select * from users");
db.any("select * from users");This usage pattern is facilitated through result-specific methods that can be used instead of the generic query:
db.many(query, values); // expects one or more rows
db.one(query, values); // expects a single row
db.none(query, values); // expects no rows
db.any(query, values); // expects anything, same as `manyOrNone`
db.oneOrNone(query, values); // expects 1 or 0 rows
db.manyOrNone(query, values); // expects anything, same as `any`You can add your own methods to this protocol via the extend event.
Each query function resolves its data object according to the qrm that was used:
none- data isundefined. If the query returns any kind of data, it is rejected.one- data is a single object. If the query returns no data or more than one row of data, it is rejected.many- data is an array of objects. If the query returns no rows, it is rejected.one|none- data isnull, if no data was returned; or a single object, if there was one row of data returned. If the query returns more than one row of data, the query is rejected.many|none- data is an array of objects. When no rows are returned, data is an empty array.
If you try to specify one|many in the same query, such query will be rejected without executing it, telling you that such mask is invalid.
If qrm is not specified when calling generic query method, it is assumed to be many|none, i.e. any kind of data expected.
This is all about writing robust code, when the client specifies what kind of data it is ready to handle on the declarative level, leaving the burden of all extra checks to the library.
The library supports named parameters in query formatting, with the syntax of $*propName*,
where * is any of the following open-close pairs: {}, (), <>, [], //
db.query("select * from users where name=${name} and active=$/active/", {
name: 'John',
active: true
});The same goes for all types of query methods as well as method as.format(query, values), where values
now can also be an object whose properties can be referred to by name from within the query.
Since all variables in this case are property names of the object-parameter, standard javascript variable naming convention applies here:
- a valid variable starts with a letter, underscore or
$symbol, followed by any combination of letters, digits, underscores and$; - leading and trailing white spaces surrounding variables are ignored;
- variable names are case-sensitive.
It is important to know that while property values null and undefined are both formatted as null,
an error is thrown when the property doesn't exist at all.
In PostgreSQL stored procedures are just functions that usually do not return anything.
Suppose we want to call function findAudit to find audit records by user id and maximum timestamp. We can make such call as shown below:
db.func('findAudit', [123, new Date()])
.then(function(data){
console.log(data); // printing the data returned
}, function(reason){
console.log(reason); // printing the reason why the call was rejected
});We passed it user id = 123, plus current Date/Time as the timestamp. We assume that the function signature matches the parameters that we passed. All values passed are serialized automatically to comply with PostgreSQL type formats.
Method func accepts optional third parameter - qrm (Query Result Mask), the same as method query.
And when you are not expecting any return results, call db.proc instead. Both methods return a Promise object,
but db.proc doesn't take a qrm parameter, always assuming it is one|none.
Summary for supporting procedures and functions:
db.func(query, values, qrm); // expects the result according to `qrm`
db.proc(query, values); // calls db.func(query, values, queryResult.one | queryResult.none)The library provides several helper functions to convert javascript types into their proper PostgreSQL presentation that can be passed
directly into queries or functions as parameters. All of such helper functions are located within namespace pgp.as, and each function
returns a formatted string when successful or throws an error when it fails.
pgp.as.bool(value); // converts value into PostgreSQL boolean presentation;
pgp.as.number(value);
// converts value into PostgreSQL number presentation,
// with support for NaN, +Infinity and -Infinity;
pgp.as.text(value, raw);
// converts value into PostgreSQL text presentation,
// fixing single-quote symbols and wrapping the result
// in quotes (unless flag 'raw' is set);
pgp.as.date(value, raw);
// converts value into PostgreSQL date/time presentation,
// wrapped in quotes (unless flag 'raw' is set);
pgp.as.json(value, raw);
// converts any value into JSON (using JSON.stringify),
// then fixes single-quote symbols and wraps it up in
// single quotes (unless flag 'raw' is set);
pgp.as.array(value); // converts value-array into PostgreSQL Array Type constructor
// string: array[]
pgp.as.csv(value); // returns a CSV string with values formatted according
// to their type, using the above methods;
pgp.as.func(func, raw, obj);
// calls the function to get the actual value, and then
// formats it according to the returned type + 'raw' flag;
// obj - optional, 'this' context for the function.
pgp.as.format(query, values);
// replaces variables in the query with their 'values' as specified;
// 'values' can be a single value, an array or an object.Version 1.4.1 extended methods bool, number, text, date, json, array
and csv to accept the value-parameter as a function to be called for resolving
the actual value.
For methods which take optional flag raw it is to indicate that the
return text is to be without any pre-processing:
- No replacing each single-quote symbol
'with two; - No wrapping text into single quotes;
- Throwing an error when the variable value is
nullorundefined.
This adheres to the query formatting, as well as method as.format when variable
names are appended with symbol ^: $1^, $2^, etc... or $*varName^*, where *
is any of the supported open-close pairs: {}, (), <>, [], //
As none of these helpers are associated with any database, they can be used from anywhere.
There are some cases where you might want to use a combination of these methods instead of the implicit parameter formatting through query methods. For example, if you want to generate a filter string to be used where applicable, you might use a code like this:
function createFilter(filter){
var cnd = []; // conditions;
if(filter.start){
// add start date condition;
cnd.push(pgp.as.format("start >= $1::date", filter.start));
}
if(filter.end){
// add end date condition;
cnd.push(pgp.as.format("end <= $1::date", filter.end));
}
if(filter.active !== undefined){
// add active flag;
cnd.push(pgp.as.format("active = $1", filter.active));
}
if(filter.name){
// add name-like condition with a raw-text variable
// by appending '^' to its name;
cnd.push(pgp.format("name like '%$1^%'", filter.name));
}
return cnd.join(" and "); // returning the complete filter string;
}When initializing the library, you can pass object options with a set of global properties:
var options = {
// pgFormatting - redirects query formatting to PG;
// promiseLib - overrides default promise library;
// connect - database 'connect' notification;
// disconnect - database 'disconnect' notification;
// query - query execution notification;
// transact - transaction notification;
// error - error notification;
// extend - protocol extension event;
};
var pgp = pgpLib(options);If you want to get the most out the query-related events, you should use pg-monitor.
By default, pg-promise provides its own implementation of the query formatting, supporting the following formats:
- Format
$1, $2, etc, when parametervaluesis either a single value or an array of values; - Format
$*propName*, ifvaluesis an object that's notnulland not aDateinstance, and where*is any of the supported open-close pairs:{},(),<>,[],//
Every query method of the library accepts values as its second parameter.
pg-promise automatically converts all basic javascript types (text, boolean, date, number and null) into their Postgres presentation.
In addition, the library can convert:
- array into Postgres Array Types constructor;
- an object inside array or an object property - into JSON string.
If, however, you want to use query formatting that's implemented by the PG library, set parameter pgFormatting
to be true when initializing the library, and every query formatting will redirect to the PG's implementation.
Although this has a huge implication for the library's functionality, it is not within the scope of this project to detail. For any further reference you should use documentation of the PG library.
Note the following formatting features implemented by pg-promise that are not in node-postgres:
- Single-value formatting: pg-promise doesn't require use of an array when passing a single value;
- Raw-Text support: injecting raw/pre-formatted text values into the query;
- Functions as formatting parameters, with the actual values returned from the callbacks;
- PostgreSQL Array Constructors are used when formatting arrays, not the old string syntax;
- Automatic conversion of numeric
NaN,+Infinityand-Infinityinto their string presentation;
NOTE: Formatting parameters for calling functions (methods func and proc) is not affected by this override.
When needed, use the generic query instead to invoke functions with redirected query formatting.
Set this property to an alternative promise library compliant with the Promises/A+ standard.
By default, pg-promise uses version of Promises/A+ provided by Promise. If you want to override this and force the library to use a different implementation of the standard, just set this parameter to the library's instance.
Example of switching over to Bluebird:
var promise = require('bluebird');
var options = {
promiseLib: promise
};
var pgp = pgpLib(options);Promises/A+ libraries that passed our compatibility test and are currently supported:
- Promise - used by default
- Bluebird
- When
- Q
- RSVP - doesn't have
done(), usefinally/catchinstead - Lie - doesn't have
done()
Compatibility with other Promises/A+ libraries though possible, is an unknown.
Global notification function of acquiring a new database connection.
var options = {
connect: function(client){
var cp = client.connectionParameters;
console.log("Connected to database '" + cp.database + "'");
}
};The function takes only one parameter - client object from the PG library that represents connection
with the database.
The library will suppress any error thrown by the handler and write it into the console.
NOTE: The library will throw an error instead of making the call, if options.connect is set to
a non-empty value other than a function.
Global notification function of releasing a database connection.
var options = {
disconnect: function(client){
var cp = client.connectionParameters;
console.log("Disconnecting from database '" + cp.database + "'");
}
};The function takes only one parameter - client object from the PG library that represents the connection
that's being released.
The library will suppress any error thrown by the handler and write it into the console.
NOTE: The library will throw an error instead of making the call, if options.disconnect is set to
a non-empty value other than a function.
Global notification of a query that's being executed.
var options = {
query: function (e) {
console.log("Query: " + e.query);
if (e.ctx) {
// this query is executing inside a transaction,
// and ctx contains all the relevant details;
}
}
};Notification happens just before the query execution. And if the handler throws an error, the query execution will be rejected with that error.
Parameter e is the event's context object that shares its format between events
query, error and transact. It supports the following properties, all of which
are optional:
cn- connection details, passed only with a connection-relatederrorevent.client- object from the PG library that represents the connection;query- input query string;params- input query parameters;ctx- transaction context object;
A transaction context object (ctx) supports the following properties:
start- start time of the transaction;finish- optional; finish time of the transaction, if it has finished;tag- optional; tag object/value passed into the transaction, if any;success- optional; indicates success for a finished transaction;result- optional; transaction result, if finished: data resolved by the transaction, ifsuccessistrue, otherwise it is set to thereasonthat was passed when rejecting the transaction.
A transaction can be tagged when it is called using the following syntax:
db.tx(tag, cb);i.e. in front of the callback function you can inject a value or object that tags the transaction, so it can be used as a reference when handling events.
All properties of ctx marked as optional are not set, unless they are relevant
to the event.
NOTE: The library will throw an error instead of making the call, if options.query is set to
a non-empty value other than a function.
Global notification of an error during connection, query or transaction.
var options = {
error: function (err, e) {
console.log("Error: " + err);
if (e.cn) {
// this is a connection-related error;
// cn = connection details that were used.
}
if (e.query) {
console.log("Query:", e.query);
if (e.params) {
console.log("Parameters:", e.params);
}
}
if (e.ctx) {
// print transaction details;
}
}
};For parameter e see documentation of the query event earlier.
The library will suppress any error thrown by the handler and write it into the console.
NOTE: The library will throw an error instead of making the call,
if options.error is set to a non-empty value other than a function.
Global notification of a transaction start / finish events.
var options = {
transact: function (e) {
console.log("Start Time: " + e.ctx.start);
if (e.ctx.finish) {
// this is a transaction `finish` event;
console.log("Finish Time: " + e.ctx.finish);
if (e.ctx.success) {
// e.ctx.result = the data resolved;
} else {
// e.ctx.result = the rejection reason;
}
} else {
// this is a transaction `start` event;
}
}
};For parameter e see documentation of the query event earlier.
The library will suppress any error thrown by the handler and write it into the console.
NOTE: The library will throw an error instead of making the call, if options.transact is set to
a non-empty value other than a function.
Override this event to extend the existing access layer with your own functions and properties best suited for your application.
The extension thus becomes available across all access layers:
- Within the root/default database protocol;
- Inside transactions, including nested ones.
In the example below we extend the protocol with function addImage that will insert
one binary image and resolve with the new record id:
var options = {
extend: function (obj) {
obj.addImage = function (data) {
return obj.one("insert into images(data) values($1) returning id",
'\\x' + data);
}
}
};IMPORTANT: Do not override any of the predefined functions or properties in the protocol, as it will break your access object.
It is best to extend the protocol by adding whole entity repositories to it as shown in the following example.
// Users repository;
function repUsers(obj) {
return {
add: function (name, active) {
return obj.none("insert into users values($1, $2)", [name, active]);
},
delete: function (id) {
return obj.none("delete from users where id=$1", id);
}
}
}
// Overriding 'extend' event;
var options = {
extend: function (obj) {
obj.users = repUsers(obj);
}
};
// Usage example:
db.users.add("John", true)
.then(function () {
// user added successfully;
}, function (reason) {
// error occurred;
});The library will suppress any error thrown by the handler and write it into the console.
NOTE: The library will throw an error instead of making the call, if options.extend is set to
a non-empty value other than a function.
When exiting your application, you can make the following call:
pgp.end();This will release pg connection pool globally and make sure that the process terminates without any delay. If you do not call it, your process may be waiting for 30 seconds (default for poolIdleTimeout), waiting for the connection to expire in the pool.
If, however you normally exit your application by killing the NodeJS process, then you don't need to use it.
- Version 1.4.0 added
thiscontext to all callbacks where applicable. Released: May 31, 2015. - Version 1.3.1 extended Named Parameters syntax to support
{},(),[],<>and//. Released: May 24, 2015. - Version 1.3.0 much improved error handling and reporting. Released: May 23, 2015.
- Version 1.2.0 extended Named Parameters syntax with
$(varName). Released: May 16, 2015. - Version 1.1.0 added support for functions as parameters. Released: April 3, 2015.
- Version 1.0.5 added strict query sequencing for transactions. Released: April 26, 2015.
- Version 1.0.3 added method
queryRaw(query, values). Released: April 19, 2015. - Version 1.0.1 improved error reporting for queries. Released: April 18, 2015.
- Version 1.0.0 official release milestone. Released: April 17, 2015.
- Version 0.9.8 added native json support, extended numeric support for
NaN,+Infinityand-Infinity. Released: April 16, 2015. - Version 0.9.7 received support for protocol extensibility. Released: April 15, 2015.
- Version 0.9.5 received support for raw-text variables. Released: April 12, 2015.
- Version 0.9.2 received support for PostgreSQL Array Types. Released: April 8, 2015.
- Version 0.9.0 changed the notification protocol. Released: April 7, 2015.
- Version 0.8.4 added support for error notifications. Released: April 6, 2015.
- Version 0.8.0 added support for named-parameter formatting. Released: April 3, 2015.
- Version 0.7.0 fixes the way
as.formatworks (breaking change). Released: April 2, 2015. - Version 0.6.2 has good database test coverage. Released: March 28, 2015.
- Version 0.5.6 introduces support for nested transaction. Released: March 22, 2015.
- Version 0.5.3 - minor changes; March 14, 2015.
- Version 0.5.1 included wider support for alternative promise libraries. Released: March 12, 2015.
- Version 0.5.0 introduces many new features and fixes, such as properties pgFormatting and promiseLib. Released on March 11, 2015.
- Version 0.4.9 represents a solid code base, backed up by comprehensive testing. Released on March 10, 2015.
- Version 0.4.0 is a complete rewrite of most of the library, made first available on March 8, 2015.
- Version 0.2.0 introduced on March 6th, 2015, supporting multiple databases.
- A refined version 0.1.4 released on March 5th, 2015.
- First solid Beta, 0.1.2 on March 4th, 2015.
- It reached first Beta version 0.1.0 on March 4th, 2015.
- The first draft v0.0.1 was published on March 3rd, 2015, and then rapidly incremented due to many initial changes that had to come in, mostly documentation.
Copyright (c) 2015 Vitaly Tomilov (vitaly.tomilov@gmail.com)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.