https://github.com/sashafklein/pgclone
A simple tool for cloning a production database to local.
https://github.com/sashafklein/pgclone
Last synced: 2 months ago
JSON representation
A simple tool for cloning a production database to local.
- Host: GitHub
- URL: https://github.com/sashafklein/pgclone
- Owner: sashafklein
- Created: 2015-11-03T20:55:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-11-04T01:14:26.000Z (over 9 years ago)
- Last Synced: 2025-03-11T11:06:16.762Z (3 months ago)
- Language: Ruby
- Size: 152 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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:
```ruby
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:
```bash
$ 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:
```ruby
# 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:
```ruby
Pgclone::Restore.new.go!
```
Or call directly with an options hash:
```ruby
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](https://rubygems.org).
## Contributing
1. Fork it ( https://github.com/sashafklein/pgclone/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request