A little Go app that takes a full backup of a Postgres cluster and uploads it to S3.
temback --help
env PGHOST=postgres.example.org PGUSER=postgres PGPASSWORD=XXXXXXX \
temback --name example-backupThis will create a directory named example-backup that contains:
README.md: A brief description of the backup, including the host name, timestamp, and Postgres version, plus brief instructions to restore.roles.sql: A dump of all the database rolestablespaces.sql: A dump of all the tablespaces- Directories starting with
db-for each database, containing the output of thepg_dumpdirectory format.
The --text option instead dumps each database as a plain text file named
db-$db_name.sql.
To push to S3, authenticate to S3 with the appropriate profile then pass
--bucket with the unique bucket name.
With --compress or --bucket, the backup directory will be archived as a
tarball named example-backup.tar.gz. The --bucket option uploads this
tarball to the specified S3 bucket.
To restore this backup to a Postgres cluster running the same or later version
of Postgres as the original, change into the backup directory, then execute
these commands (assuming a superuser named postgres):
PGUSER=postgres
psql -f roles.sql
psql -f tablespaces.sql
pg_restore -j 8 -f db-postgres
pg_restore -C -j 8 -f db-appUse -C to create a database before restoring it. Modify the -j option to
change the number of parallel jobs restoring each database.
For a backup made with --text, use psql to restore the databases:
for dir in db-*; do psql -f "$dir"; donePlain text backups do not support parallel restores.
--name: The name of the backup; required--cd: Directory to switch into to generate the backup files--bucket: Upload to the named S3 bucket--dir: Upload to the named S3 subdirectory--compress: Compress into a tarball (ignored with--bucket)--host: The Postgres host name; defaults toPGHOSTif set--user: The Postgres username; defaults toPGUSERif set--pass: The Postgres password; defaults to$PGPASSWORD(preferred)--text: Dump plain text mode; defaults to directory mode--clean: Delete temporary files
To build the app, install Go and run:
make tembackTo run it with the --version option:
make runTo see the location of the binary:
make show-buildTo bake a docker image, start a docker registry and use make:
docker run -d -p 5001:5000 --restart=always --name registry registry:2
make image PUSH=trueThen pull it and run it:
docker pull localhost:5001/temback:latest
docker run --rm localhost:5001/temback:latest