node-migrate-redis

Migrations for Redis

A port of node-migrate-mongo with storage of past migrations in Redis instead of MongoDB.

node-migrate-redis enables data migrations in your existing project. The state of your migrations is stored in a redis set called 'migrations'. See the Usage section (and let's be honest: the code) for more information.

Despite the name, this module does not borrow from TJ's node-migrate, though it follows very similar conventions.

Usage

In your existing project where you'd like to have migrations:

yarn add --save node-migrate-mongo
cat << EOF- > Migratefile.coffee
  module.exports =
    redis: 'redis://localhost:6379'
    redisAuth: 'secret'
EOF
migrate generate --name my_first_migration
# edit it
migrate all

Migratefile Options

• beforeTest -- An async function called before running a migration test. By default sets NODE_ENV=test.
• before -- An async function called before running a command. Useful for connecting your app to its database.
• after -- An async function called after running a command.
• afterTest -- An async function called after running a migration test.
• redis -- A string or function that returns a redis connection URL.
• path -- The place to store your migration files. Defaults to migrations.
• ext -- The extension for your migration files. Defaults to coffee.
• template -- The template used when generating migrations.

before/after callbacks are called in this order: [ beforeTest, before, after, afterTest ]

Contributing

Please follow our Code of Conduct when contributing to this project.

$ git clone https://github.com/goodeggs/node-migrate-mongo && cd node-migrate-mongo
$ yarn
$ yarn test

Module scaffold generated by generator-goodeggs-npm.