Database Settings¶

The following databases are supported by this application. You can customize the commands used for backup and the resulting filenames with the following settings.

mysqldump -u{username} -p{password} {databasename} >

mysql -u{username} -p{password} {databasename} <

pg_dump {databasename} >

dropdb {databasename}
createdb {databasename} --owner={username}
psql -1 {databasename} <

[READ_FILE, '{databasename}']

[WRITE_FILE, '{databasename}']

Defining Backup Commands¶

When creating backup or restore commands, there are a few template variables you can use in the commands (listed below). Also note, ending a command with > or < will pipe the file contents from or to the command respectively.

• {databasename}: Name of the database from settings.py
• {servername}: Optional SERVER_NAME setting in settings.py
• {username}: Database username from settings.py
• {password}: Database password from settings.py
• {datetime}: Current datetime string (see DBBACKUP_DATE_FORMAT).
• {extension}: File extension for the current database.

There are also two special commands READ_FILE and WRITE_FILE which take the form of a two-item list, the second item being the file to read or write. Please see the SQLite settings above for reference.

Global Settings

DBBACKUP_STORAGE (required)
String pointing to django-dbbackup location module to use when performing a backup. You can see the exact definitions to use in the required settings for the backup location of your choice above.

DBBACKUP_DATE_FORMAT (optional)
The Python datetime format to use when generating the backup filename. By default this is '%Y-%m-%d-%H%M%S'.

DBBACKUP_SERVER_NAME (optional)
An optional server name to use when generating the backup filename. This is useful to help distinguish between development and production servers. By default this value is not used and the servername is not included in the generated filename.

DBBACKUP_FILENAME_TEMPLATE (optional)
The template to use when generating the backup filename. By default this is '{databasename}-{servername}-{datetime}.{extension}'.