1.0.2 • Published 7 years ago

mongo-proxy v1.0.2

Weekly downloads
5
License
ISC
Repository
github
Last release
7 years ago

mongo-proxy

Installation

npm install mongo-proxy -S

Use

const mongoProxy = require('mongo-proxy');
mongoProxy(process.env.MONGODB_URI, {
	// Any mongodb connection options
	// ...
	
	// Also some additional options for the module
	collectionSymbol: '$',         // the symbol to distinguish collections from other db object members
	cacheCollections: true,        // whether to cache db.collection() calls or always call it
	cacheCollectionTimeout: 5000   // in milliseconds
}, (err, db) => {
	// Same callback error as the MongoClient.connect callback
	if (err) throw err;
	
	// The following shows why a symbol is necessary
	db.$stats.find({})... // look up in the COLLECTION called 'stats'
	db.stats((err, res) => {...}) // get the stats from the db object

	// Note: ALL the normal functions are accessible on the db object like you would normally.
	// Also, db.collection() works as it always has. 
	// This means you could just drop mongo-proxy into your current project, without anything breaking.
});