npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

bestgres

v0.0.8

Published

A convenience library for postgres in node offering simpler transactions and helpers for creating a database api.

Downloads

5

Readme

Bestgres is a collection of helpers and utilities to make some of the common postgres tasks less horrible!

##Installation

npm install bestgres

##Purpose

node-postgres is excellent and pg-transaction is of course even handier for transactions, but even a small number of database calls utilizing transactions will accumulate cruft quickly:

function updateXandY(data, cb) {
	var tx = new Transaction(client);
	function onErr(err) {
		if (err) {
			tx.rollback('virgin', function(e) {
				cb(err);
			});
		} else {
			tx.commit(cb);
		}
	}
	tx.begin(function(err, result) {
		if (err) return cb(err);
		tx.savepoint('virgin', function(err, result) {
			if (err) return onErr(err);
			/* finally time to do something that isn't plumbing! */
			tx.query(updateX, data, function(err, result) {
				if (err) return onErr(err);
				tx.query(updateY, data, function(err, result) {
					if (err) return onErr(err);
					onErr(null);
				});
			});
		});
	});
}

This is postgres transactions in node at its worst! Not only are we fighting manual error handling, but there is the fear that the majority of this code will be duplicated should another transaction database call be required. Control flow can of course be alleviated with async which will absolve us of our nested sins:

function updateXandY(data, cb) {
	var tx = new Transaction(client);
	async.waterfall([
		function (cb) { tx.begin(cb); },
		function (result, cb) { tx.savepoint('virgin', cb); },
		function (result, cb) { tx.query(updateX, data, cb); },
		function (result, cb) { tx.query(updateY, data, cb); }
	], updateXandY);
}

Phew! A bit cleaner to be sure, but updateXandY still needs to be defined somewhere, and having to tirelessly instantiate a new Transaction plus manually begin the transaction and create a generic savepoint will grow old. How about:

var updateXandY = bestgres.newTransactionMethod([
	function(result, cb) { updateX(this, cb); },
	function(result, cb) { updateY(this, cb); }
]);

No more worrying about any tx objects, inline queries, or even error handling. The redunancy has been eliminate and now you can focus on the steps your transaction needs to take.

Because tx is unavailable and inline queries are thus impossible, bestgres encourages a modular query design where transactions depend on focused, individual queries that can be more easily tested.

this in your passed functions will be bound to the data parameter of the database method returned by bestgre.newTransactionMethod.