psql-aws-backup
Easily backups PostgreSQL databases into Amazon S3 Bucket
🤠
Table of Contents
Setup
Prerequisites: you should have a PostgreSQL installation in your computer, because the package uses pg_dump
command for backup creation
Installing
Install package globally using npm.
npm i @quantumlabs/psql-aws-backup -g
Commands
Config
Usage:
psql-aws-backup config [options]
config default S3 credentials
Options:
-h, --help output usage information
This command is used to create the package basic config. When used, it prompts two questions in your terminal: S3 Key, and S3 Secret.
Backup
Usage:
psql-aws-backup backup [options] <DATABASE_URL> <BUCKET> <FOLDER>
backup a postgreSQL database and upload the backup to S3 bucket
Options:
--create-copy create a copy of the backup in the current directory
--verbose verbose mode
-h, --help output usage information
This command is used to backup a database. You need to provide the DATABASE_URL
, BUCKET
and FOLDER
. The FOLDER
argument, is the path INSIDE your bucket.
When you use --create-copy
you also creates a local copy of the .sql
file which was uploaded to S3 bucket.
Todo
- [ ] Backup presets
Credits
Create with