Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #7

Merged
merged 1 commit into from
Jul 17, 2024
Merged

Update docs #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 24 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
# `fixbackup` - FIX Database Backup System
# `fixbackup` - Fix Database Backup System

## Usage

```bash
usage: fixbackup [-h] [--backup-directory BACKUP_DIRECTORY] [--verbose | --trace | --quiet] [--s3-bucket S3_BUCKET] --type {daily,weekly,monthly,yearly}
[--set-lifecycle-policy] [--redis-host REDIS_HOST] [--redis-port REDIS_PORT] [--redis-username REDIS_USERNAME]
[--redis-password REDIS_PASSWORD] [--redis-database-number REDIS_DATABASE_NUMBER] [--redis-cli-args REDIS_CLI_ARGS]
[--mysql-host MYSQL_HOST] [--mysql-port MYSQL_PORT] [--mysql-user MYSQL_USER] [--mysql-password MYSQL_PASSWORD]
[--mysqldump-args MYSQLDUMP_ARGS] [--arangodb-host ARANGODB_HOST] [--arangodb-port ARANGODB_PORT] [--arangodb-username ARANGODB_USERNAME]
[--arangodb-password ARANGODB_PASSWORD] [--arangodb-database ARANGODB_DATABASE] [--arangodump-args ARANGODUMP_ARGS]
usage: fixbackup [-h] [--backup-directory BACKUP_DIRECTORY] [-n ENVIRONMENT] [--sleep] [--verbose | --trace | --quiet] [--s3-bucket S3_BUCKET] --type {daily,weekly,monthly,yearly} [--set-lifecycle-policy] [--redis-host REDIS_HOST]
[--redis-port REDIS_PORT] [--redis-username REDIS_USERNAME] [--redis-password REDIS_PASSWORD] [--redis-database-number REDIS_DATABASE_NUMBER] [--redis-cli-args REDIS_CLI_ARGS] [--redis-tls] [--redis-tls-insecure]
[--mysql-host MYSQL_HOST] [--mysql-port MYSQL_PORT] [--mysql-user MYSQL_USER] [--mysql-password MYSQL_PASSWORD] [--mysql-database MYSQL_DATABASE] [--mysqldump-args MYSQLDUMP_ARGS] [--pg-host PG_HOST]
[--pg-port PG_PORT] [--pg-user GP_USER] [--pg-password PG_PASSWORD] [--pg-database PG_DATABASE] [--pg-dump-args PG_DUMP_ARGS] [--arangodb-host ARANGODB_HOST] [--arangodb-port ARANGODB_PORT]
[--arangodb-username ARANGODB_USERNAME] [--arangodb-password ARANGODB_PASSWORD] [--arangodb-database ARANGODB_DATABASE] [--arangodump-args ARANGODUMP_ARGS] [--arangodb-tls]

FIX Database Backup System
Fix Database Backup System

options:
-h, --help show this help message and exit
--backup-directory BACKUP_DIRECTORY
Directory where backups are created
-n ENVIRONMENT, --name ENVIRONMENT
Name of the environment
--sleep Don't do anything, just sleep forever
--verbose, -v Verbose logging
--trace Trage logging
--quiet Only log errors
Expand All @@ -37,6 +39,8 @@ options:
Redis database number
--redis-cli-args REDIS_CLI_ARGS
Extra arguments to pass to redis-cli
--redis-tls Redis uses TLS
--redis-tls-insecure Redis uses TLS without verifying the certificate
--mysql-host MYSQL_HOST
MySQL host
--mysql-port MYSQL_PORT
Expand All @@ -45,8 +49,19 @@ options:
MySQL user
--mysql-password MYSQL_PASSWORD
MySQL password
--mysql-database MYSQL_DATABASE
MySQL database
--mysqldump-args MYSQLDUMP_ARGS
Extra arguments to pass to mysqldump
--pg-host PG_HOST PostgreSQL host
--pg-port PG_PORT PostgreSQL port
--pg-user GP_USER PostgreSQL user
--pg-password PG_PASSWORD
PostgreSQL password
--pg-database PG_DATABASE
PostgreSQL database
--pg-dump-args PG_DUMP_ARGS
Extra arguments to pass to pg_dump
--arangodb-host ARANGODB_HOST
ArangoDB host
--arangodb-port ARANGODB_PORT
Expand All @@ -59,4 +74,5 @@ options:
ArangoDB database to dump
--arangodump-args ARANGODUMP_ARGS
Extra arguments to pass to arangodump
--arangodb-tls ArangoDB uses TLS
```
2 changes: 1 addition & 1 deletion fixbackup/args.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@


def parse_args(add_args: List[Callable[[ArgumentParser], None]]) -> Namespace:
arg_parser = ArgumentParser(prog="fixbackup", description="FIX Database Backup System")
arg_parser = ArgumentParser(prog="fixbackup", description="Fix Database Backup System")
arg_parser.add_argument(
"--backup-directory",
help="Directory where backups are created",
Expand Down
Loading