Skip to main content

Database Backup Command Line Utility

Project description

https://circleci.com/gh/level12/worek.svg?style=shield https://codecov.io/gh/level12/worek/branch/master/graph/badge.svg

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

Changelog

0.1.1 released 2021-02-01

  • Allow PG client executable version to be specified (abff603)

0.1.0 released 2019-04-03

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

worek-0.1.1.tar.gz (15.1 kB view hashes)

Uploaded source

Built Distribution

worek-0.1.1-py2.py3-none-any.whl (16.5 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page