PG Clone
This is a dead simple Postgres/Heroku cloning gem, to make it easier to clone your production database locally.
Installation
Add this line to your application's Gemfile:
gem 'pgclone'
And then execute:
$ bundle
Usage
The gem is usable either from the command line or from your Rails app.
Command Line
Just call pgclone
with the required arguments specified (or -h
for more info). Those arguments are --appname
(-a
- your Heroku appname), --owner
(-o
- the local database owner), and --local-db
(-l
- the local database name). PG Clone will take care of the rest:
$ pgclone -a my-heroku-app -o my-db-owner-username -l app_development
In Rails App
Set the mandatory configuration options in a config file:
# config/initializers/pgclone.rb
Pgclone.configure do |config|
config.appname = 'my-heroku-app'
config.owner = 'my-db-owner-username'
config.local_db = 'app_development'
config.file = 'temporary-dumpfile.dump' # optional
end
Then pull the data from your app like so:
Pgclone::Restore.new.go!
Or call directly with an options hash:
Pgclone::Restore.new({ appname: 'whatever' }).go!
Development
After checking out the repo, run bin/setup
to install dependencies. Then, 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
to create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
- Fork it ( https://github.com/sashafklein/pgclone/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request