Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A Python database dump tool with chainable post processors, all specified in a configuration file.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 dumpy
Octocat-spinner-32 .gitignore
Octocat-spinner-32 README.rst
README.rst

dumpy

Dumpy is a Python database backup script that uses configuration files to specify databases to backup and options. Backup scripts are classes which define a backup method.

Each BackupBase subclass returns a NamedTemporaryFile object. It's up to any post processors to use this object in any way (e.g. copy it to another location on the file system).

Post processors can be chained and all take the form:

MyPostProcessor().process(file)

If the post process doesn't alter the file passed in it should return it unchanged.

Example configuration file

The following is an idea of what the configuration file, located at ~/.dumpy.cfg might look like. This is very likely to change:

[database db1]
type = mysql
name = dbname1
user = db1
password = db1
postprocessing = TimestampRename, PrependDatabaseName, Bzip, FileSystemCopy, S3Copy

[database db2]
type = postgresql
name = dbname2
user = db2
password = db2
postprocessing = TimestampRename, PrependDatabaseName, Bzip, FileSystemCopy, RotateFiles

[mysqldump options]
path = /opt/local/lib/mysql5/bin/mysqldump
flags = -Q --opt --compact

[pg_dump options]
path = /opt/local/lib/postgresql83/bin/pg_dump

[TimestampRename options]
format = %%Y%%m%%d

[Bzip options]
path = /usr/bin/bzip2

[S3Copy options]
access_key = access_key
secret_key = secret_key
bucket = bucket
prefix = path/to/directory

[FileSystemCopy options]
directory = /path/to/directory/

[RotateFiles options]
directory = /path/to/directory/
number = 5

Status

Beta. This is working and being used as a backup on a few systems but likely has bugs.

Motivation

I've written my last database dump and backup script that I want to. My hope is that this will be a general and feature rich backup script that's easily extendable and will work across multiple databases and backup schemes.

Installation

Download dumpy and put the dumpy module on your Python path. A way to quickly test dumpy might be:

$ git clone git://github.com/robhudson/dumpy.git
$ cd dumpy
$ export PYTHONPATH=$PYTHONPATH:`pwd`

Create a config file like the one above in your home directory named .dumpy.cfg.

To run the dumper.py command:

$ python /path/to/dumper.py

The dumper.py command takes the following options:

-h, --help Display help information
-D DATABASE, --database=DATABASE
  Dump only the specified database with matching config name
-v, --verbose Display logging output
-a, --all-databases
  Dump all databases in the configuration file

Setting up a cron job

TODO

Something went wrong with that request. Please try again.