node package manager


mongo-utils Build Status

mongo-utils provides a friendly interface to MongoDB's mongodump and mongorestore commands, as well as some utility functions.

Synchronous functions

utils.parseConnectionString connectionString # mongo connection options object 
utils.makeRestoreCommand connectionStringsourceDir # mongorestore ... 
utils.makeDumpCommand connectionStringtargetDir # mongodump ... 

Asynchronous functions

These functions simply wrap child_process.exec in a convenient interface. There is absolutely no validation happening. Thus, the absence of an error (as err argument) does not mean the dump or restore succeeded.

I advise to inspect stdout and stderr yourself if you use this module for any important dumps or restores, or verify the results otherwise.

utils.dumpDatabase connectionStringdirName(err, stdout, stderr) ->
utils.dumpHerokuMongoHQDatabase appNamedirName(err, stdout, stderr) ->
utils.restoreDatabase connectionStringdirName(err, stdout, stderr) ->
utils.dumpHerokuMongoHQDatabase appNamedirName(err, stdout, stderr) ->

The heroku-mongohq functions look up the MONGOHQ_URL environment variable of your Heroku app, using the heroku module.


mongo-utils logs some messages to allow you to see what's going on behind the scenes, primarily when doing the using the dump or restore commands. To see what's being logged, you may assign a log function which takes a single message argument to utils.log. By default, utils.log is a noop.

utils = require "mongo-utils"
utils.log = (msg) -> console.log msg


For the commands to work, you need to have mongorestore and mongodump in your path.
The Heroku-specific commands require a HEROKU_API_KEY environment variable to be set.


mongo-utils is released under the MIT License.
Copyright (c) 2013 Meryn Stol