========
Commands
========

The primary usage of DBBackup is made with command line tools. By default,
commands will create backups and upload to your defined storage or download
and restore the latest.

Commands provide arguments for compress/uncompress and encrypt/decrypt.

dbbackup
========


Backup of database. ::

    $ ./manage.py dbbackup
    Backing Up Database: /tmp/tmp.x0kN9sYSqk
    Backup size: 3.3 KiB
    Writing file to tmp-zuluvm-2016-07-29-100954.dump

Help
~~~~

.. djcommand:: dbbackup.management.commands.dbbackup


dbrestore
=========

Restore a database. ::

    Restoring backup for database: /tmp/tmp.x0kN9sYSqk
    Finding latest backup
    Restoring: tmp-zuluvm-2016-07-29-100954.dump
    Restore tempfile created: 3.3 KiB

Help
~~~~

.. djcommand:: dbbackup.management.commands.dbrestore

mediabackup
===========

Backup media files, gather all in a tarball and encrypt or compress. :: 

    $ ./manage.py mediabackup
    Backup size: 10.0 KiB
    Writing file to zuluvm-2016-07-04-081612.tar

Help
~~~~

.. djcommand:: dbbackup.management.commands.mediabackup

mediarestore
============

Restore media files, extract files from archive and put into media storage. ::

    $ ./manage.py mediarestore
    Restoring backup for media files
    Finding latest backup
    Reading file zuluvm-2016-07-04-082551.tar
    Restoring: zuluvm-2016-07-04-082551.tar
    Backup size: 10.0 KiB
    Are you sure you want to continue? [Y/n]
    2 file(s) restored

Help
~~~~

.. djcommand:: dbbackup.management.commands.mediarestore

listbackups
===========

This command helps to list backups filtered by type (``'media'`` or ``'db'``),
by compression or encryption.

Help
~~~~

.. djcommand:: dbbackup.management.commands.listbackups
