https://github.com/rumpl/migrate

Node database migration tool
https://github.com/rumpl/migrate

Last synced: 15 days ago
JSON representation

Node database migration tool

• Host: GitHub
• URL: https://github.com/rumpl/migrate
• Owner: rumpl
• Created: 2013-03-04T22:33:54.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2013-03-19T16:19:28.000Z (almost 12 years ago)
• Last Synced: 2024-11-25T01:25:11.284Z (3 months ago)
• Language: JavaScript
• Homepage: http://rumpl.github.com/migrate/
• Size: 313 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Node migrate

Node migrate is a database migration tool inspired by Ruby on Rails migrations.

It will soon work for mysql, pgsql and sqlite.

[![build status](https://secure.travis-ci.org/rumpl/migrate.png)](http://travis-ci.org/rumpl/migrate)

# Intallation

Not yet released but it will be as easy as `npm`:

```bash

npm install migrate -g

```

# Usage

**Not working yet**

To create a new migration file simply run:

```

migrate create 

```

To execute the migrations:

```

migrate update

```

Or just execute `migrate` without any parameters to see the full list of commands and options.

# Creating migrations

When you create a new migration file, it will look something like this :

```javascript

change(function (shema) {

    // Your code here

});

```

With `schema` you can do any of the following transformations:

 * `schema.createTable`

 * `schema.dropTable`

 * `schema.addColumn`

 * `schema.addIndex`

 * `schema.removeColumn`

 * `schema.removeIndex`

Here is what a migration migth look like :

```javascript

module.exports.change = function (schema) {

  schema.addTable('test', function (table) {

    table.addColumn('id', 'int', {primary: true});

    table.addColumn('name', 'string');

    table.addColumn('description', 'text');

    table.addColumn('num_added', 'int', {'null': false, 'default': 0});

    table.addColumn('num_modified', 'integer', {'references': {'table': 'toto', 'column': 'toto'}});

    table.addColumn('creation_date', 'date');

    table.addColumn('modification_date', 'date');

    table.addIndex('idx_added', 'description', {'type': 'unique'});

  });

};

```

This migration will create a new table called `test` with all the listed columns.

# License

[MIT](http://mit-license.org/rumpl)