Skip to content
This repository has been archived by the owner on Oct 14, 2019. It is now read-only.

obfusk/active-dump

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 

[]: {{{1

File        : README.md
Maintainer  : Felix C. Stegerman <flx@obfusk.net>
Date        : 2014-08-12

Copyright   : Copyright (C) 2014  Felix C. Stegerman
Version     : v0.2.3

[]: }}}1

Gem Version

Description

[]: {{{1

active-dump - dump and restore activerecord from/to yaml

active-dump provides 3 rake tasks that allow you to dump and restore activerecord data from/to yaml:

  • rake db:data:dump creates a yaml dump
  • rake db:data:restore restores a yaml dump
  • rake db:data:delete deletes all records in database
  • rake db:data:fix_seqs fixes (postgresql) sequences

NB: active-dump does not take migrations (or validations etc.) into account -- it dumps and restores raw data from the ActiveRecord models -- so make sure your migrations are in sync.

When using rails, add this to your Gemfile:

gem 'active-dump', require: 'active-dump/rails'

[]: {{{2

You can use these environment variables to configure active-dump:

  • RAILS_ENV: the environment
  • FILE: the file to dump to/restore from (defaults to db/data.yml)
  • MODELS: the models to dump (defaults to all models)
  • DELETE: delete records with same id before restore (defaults to false)
  • VERBOSE: print info/sql (defaults to false)
  • DRYRUN: don't do anything (defaults to false, implies VERBOSE)

Configuration files:

  • config/active-dump.yml: set defaults
  • config/database.yml: database connection

[]: }}}2

[]: }}}1

Examples

[]: {{{1

$ rake db:data:dump MODELS=Foo,Bar
$ RAILS_ENV=production rake db:data:restore
$ rake db:data:restore DELETE=yes
$ rake db:data:delete   # CAREFUL!

config/active-dump.yml:

file: db/dump.yml
verbose: true
models:
  - Cms::Block
  - Cms::Categorization
  - Cms::Category
  - Cms::File
  - Cms::Layout
  - Cms::Page
  - Cms::Revision
  - Cms::Site
  - Cms::Snippet

[]: }}}1

Specs & Docs

$ rake spec   # TODO
$ rake docs

TODO

  • specs! docs?
  • use model's database connection?!
  • ...

License

LGPLv3+ [1].

References

[]: {{{1

[1] GNU Lesser General Public License, version 3 --- http://www.gnu.org/licenses/lgpl-3.0.html

[]: }}}1

[]: ! ( vim: set tw=70 sw=2 sts=2 et fdm=marker : )

About

active-dump - dump and restore activerecord from/to yaml

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages