md

migrate-database

A CLI for database migrations in Node.js

Showing:

Popularity

Downloads/wk

0

GitHub Stars

34

Maintenance

Last Commit

4yrs ago

Contributors

6

Package

Dependencies

3

License

Type Definitions

Tree-Shakeable

No?

Categories

Readme

migrate-database

A grunt task for database migration in Node.JS It has started as a fork of node-migrate, but has rebuilt from scratch, and it's heavily inspired on Rails migrations style.

Why migrate-database?

  1. Because the currently most popular node migrate library was forgot in time, with many issues opened and unsolved, since TJ is no longer envolved with node.js modules.
  2. It uses grunt for the CLI, which is far better than inject bins inside npm node modules.
  3. It uses yours database to store migrate histories, avoiding a bunch of possible issues
  4. It uses timestamp in migration's name, good bye merge pain.
  5. It was designed to plug any database through adapters.

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install migrate-database --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('migrate-database');

The "migrate" task

Overview

In your project's Gruntfile, add a section named migrate to the data object passed into grunt.initConfig().

grunt.initConfig({
  migrate: {
    path: 'migrations/',
    adapter: 'MongoDB',
    initializerPath: '',
    db: {
      host: '127.0.0.1',
      port: 27017,
      database: 'migrate',
      collection: 'schema_migrations'
    }
  }
});

Usage

Creating migrations

Creates a new migration inside the migrate.path destination

$ grunt migrate:create --name migrations_name

The created migration will contain the following template structure:

exports.up = function (next) {
  next(new Error('Not implemented'));
};

exports.down = function (next) {
  next(new Error('Not implemented'));
};

Running migrations up

Runs all the pending migrations. You can pass the --steps argument to limit the number of migrations to run.

$ grunt migrate:up

Running migrations down

Rollbacks the last migration You can pass --steps argument to limit the number of migrations to run.

$ grunt migrate:down

Initializer

You can define a initializer file which will be loaded before any task. Usefull for things like connect to your database before run your migrations.

Just define your initializer path inside your Gruntfile:

grunt.initConfig({
  migrate: {
    initializerPath: 'config/migrate'
  }
});

The library does not support my database!

Fear nothing, It's pretty simple to implement a new adapter, just follow the existing mongodb adapter methods. Feel free to create a new adapter and pull-request it.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

0.1.5 / 2014-12-22

  • Used grunt for the CLI
  • Used database for store migrate histories
  • Used timestamp for migrations name
  • Fixed error handler
  • Cloned node-migrate

License

(The MIT License)

Copyright (c) 2014 Eric Saboia esaboia@gmal.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.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial