From 519d659644557464666299158a06f0e0e1b2dfc8 Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Sun, 25 Feb 2024 14:40:48 +0100 Subject: [PATCH] refactor: clean up code --- README.md | 38 +++++++++++++++++++------------------- cmd/root.go | 2 +- cmd/version.go | 2 +- pkg/backup.go | 2 +- pkg/s3fs.go | 2 +- pkg/scripts.go | 2 +- 6 files changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 9d0b296..f8ae119 100644 --- a/README.md +++ b/README.md @@ -30,25 +30,25 @@ PostgreSQL Backup and Restoration tool. Backup database to AWS S3 storage or any ### Usage -| Options | Shorts | Usage | -|-----------------------|--------|----------------------------------------------------------------------| -| pg-bkup | bkup | CLI utility | -| backup | | Backup database operation | -| restore | | Restore database operation | -| history | | Show the history of backup | -| --storage | -s | Set storage. local or s3 (default: local) | -| --file | -f | Set file name for restoration | -| --path | | Set s3 path without file name. eg: /custom_path | -| --dbname | -d | Set database name | -| --port | -p | Set database port (default: 5432) | -| --mode | -m | Set execution mode. default or scheduled (default: default) | -| --disable-compression | | Disable database backup compression | -| --prune | | Delete old backup, default disabled | -| --keep-last | | Delete files created more than specified days ago, default 7 days | -| --period | | Set crontab period for scheduled mode only. (default: "0 1 * * *") | -| --timeout | -t | Set timeout (default: 60s) | -| --help | -h | Print this help message and exit | -| --version | -V | Print version information and exit | +| Options | Shorts | Usage | +|-----------------------|--------|------------------------------------------------------------------------| +| pg-bkup | bkup | CLI utility | +| backup | | Backup database operation | +| restore | | Restore database operation | +| history | | Show the history of backup | +| --storage | -s | Set storage. local or s3 (default: local) | +| --file | -f | Set file name for restoration | +| --path | | Set s3 path without file name. eg: /custom_path | +| --dbname | -d | Set database name | +| --port | -p | Set database port (default: 5432) | +| --mode | -m | Set execution mode. default or scheduled (default: default) | +| --disable-compression | | Disable database backup compression | +| --prune | | Delete old backup, default disabled | +| --keep-last | | Delete old backup created more than specified days ago, default 7 days | +| --period | | Set crontab period for scheduled mode only. (default: "0 1 * * *") | +| --timeout | -t | Set timeout (default: 60s) | +| --help | -h | Print this help message and exit | +| --version | -V | Print version information and exit | ## Environment variables diff --git a/cmd/root.go b/cmd/root.go index e92ca95..7c4f191 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -1,6 +1,6 @@ // Package cmd /* /* -Copyright © 2024 Jonas Kaninda +Copyright © 2024 Jonas Kaninda */ package cmd diff --git a/cmd/version.go b/cmd/version.go index 1e734a5..c1f19c1 100644 --- a/cmd/version.go +++ b/cmd/version.go @@ -1,7 +1,7 @@ package cmd /* -Copyright © 2024 Jonas Kaninda +Copyright © 2024 Jonas Kaninda */ import ( diff --git a/pkg/backup.go b/pkg/backup.go index 5021d00..249deb5 100644 --- a/pkg/backup.go +++ b/pkg/backup.go @@ -1,6 +1,6 @@ // Package pkg /* /* -Copyright © 2024 Jonas Kaninda +Copyright © 2024 Jonas Kaninda */ package pkg diff --git a/pkg/s3fs.go b/pkg/s3fs.go index 57863cc..db59b26 100644 --- a/pkg/s3fs.go +++ b/pkg/s3fs.go @@ -1,6 +1,6 @@ // Package pkg /* /* -Copyright © 2024 Jonas Kaninda +Copyright © 2024 Jonas Kaninda */ package pkg diff --git a/pkg/scripts.go b/pkg/scripts.go index 2de3a45..bb31c05 100644 --- a/pkg/scripts.go +++ b/pkg/scripts.go @@ -2,7 +2,7 @@ package pkg // Package pkg /* /* -Copyright © 2024 Jonas Kaninda +Copyright © 2024 Jonas Kaninda */ import ( "fmt"