node-mongodb-wrapper

Node MongoDB Wrapper

This package greatly simplifies working with MongoDB and Node MongoDB Native.

It removes a lot of the callback madness and provides a simple shorthand for common operations. This was used in production at Playtomic as part of a high-volume api server.

It has a rudimentary caching layer that can greatly minimize round trips to the database without introducing 3rd party dependencies, although the cache is thread-specific so multiple instances/workers/whatever will each have their own.

Requires

1. MongoDB has to be running somewhere.
2. Node MongoDB Native and NodeJS

How to use

1. git clone https://github.com/benlowry/node-mongodb-wrapper
2. cd node-mongodb-wrapper
3. see tests for examples

or just npm install node-mongodb-wrapper

Methods

Node MongoDB Wrapper provides methods for:

1. get performs a find() with optional caching
2. getAndCount performs a find() + count() with optional caching
3. getOrInsert performs a find() and inserts if not exists
4. aggregate performs an aggregate()
5. aggregateAndCount, performs an aggregate and a second aggregate for counting
6. count performs a count() with optional caching
7. insert performs a save()
8. update performs an update()
9. move performs a save(doc) on new collection then remove(doc) on old
10. remove performs a remove()

Examples

A complete suite of examples is available in the included test.js file.

var query = {filter: {x: 1, y: 2, z: 3}, cache: true, cachetime: 60};
db.get("test", "stuff", query, function(error, items) {
    console.log("huzzah!");
});

or (see shorthand note below)

db.test.stuff.get(query, function(error, items) {
	 console.log("huzzah!");
});

In that short example "test" is one of our configured database's names:

var databases = {
    test: {
        address: "127.0.0.1",
        port: 27017,
        name: "test", // your db and this object's name must match
		//username: "optional",
		//password: "optional"
    }
}

We're passing an object that contains a nested filter object which is the query criteria and is exactly as you would use directly, it also supports limit, sort and skip in the outer object. The query is marked as cacheable and will store the results for 60 seconds.

Shorthand

I saw this on mongode and thought it looked super cool, so I copied the idea.

You can use traditional db.databasename.collectionname.method as well now to save on the parameter overload. This also has the benefit of making sure your collection names are strict.

The only bad bit is you have to predefine the collection names because JavaScript has no 'catch all' property which is unfortunate, but you can do it in 3 ways and if a collection is already defined it will just skip doing it again.

db.databasename.collection("acollection");
db.databasename.collections(["an", "array", "of", "collections"]);
db.databasename.collections(callback);

The final example will query your database and create the shorthand path for any collection names without dots (eg no system.indexes).

The callback has only an error parameter so you know if it worked or not, this is an async operation and you cannot use the shorthand until it is complete.

Databases

You can either define your databases inside the included mongo-wrapper.js or pass a same-structured object as above via db.setDatabases(dblist).

Configuration

You can enable or disable some functionality:

var db = require("node-mongodb-wrapper");

// caching lets you store  results from get, getAndCount, count ops
db.cacheEnabled = true;
db.defaultCacheTime = 60;

Why

Because without this you end up with too much boilerplate and nesting:

var db = new Db("local", new Server("127.0.0.1", 27017));
db.open(function(error, connection) {
	
	if(error) {
		console.log("error: " + error);
		return;
	}
	
    connection.authenticate(username, password, function(error) {
		
		if(error) {
			console.log("error2: " + error);
			return;
		}
		
        var collection = new mongodb.Collection(connection, "stuff");
        collection.find({x: 1, y: 2, z: 3}, function(error, items) {
			
			if(error) {
				console.log("error3: " + error);
				return;
			}
			
            console.log("huzzah!");
        });
    });
});

License

Copyright Ben Lowry 2012. Licensed under the MIT license. Certain portions may come from 3rd parties and carry their own licensing terms and are referenced where applicable.