npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mongodb-migrator

v0.9.0

Published

**Table of Contents**

Downloads

4

Readme

mongodb-migrator

Table of Contents

Installation

$ npm install -g mongodb-migrator

CLI usage

The package installs a single CLI executable — mdbmigrator.

When installing locally to your project this executable can be found at ./node_modules/.bin/mdbmigrator.

When installing globally the executable should automatically become accessible on your PATH.

Configuration

The configuration can be passed as a file (js or json):

// myconfig.json
{
  "mongourl": "mongodb://localhost:27017/migrations",
  "host": "localhost",
  "port": 27017,
  "db": "migrations",
  "user": "username",
  "password": "secret_password",
  "collection": "migrations_track",
  "directory": "migrations"
}
  mdbmigrator --config myconfig.json create mynewmigration

or cli arguments:

  mdbmigrator --host 127.0.0.1 --port 27017 --db migrations create newmigrationname

Creating Migrations

The app simplifies creating migration stubs by providing a command

$ mdbmigrator create 'migration name'

This creates file migration-name.js inside of the directory defined in the configuration file.

Sample migration file

  module.exports = {
    name: 'migration name',
    after: null
    up: function (db, cb) {
      cb();
    },
    down: function (db, cb) {
      cb();
    }
  }

Where

  • migration name — a unique name for migration.
  • up — a function used for forward migration.
  • down — a function used for backward migration.

Migration functions

The up and down functions take for two parameters db - mongodb connection and callback cb

up: function(db, cb) {
  db.collection('users').insertOne({name:"firstadmin",pass:"very_secure_password"}, function (err, result) {
    if(err) return cb(err);
    console.log("all done");
    cb();
  });
}

Running migrations

Applying all new migrations from the directory (specified in Configuration) by calling

$ mdbmigrator apply

Rollbacks are automatically called in the reverse order when an error occurs.

The library only runs migrations that:

  1. have up function defined,
  2. were not ran before against this database.
  3. were rollback at any moment

Successfully applied migrations are recorded in the collection specified in Configuration and successfully canceled migrations remove the record from the collection.

The migration process is stopped instantly if some migration fails (returns error in its callback), then beginning roll back process.

Check for new migrations

$ mdbmigrator check

Programmatic usage

The library also supports programmatic usage.

Start with require'ing it:

var MongoMigrator = require('mongodb-migrator');

var migrator = new MongoMigrator(options);

Using migrator

Next, you can use migrator instance as was described before:


// Load all migrations
var migrationsArray = migrator.loadMigrations();

// Check for circularity's and count new migrations
migrator.check();

// Apply new migrations
migrator.apply();