level12 / worek

A database backup tool

Worek - A Database Backup Tool

Introduction

A logical database backup tool.

• Create full binary backups of a PostgreSQL database
• Restore a text or binary backup of a PostgreSQL database
• Can restore a database over the top of an existing database (clears all data first) meaning you don't need a super user to restore a database.

Usage

Create a backup with the contents going to a file

$ worek backup -d database_name -f ./backup.bin

Create a backup with the contents going to STDOUT

$ worek backup -d database_name \
    | openssl enc -aes-256-cbc -pass file:password.txt -md sha256 -d -out backup.bak.enc

Restore a backup from STDIN. Note you have to use the -F property to specify the type of backup you are handing. This is not required when using -f and specifying the file path.

$ openssl enc -aes-256-cbc -pass file:password.txt -md sha256 -d -in backup.bak.enc  \
    |  worek restore -h localhost -d database_name -F c

Supports standard PG environment variables

$ PGPORT=5432 worek backup -d database_name -f ./backup.bin

Worek makes use of Postgres client utilities internally to create/restore backups. If multiple versions of the utilities are present, by default Worek will attempt to match the version of the utilities to the database server version. You may also specify a particular version of the client utilities to use via the --version or -v option. This feature requires pg_wrapper to be installed on the system.

$ worek backup -d database_name -f ./backup.bin -v 11

worek's Issues

Throw cleaner error message when database doesn't exist

If the database doesn't exist it throws a python exception, this should throw something a little more useful.

Setup and deploy Sphinx Documentation

Look at Keg Storage as the example. Submit to Team B / NZ for review.

Support S3 Backup and Restore Locations

• The CLI and core functions should take s3:// urls and properly back up to that location

Allow callers to specify version of PG utilities

Currently worek only uses the most recent version of the Postgres utility executables to create backups. This can cause problems when multiple versions of Postgres are installed.

Provide a CLI option that will allow the user to specify the version of the utilities to use or get the version of the connected DB backend and attempt to use the matching executables