https://github.com/mirko-pagliai/cakephp-database-backup
DatabaseBackup is a CakePHP plugin to export, import and manage database backups
https://github.com/mirko-pagliai/cakephp-database-backup
backup backup-script backup-tool backup-utility cakephp cakephp-plugin database-backup mysql php postgresql sqlite
Last synced: 20 days ago
JSON representation
DatabaseBackup is a CakePHP plugin to export, import and manage database backups
- Host: GitHub
- URL: https://github.com/mirko-pagliai/cakephp-database-backup
- Owner: mirko-pagliai
- License: other
- Created: 2017-06-22T18:38:58.000Z (almost 8 years ago)
- Default Branch: 2.15.x
- Last Pushed: 2025-05-07T16:46:14.000Z (21 days ago)
- Last Synced: 2025-05-08T21:17:44.484Z (20 days ago)
- Topics: backup, backup-script, backup-tool, backup-utility, cakephp, cakephp-plugin, database-backup, mysql, php, postgresql, sqlite
- Language: PHP
- Homepage:
- Size: 1.65 MB
- Stars: 19
- Watchers: 4
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# cakephp-database-backup
[](LICENSE.txt)
[](https://github.com/mirko-pagliai/cakephp-database-backup/actions/workflows/ci.yml)
[](https://codecov.io/gh/mirko-pagliai/cakephp-database-backup)
[](https://app.codacy.com/gh/mirko-pagliai/cakephp-database-backup/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://www.codefactor.io/repository/github/mirko-pagliai/cakephp-database-backup)
*DatabaseBackup* is a CakePHP plugin to export, import and manage database backups.
Currently, the plugin supports *MySql*, *Postgres* and *Sqlite* databases.
Did you like this plugin? Its development requires a lot of time for me.
Please consider the possibility of making [a donation](//paypal.me/mirkopagliai):
even a coffee is enough! Thank you.
[](//paypal.me/mirkopagliai)
## Requirements
*DatabaseBackup* requires:
* `mariadb` and `mariadb-dump` for *MariaDB*/*MySql* databases (previously `mysql` and `mysqldump`);
* `pg_dump` and `pg_restore` for *Postgres* databases;
* `sqlite3` for *Sqlite* databases.
**Optionally**, if you want to handle compressed backups, `bzip2` and `gzip` are
also required.
The installation of these binaries may vary depending on your operating system.
## Installation
You can install the plugin via composer:
```bash
$ composer require --prefer-dist mirko-pagliai/cakephp-database-backup
```
Then you have to load the plugin. For more information on how to load the plugin,
please refer to the [CakePHP documentation](https://book.cakephp.org/5/en/plugins.html#loading-a-plugin).
Simply, you can execute the shell command to enable the plugin:
```bash
$ bin/cake plugin load DatabaseBackup
```
This would update your application's bootstrap method.
By default, the plugin uses the `APP/backups` directory to save the backups
files. So you have to create the directory and make it writable:
```bash
$ mkdir backups/ && chmod 775 backups/
```
If you want to use a different directory, read the [Configuration](#configuration) section.
### Installation on older CakePHP and PHP versions
Compared to the current installation requirements, some tags are provided for those using older versions of CakePHP and
PHP (*until February 7, 2025, they were available as branches, now only as tags*):
- tag [`cakephp4`](https://github.com/mirko-pagliai/cakephp-database-backup/releases/tag/cakephp4), which requires at
least PHP `>=7.4.0` and CakePHP `^4.0`.
This tag no longer receives any updates as of January 5, 2024, and roughly coincides with what `2.12.3` version was.
- tag [`cakephp3`](https://github.com/mirko-pagliai/cakephp-database-backup/releases/tag/cakephp3), which requires at
least PHP `>=5.6 <7.4` and CakePHP `^3.5.1`.
This tag no longer receives any updates as of April 29, 2021, and roughly coincides with what `2.8.5` version was.
You can freely use these tags, even by downloading the source codes from the attached assets, but their functioning is
no longer guaranteed, especially regarding old dependencies that may no longer be available.
## Configuration
The plugin uses some configuration parameters. See our wiki:
* [Configuration](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/Configuration)
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](https://book.cakephp.org/5/en/core-libraries/email.html#configuring-transports).
## How to use
See our wiki:
* [How to use commands](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-commands)
* [Export backups as cron jobs](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/Export-backups-as-cron-jobs)
* [How to use the BackupExport utility](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupExport-utility)
* [How to use the BackupImport utility](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupImport-utility)
* [How to use the BackupManager utility](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupManager-utility)
* [Create backup copies](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/Create-backup-copies)
* [Send backups via email](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/Send-backups-via-email)
Before opening an issue, check this list of [common issues](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/Common-issues).
## Testing
Normally tests are only run on one driver at a time, by default `mysql`.
To run tests with another driver, you can use the scripts defined in `composer.json`:
For example:
```bash
$ composer test
$ composer test-postgres
$ composer test-sqlite
```
Instead, to run tests with all drivers, you can use the `test-all` script (individual tests are chained together).
For individual drivers, alternatively you can set the `db_dsn` environment variable, indicating the connection
parameters. In this case, the driver type will still be detected automatically.
For example:
```bash
db_dsn=sqlite:///' . TMP . 'example.sq3 vendor/bin/phpunit
```
## Versioning
For transparency and insight into our release cycle and to maintain backward
compatibility, *DatabaseBackup* will be maintained under the
[Semantic Versioning guidelines](http://semver.org).