Osmosis

A versatile database utility library that streamlines common tasks like exporting and importing data.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add osmosis

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install osmosis

Usage

Osmosis provides you with different rake tasks that simplify the management of your database.

Database import

The import command will ask you for a .dump file and restores it to the PostgreSQL database. Any pre-existing data is dropped.

bundle exec rails db:import

Database export

The export command will ask you for a .dump file and exports the PostgreSQL database into the file. If the file already exists, it is overwritten.

bundle exec rails db:export

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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/code-fabrik/osmosis.

License

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