Configuration

The plugin uses some configuration parameters, and you can set them using the \Cake\Core\Configure class, before loading the plugin.

For example, you can do this at the bottom of the file APP/config/app.php of your application.

If you want to send backup files by email, remember to set up your application correctly so that it can send emails.
For more information on how to configure your application, see the CakePHP documentation.

• Configuration values
  • DatabaseBackup.processTimeout
  • DatabaseBackup.target
• Binaries
• Customize export and import commands

---

Configuration values

DatabaseBackup.processTimeout

(from the 2.12.0 version)

Configure::write('DatabaseBackup.processTimeout', 60);

Setting DatabaseBackup.processTimeout, you can choose the general timeout time (in seconds) for commands to be executed in the shell.

DatabaseBackup.target

Configure::write('DatabaseBackup.target', ROOT . DS . 'backups');

Setting DatabaseBackup.target, you can use another directory where the plugin will save backup files.

Binaries

The plugin uses several binary files:

• bzip2
• gzip
• mariadb
• mariadb-dump
• pg_dump
• pg_restore
• sqlite3

By default, all binaries will be detected automatically. If a binary is not found or if you want to set a different path for the binary, you can use these configuration values.

Just an example for UNIX:

Configure::write('DatabaseBackup.binaries.bzip2', '/full/path/to/bzip2');

And an example for Windows:

Configure::write('DatabaseBackup.binaries.mysql', 'C:\\xampp\\mysql\\bin\\mysql.exe');
Configure::write('DatabaseBackup.binaries.mysqldump', 'C:\\xampp\\mysql\\bin\\mysqldump.exe');

The same applies to all other binaries, just change the binary name shown in the example.

Customize export and import commands

(from the 2.10.0 version)

By default, commands (to export/import backups) are executed with generic options that are valid for almost all environments. However, in some particular environments or conditions it may be necessary to execute commands with particular options.

The default commands are defined in the config/bootstrap.php file and placeholders (such as "${:BINARY}" or "${:DB_HOST}") are replaced and escaped before the command is executed.

It is therefore possible to use custom commands by acting on the configuration, before loading the plugin.

An example: suppose you want to run the command to export mysql databases with the --column-statistics=0 option. Then in the bootstrap of your application:

Configure::write('DatabaseBackup.mysql.export', '"${:BINARY}" --defaults-file="${:AUTH_FILE}" "${:DB_NAME}" --column-statistics=0');

However, remember that some values should be escaped and that incorrect customization of the commands could make the plugin unusable or otherwise cause unwanted effects.