Databackup

Last updated Mar 10th, 2021 | Page history | Improve this page | Report an issue

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$301 per month—let's make that $500!

Learn more

What is Databackup?¶

Databackup is a Snippet for MODX Revolution that will backup your MODX MySQL database as one sql dump file and/or each table as a SQL dump as well as other MySQL databases. The extra does use PDO so it might be able to do other databases, like MSSQL, as is but I have not tested this.

History¶

Databackup was written by Josh Gulledge as an easy way to keep data backups, and first released on August 12th, 2011.

Download¶

It can be downloaded from within the MODX Revolution manager via Package Management, or from the MODx Extras Repository, here: https://modx.com/extras/package/databackup

Development and Bug Reporting¶

Databackup is stored and developed in GitHub, and can be found here:https://github.com/jgulledge19/DataBackup

Bugs can be filed here: https://github.com/jgulledge19/DataBackup/issues

How to Use¶

Install via the package manager
Set the databackup.folder setting to something that is above your web root. The default is core/components/databackup/dumps/
Set the purge time option (databackup.pruge) if you want this to be different, the default is 1814400, which is 21 days.
Set up Cron Manager: CronManager and then Create a new job.
Select the backup snippet and then select in minutes how often you would like this to run. Every 24 hours is 1440 minutes.

How to use snippet with getCache¶

See: getcache for getCache examples.

This is a simple backup your site every 24 hours(assuming the page is visited) or less if you flush the cache. It will also purge the backups older then 21 days.

[[!getCache?
&element=`backup`
&excludeTables=`my_custom_table,my_other_custom_table`
&cacheExpires=`86400`
]]

System Settings ¶

These need to be created if they do not exist.

Name	Key	Field Type	Namespace	Description	Default Value
Folder	databackup.folder	Textfield	databackup	This is the folder path that will save you .sql files to. PHP must have write permissions to this folder.	{core_path}components/databackup/dumps/
Purge Files	databackup.purge	Textfield	databackup	Purge old files that are older then the current time - seconds. Default is 1814400 (21 days).	1814400

WARNING¶

Be careful where you make the file path for the purge setting: databackup.folder. If you place this in an existing folder, all files older than the purge date will be delete. It is recommended that you create a new folder for your backups that is above your public WWW folder.

Available Properties¶

There is also a sample backupMany snippet. You can modify this example snippet to backup other databases.

Version 1.1

Name	Description	Default Value
database	The database you wish to backup.	modx
includeTables	Comma separated list of tables to include. All other tables will be excluded if this option is used.	NULL
excludeTables	Comma separated list of tables to exclude. All other tables will be included.	NULL
writeFile	Boolean This will write one large SQL dump file. options: true/false	true
writeTableFiles	Boolean This will write each tables as a individual SQL dump file. options: true/false	true
commentPrefix	This are the SQL comment prefix.	–
commentSuffix	If the comment for SQL need an ending suffix. Default is empty
newLine	The value to print a new line in SQL files.	\n
useDrop	Boolean true/false to use the the DROP TABLE in the SQL files	true
createDatabase	Boolean true/false to use a CREATE DATABASE command in the SQL files	false