Yeo! is a tiny backup utility for PostgreSQL databases.
With yeo you can:
- Back up a database using the
backupcommand - known in Postgres terminology as dump. For more here. - Revive a database using the
revivecommand - known in Postgres terminology as restore. For more here. - Clone a database using the
clonecommand - a combination of dump and restore in the Postgres terminology.
To install yeo:
- It is essential to have Postgres utilities such as
pg_dump,pg_restore,createdbordropdbin your system. This are included in libpq for MacOS or the entire PostgreSQL suite for Windows:
# Homebrew (MacOS & Linux)
brew install libpq # Make sure libpq is in your PATH
# Chocolatey (Windows)
choco install postgresql # Easiest is to install postgres- Then install
yeo:
go get github.com/jjcfrancisco/yeoAlternatively, you can use the already-built binaries for MacOS & Windows here. Just bear in mind that when running the binary, you must be in the same directory as where the binary lives (and create a databases.json) and call it like this -> ./yeo [command]...
For instance:
./yeo clone development localThe only thing you need after the installation process is a databases.json file with credentials of databases. It must be populated with credentials of at least one database.
The databases.json must follow this JSON structure:
{
"databases": [
{
"name": "local",
"database": "my_local_db",
"port": "5432",
"host": "localhost",
"user": "yeo",
"password": "mysecretpassword"
},
{
"name": "development",
"database": "dev",
"port": "5432",
"host": "yeo.host.com",
"user": "yeo",
"password": "mysecretpassword"
}
]
}To back up a database:
# 'local' is the name set in the databases.json and can be personalised
yeo backup local db_backup.dumpTo revive a database from a backup file:
# 'local' or 'prod' are names set in the database.json and can be personalised. The '--allow' flag allows to revive into non-local databases.
yeo revive local db_backup.dump
yeo revive --allow prod db_backup.dumpTo clone a database (backup + revive):
# 'local1', 'local2' or 'prod' are names set in the database.json and can be personalised. The '--allow' flag allows to revive into non-local databases.
yeo clone local1 local2
yeo clone --allow local1 prod- Validation for
databases.jsonagainst schema.
See LICENSE