monk

monk

Monk is a tiny layer that provides simple yet substantial usability improvements for MongoDB usage within Node.JS.

var db = require('monk')('localhost/mydb');
var users = db.get('users');
 
users.index('name last');
users.insert({ name: 'Tobi', bigdata: {} });
users.find({ name: 'Loki' }, '-bigdata', function () {
  // exclude bigdata field 
});
users.find({}, {sort: {name: 1}}, function () {
  // sorted by name field 
});
users.remove({ name: 'Loki' });
 
db.close();
  • Command buffering. You can start querying right away.
  • Promises built-in for all queries. Easy interoperability with modules.
  • Easy connections / configuration
  • Well-designed signatures
  • Improvements to the MongoDB APIs (eg: findAndModify supports the update signature style)
  • Auto-casting of _id in queries
  • Builds on top of mongoskin
  • Allows to set global options or collection-level options for queries. (eg: safe is true by default for all queries)
var db = require('monk')('localhost/mydb')
var db = require('monk')('localhost/mydb,192.168.1.1')
db.close()
var users = db.get('users')
// users.insert(), users.update() … (see below) 
users.drop(fn);
  • All commands accept the simple data[, …], fn. For example
    • find({}, fn)
    • findOne({}, fn)
    • update({}, {}, fn) findAndModify({}, {}, fn)
    • findById('id', fn)
    • remove({}, fn)
  • You can pass options in the middle: data[, …], options, fn
  • You can pass fields to select as an array: data[, …], ['field', …], fn
  • You can pass fields as a string delimited by spaces: data[, …], 'field1 field2', fn
  • To exclude a field, prefix the field name with '-': data[, …], '-field1', fn

All methods that perform an async action return a promise.

var promise = users.insert({});
promise.type; // 'insert' in this case 
promise.error(function(err){});
promise.on('error', function(err){});
promise.on('success', function(doc){});
promise.on('complete', function(errdoc){});
promise.success(function(doc){});
users.index('name.first', fn);
users.index('email', { unique: true }); // unique 
users.index('name.first name.last') // compound 
users.index({ 'email': 1, 'password': -1 }); // compound with sort 
users.index('email', { sparse: true }, fn); // with options 
users.indexes(fn); // get indexes 
users.dropIndex(name, fn); // drop an index 
users.dropIndexes(fn); // drop all indexes 
users.insert({ a: 'b' }, function (errdoc) {
  if (err) throw err;
});

To cast to ObjectId:

users.id() // returns new generated ObjectID 
users.id('hexstring') // returns ObjectId 
users.id(obj) // returns ObjectId 
users.update({}, {}, fn);
users.updateById('id', {}, fn);
users.find({}, function (errdocs){});
users.findById('hex representation', function(errdoc){});
users.findById(oid, function(errdoc){});

findOne also provides the findById functionality.

users.findOne({ name: 'test' }).on('success', function (doc) {});
users.findAndModify({ query: {}, update: {} });
users.findAndModify({ _id: '' }, { $set: {} });

Note: stream: true is optional if you register an each handler in the same tick. In the following example I just include it for extra clarity.

users.find({}, { stream: true })
  .each(function(doc){})
  .error(function(err){})
  .success(function(){});

On the returned promise you can call destroy(). Upon the cursor closing the success event will be emitted.

users.remove({ a: 'b' }, function (err) {
  if (err) throw err;
});
var db = require('monk')('localhost/mydb')
db.options.multi = true; // global multi-doc update 
db.get('users').options.multi = false; // collection-level 

Monk sets safe to true by default.

If you wish to see what queries monk passes to the driver, simply leverage debug:

DEBUG="monk:queries"

To see all debugging output:

DEBUG="monk:*"

(The MIT License)

Copyright (c) 2012 Guillermo Rauch <guillermo@learnboost.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.