Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A gem to use Rails Database Migrations in non Rails projects
Ruby

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib/tasks
spec
vendor/migration_helpers
.gitignore
README.markdown
Rakefile
VERSION
standalone_migrations.gemspec

README.markdown

Rails migrations in non-Rails (and non Ruby) projects.

USAGE

Install Ruby, RubyGems and a ruby-database driver (e.g. gem install mysql) then:

sudo gem install standalone_migrations

Add to Rakefile in your projects base directory:

begin
  require 'tasks/standalone_migrations'
  MigratorTasks.new do |t|
    # t.migrations = "db/migrations"
    # t.config = "db/config.yml"
    # t.schema = "db/schema.rb"
    # t.sub_namespace = "dbname"
    # t.env = "DB"
    # t.verbose = true
    # t.log_level = Logger::ERROR
  end
rescue LoadError => e
  puts "gem install standalone_migrations to get db:migrate:* tasks! (Error: #{e})"
end

Add database configuration to db/config.yml in your projects base directory e.g.:

development:
  adapter: sqlite3
  database: db/development.sqlite3
  pool: 5
  timeout: 5000

production:
  adapter: mysql
  encoding: utf8
  reconnect: false
  database: somedatabase_dev
  pool: 5
  username: root
  password:
  socket: /var/run/mysqld/mysqld.sock

test: &test
  adapter: sqlite3
  database: db/test.sqlite3
  pool: 5
  timeout: 5000

To create a new database migration:

rake db:new_migration name=FooBarMigration
edit db/migrations/20081220234130_foo_bar_migration.rb

... and fill in the up and down migrations Cheatsheet.

If you really want to, you can just execute raw SQL:

def self.up
  execute "insert into foo values (123,'something');"
end

def self.down
  execute "delete from foo where field='something';"
end

Even better, you can use the generate task to create the initial migration

The general form is:

rake db:generate model="model_name" fields="type:column_name0 type:column_name1 ... type:column_namen"

You can have as many fields as you would like.

An example to create a Person table with 3 columns (and it will automatically add the t.timestamps line)

rake db:generate model="Person" fields="string:first_name string:last_name integer:age"

This will create a migration in db/migrations/

class CreatePerson < ActiveRecord::Migration
  def self.up
    create_table :Person do |t|
      t.string :first_name
      t.string :last_name
      t.integer :age   
      t.timestamps
    end
  end

  def self.down
    drop_table :Person
  end
end

To apply your newest migration:

rake db:migrate

To migrate to a specific version (for example to rollback)

rake db:migrate VERSION=20081220234130

To migrate a specific database (for example your "testing" database)

rake db:migrate DB=test

To execute a specific up/down of one single migration

rake db:migrate:up VERSION=20081220234130

Sub-namespacing

When working with multiple databases in a single application it is convenient to have separate sets of tasks for each database. This is accomplished with sub_namespace parameter - for example, given the following declaration:

MigratorTasks.new do |t|
  t.migrations = "db/migrate/widgets"
  t.sub_namespace = "widgets"
  ...
end

The following tasks will be created:

db:widgets:new_migration
db:widgets:migrate
...

And migrations for this database would be created in db/migrate/widgets subdirectory.

Contributors

This work is originally based on Lincoln Stoll's blog post and David Welton's post.

Something went wrong with that request. Please try again.