Search code examples
ruby-on-railsgitworkflowschema.rb

What is the preferred way to manage schema.rb in git?


I don't want to add schema.rb to .gitignore, because I want to be able to load a new database schema from that file. However, keeping it checked in is causing all sorts of spurious conflicts that are easily resolved by a fresh db:migrate:reset.

Basically I want a way to:

  1. Keep schema.rb in the repository for deploy-time database setup
  2. Keep schema.rb in '.gitignore' for general development

There would be one or two people responsible for updating schema.rb and knowing that it was correct.

Is there a way I can have my cake and eat it, too?


Solution

  • What has worked really well for me is to delete and .gitignore schema.rb and then have it regenerated for each developer when they rake db:migrate.

    You can still achieve what you wanted without migrating from 0 and risking broken migrations from years ago by simply doing a "roll-up" of the migrations periodically. You can do this by:

    1. Run all outstanding migrations with rake db:migrate
    2. Taking the contents of your schema.rb in the ActiveRecord::Schema.define block
    3. Paste it into your initial_schema migration inside def up (overwriting what's already there)
    4. Delete all other migrations

    Now your initial_schema migration is your starting point for new systems and you don't have to worry about conflicts in schema.rb that may not be resolved correctly. It's not magical, but it works.