mongo-handler

0.3.1 • Public • Published

mongo-handler, a simple MongoDB wrapper module


This module was written to negate the need for redundant error and null checks when writing MongoDB queries in Node. Each function has one callback argument that can either be an object or null (error).
Importing

You must pass the Mongo URL when initializing the module, in this format mongodb://host:port/database

var mongo = require('mongo-handler')('mongodb://localhost:27017/myAwesomeDatabase');

Insert

Insert a new document into a collection, document must be an object.

mongo.insertDocument('collectionName', document, function(result) {
  console.log('Inserted!');
});

e.x

mongo.insertDocument('Users', { firstName : 'John', lastName : 'Doe' }, function(result) {
  console.log('Inserted a mew user document!');
});

Find

Find all documents that contain the where argument. where must be an object, if the object is empty all documents will be returned.

mongo.findDocuments('collectionName', where, function(docs) {
  console.log('Documents:', docs);
});

e.x

mongo.findDocuments('Users', { firstName : 'Bob' }, function(docs) {
  console.log('Documents with firstName = Bob ', docs);
});

Update

Update all documents that contain the where argument. where must be an object, if the object is empty all documents will be updated.

mongo.updateDocument('collectionName', where, new, function(result) {
  console.log('Updated!');
});

e.x

mongo.updateDocument('Users', { firstName : 'Bob' }, { firstName : 'John' }, function(result) {
  console.log('Updated name of Bob to John.');
});

Delete

Delete the first document that contains the where argument. (Note: this function only removes one document)

mongo.deleteDocument('collectionName', where, function(result) {
  console.log('Deleted!');
});

e.x

mongo.deleteDocument('Users', { firstName : 'Bob' }, function(result) {
  console.log('Deleted the a document with firstName = Bob');
});

Find and Sort

Find documents using where (same as findDocuments) then sort using the sortBy object. sortBy should contain the key to sort by and a 1 or -1 for ascending or descending, respectively.

mongo.findAndSort('collectionName', where, sortBy, function(docs) {
  console.log('Sorted Documents:', docs);
});

e.x

mongo.findAndSort('Users', {}, { age : -1 }, function(docs) {
  console.log('All users sorted from oldest to youngest:', docs);
});

Readme

Keywords

none

Package Sidebar

Install

npm i mongo-handler

Weekly Downloads

0

Version

0.3.1

License

ISC

Last publish

Collaborators