Dumper: CLI utility for creating database backups – PostgreSQL, MySQL and others

3 weeks ago 2

Dumper — This is a CLI utility for creating backups databases of various types (PostgreSQL, MySQL and etc.) with flexible connection and storage settings.

Multiple database systems can be managed.
Support PostgreSQL, MySQL, MongoDB and etc.
Connect for DB:
- with the dump performed directly on the server and download (server).
Work with SSH-Keys (include passphrase).
Custom dump name templates.
Archiving old dumps.
Different formats.

The configuration is set in a YAML file. (example, config.yaml).

settings: db_port: "5432" driver: "psql" ssh: private_key: "path_your_key" passphrase: "your_passphrase" is_passphrase: true template: "{%srv%}_{%db%}_{%datetime%}" archive: true location: "server" format: "plain" dir_dump: "./dumps" dir_archived: "./archived" remove_dump: true servers: first-server: name: "test server" host: "10.234.23.45" port: "22" user: "user" password: "password" second-server: name: "mongo" host: "172.0.18.54" user: "root" remote-config-server: name: "mongo" host: "43.4.58.64" user: "user" port: 22 conf_path: "/var/www/conf.yaml" databases: demo: name: "db_name_demo" user: "demo_user" password: "password" server: "first-server" port: "5432" driver: "psql" format: "dump" mysql_db: name: "mysql_db_dumper" user: "user" password: "password" port: 3306 driver: "mysql" format: "sql" server: "first-server" remove_dump: false mongo: name: "mongo_db_name" user: "root" password: "mongo_password" port: 27017 driver: "mongo" format: "bson" server: "second-server" options: auth_source: "admin" ssl: true remove_dump: false maria_db: name: "maria_db_dumper" user: "user" password: "password" port: 3306 driver: "mysql" format: "sql" server: "first-server"

📑 Configuration Description

The configuration consists of three sections:

🔧 1. settings — global settings

Apply to all servers and databases, unless redefined locally.

Parameter Description type

db_port	Default database connection port	option
driver	The DB driver list	required
ssh.private_key	The path to the private SSH key.	option
ssh.passphrase	Passphrase for the key (optional).	option
ssh.is_passphrase	whether to use passphrase from the config	option
template	File name template	option
archive	Archiving old dumps (need {%srv%}_{%db%} in template).	option
location	Dump execution method	required
format	The dump format	required
dir_dump	Directory for saving dumps	option
dir_archived	Archive Directory	option
logging	Create logging	option
retry_connect	attempts reconnect to server (default 5)	option
remove_dump	remove dump file after created (default true)	option

- PostgreSQL — psql
- MySQL — mysql
- MongoDB — mongo
- MariaDB — mariadb
- PostgreSQL: plain, dump, tar
- MySQL: plain
- MongoDB: bson
- MariaDB: plain
- {%srv%} — Name server
- {%db%} — Name db
- {%datetime%} — Date and time
- {%date%} — Date
- {%time%} — Time
- {%ts%} — Time unix
- server — create dump in server and download

Defines the connections through which databases can be backed up.

Parameter Description type

name	Human-readable server name	option
host	The IP address or domain name	required
port	Connection port	required (if not set settings.port)
user	Username	required
password	Password (if there is no key)	required (if not set key)
key	Key (if there is no password)	required (if not set password)
conf_path	Path remote config	option (if set read only remote config)

The configuration file on the remote servers must contain the servers and databases section.

A list of databases that need to be backed up.

Parameter Description type

name	Database name (by default, the key name)	option
user	The database user	required
password	DB user's password	required
server	The link to the server from the servers section	required
port	Connection port	required (if not set settings.db_port)
driver	The DB driver list	required (if not set settings.driver)
format	The dump format	required (if not set settings.format)
options.auth_source	Name database for auth	option (if set up driver mongo)
options.ssl	SSL/TLS	option (if set up driver mongo)
remove_dump	remove dump file after created (default true)	option

Backup with a choice of database from config file

./dumper --config ./cfg.yaml

Flags:
- --config ./cfg.yaml — path to config file
- --db demo,app — backup databases from list
- --all — backup all databases from config file
- --file-log file.log — file name log file (if settings.logging == true)

├── dumps/ # Directory for new dumps ├── archived/ # Archive of old dumps ├── config.yaml # Configuration file ├── dumper # The executable file of the utility └── dumper.log # Log file