From e23e66b6506a55f8c6da115913321e0b82b9749c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rodolphe=20Br=C3=A9ard?= Date: Thu, 4 Apr 2024 14:30:38 +0200 Subject: [PATCH] Improve the readme --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7035fa2..5ad38f0 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,10 @@ However, you may use it under the terms of the [MIT License][mit_license]. ## Actions -This runs [VACUUM][doc_vacuum] and [ANALYZE][doc_analyze] on a specified database. -If at least one recipient is specified, it also builds a reports and email it to said recipients. +This script: +- runs [VACUUM][doc_vacuum] and [ANALYZE][doc_analyze] on a specified database; +- creates compressed backup file and sends it to the destination (requires a destination); +- builds a reports and email it to recipients (requires at least one recipient). To know more about routine vacuuming, please read [PostgreSQL's documentation][doc_why_vacuum]. @@ -31,6 +33,12 @@ pg_maintenance.py --help pg_maintenance.py "db_name" --destination "user@remote:/your/backup/path" --email-recipient "admin@exemple.org" ``` +Restore a backup: + +``` +zstdcat "2024-04-04_db_name.sql.zst" | psql --set ON_ERROR_STOP=on +``` + [mit_license]: https://opensource.org/license/mit [doc_why_vacuum]: https://www.postgresql.org/docs/current/routine-vacuuming.html