Adding database backups to Django

When setting up a new Django or Wagtail website, I also setup a backup procedure. Instead of writing a custom shell script to do so, I tend us use django-dbbackup for doing the hard work.

Setting it up is a breeze and should only take you a couple of minutes to do.

First, start with installing the package (don't forget to add it to your requirements.txt file):

1$ pip install django-dbbackup

Once the package is installed, we need to update our Django configuration. We first need to add the module to the INSTALLED_APPS list:

mysite/settings.py

1INSTALLED_APPS = (
2    ...
3    'dbbackup',
4    ...
5)

We also need to add a couple of configuration settings. Here's how i configured it for my sites:

mysite/settings.py

1DBBACKUP_STORAGE = 'django.core.files.storage.FileSystemStorage'
2DBBACKUP_STORAGE_OPTIONS = {
3    'location': os.path.join(BASE_DIR, 'backup')
4}
5DBBACKUP_FILENAME_TEMPLATE = '{datetime}-{databasename}.{extension}'
6DBBACKUP_MEDIA_FILENAME_TEMPLATE = '{datetime}-media.{extension}'

The DBBACKUP_STORAGE tells the system that I want to backup to the local filesystem. The DBBACKUP_STORAGE_OPTIONS define the location where to store the backups. If you prefer another location than the local filesystem, you can check if any of the other providers are more suited for you. Next to the local filesystem, also Amazon S3, Google Cloud Storage, Dropbox, FTP and SFTP are supported.

I also used the settings DBBACKUP_FILENAME_TEMPLATE and DBBACKUP_MEDIA_FILENAME_TEMPLATE to change the format of the filenames it generates. I prefer that the filenames start with the date in reverse so that they sort nicely.

To perform the database backup, you can run the dbbackup manage command:

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

The -z option is optional and is used to compress the backup. This will create a dump of the database and store it in thee backup directory we have specified.

If you are allowing custom uploads in your site, you will have a media directly as will which needs to be backed up. That's also covered by the mediabackup command:

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

There are also the opposite commands, dbrestore and mediarestore to restore the backup:

1$ ./manage.py dbrestore
2Restoring backup for database: /tmp/tmp.x0kN9sYSqk
3Finding latest backup
4Restoring: tmp-zuluvm-2016-07-29-100954.dump
5Restore tempfile created: 3.3 KiB

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

When you run these commands, the latest backup will be retrieved and restored.

To get the inventory of the available backups, you can use listbackups:

1$ ./manage.py listbackups
2Name                                     Datetime            
32020-11-22-185436-default.psql.gz        11/22/20 18:54:36   
42020-11-22-185456-media.tar.gz           11/22/20 18:54:56   
52020-11-22-185105-default.psql.gz        11/22/20 18:51:05   
62020-11-22-185402-media.tar.gz           11/22/20 18:54:02   

What I particularly like is how nicely it integrates with the Django stack. It read the database connection details from the Django settings. You can also call the backup from code using call_command, … There shouldn't be any reason anymore to not integrate a proper backup :-)