Project

actual_db_schema

0.04

Data Migration

There's a lot of open issues
actual_db_schemawidefix/actual_db_schemaHomepageDocumentationSource CodeBug TrackerWiki
Switching between branches with migrations and running them can make your DB inconsistent and not working in another branch if not roll the migration back. Install this gem and forget about that issue by running the standard rake db:migrate.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 Popularity
Downloads
15,290
Stars
116
Forks
2
Watchers
1
 Releases
Current version
0.4.0
Total releases
4
First release
2022-10-16
Latest release
2023-07-05
 Issues
Open Issues
8
Closed Issues
3
Total Issues
11
Issue Closure Rate
27%
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
0
Merged Pull Requests
16
Pull Request Acceptance Rate
94%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2022-12-13
Reverse Dependencies
0

 Dependencies

Runtime

activerecord
>= 0
 Project Readme

Gem Version

ActualDbSchema

Keep Rails DB schema consistent while switching between branches with no additional actions.

Installation

Add this line to your application's Gemfile:

group :development do
  gem "actual_db_schema"
end

And then execute:

$ bundle install

Usage

TLTR; Just run rails db:migrate inside the current branch.

In branch A I add a mandatory (not null) field into DB via migration and run it. Then I switch to another branch B. This branch's code is not aware of that field. As the result, the code is failing with an error "null value provided for non-null field". Moreover, a DB rake task generates a diff on schema.rb that's not relevant to this branch. I can switch to branch A and roll back the migration, but I need to remember that branch or waste time on it.

Some example of this error:

 ActiveRecord::NotNullViolation:
   PG::NotNullViolation: ERROR:  null value in column "log" of relation "check_results" violates not-null constraint
   DETAIL:  Failing row contains (8, 46, success, 2022-10-16 21:47:21.07212, 2022-10-16 21:47:21.07212, null).

This gem saves all run migrations inside tmp/migrations folder. Every run of schema dump (that's a dependency of db:migrate task as well) rolls back the "unknown" for the current branch migrations looking into the tmp/migrations folder.

You just need to run rails db:migrate in the current branch to actualize the DB schema. With its hand, you will never have wrongly generated schema.rb.

Warning
This solution implies that all migrations are reversible. The cases with irreversible migrations should be solved manually. At the moment, these migrations are ignored by the gem and you will see a warning if some migrations can't roll back automatically.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/widefix/actual_db_schema. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the ActualDbSchema project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.