Database Backup

This task creates a full backup of the database and stores it to an SQL file.

The name of this task is “database_backup”, and it accepts the following configurations:

[[tasks]]
name = "database_backup"
directory = "/etc/bomnipotent_server/backups/"
period = "1 day" # Optional
enabled = true # Optional

Important

The backup is created with the pg_dump tool, and restored with dropdb, createdb and psql. The official BOMnipotent container comes with these tools pre-installed, but if your setup is directly running the BOMnipotent Server binary you need to make sure that they are available on the system.

The filename of the backup contains the name of the database and a timestamp. It is stored in the configured directory.

The directory refers to a path on the filesystem visible to BOMnipotent Server. For the recommended setup with a Docker compose file, this means that the backup is only stored inside the container. To synchronise the backup with the host system, you can add a bind-mount volume to your Docker compose file. For example:

# ...
services:
  # ...
  bomnipotent_server:
    # ...
    volumes:
      # ...
      - type: bind
        source: ./backups/bomnipotent_db
        target: /etc/bomnipotent_server/backups/
        read_only: false # BOMnipotent requires write access in this case.

From there you can synchronise the backups with your backup server.

To restore a backup you can use the “database-backup completely-restore” command of BOMnipotent Client.