Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 8 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 (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T15:30:25.000Z (23 days ago)
- Last Synced: 2024-10-19T12:37:55.265Z (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 MB
- Stars: 19
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
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://www.codacy.com/gh/mirko-pagliai/cakephp-database-backup/dashboard?utm_source=github.com&utm_medium=referral&utm_content=mirko-pagliai/cakephp-database-backup&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)
* [Installation](#installation)
+ [Installation on older CakePHP and PHP versions](#installation-on-older-cakephp-and-php-versions)
- [For PHP 7.4 and CakePHP 4.0 later](#for-php-74-and-cakephp-40-later)
- [For CakePHP 3.0 and PHP 5.6 or later](#for-cakephp-30-and-php-56-or-later)
* [Requirements](#requirements)
* [Configuration](#configuration)
* [How to use](#how-to-use)
* [Testing](#testing)
* [Versioning](#versioning)
## 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 [Cookbook](//book.cakephp.org/4.0/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
Recent packages and the master branch require at least CakePHP 5.0 and PHP 8.1 and the current development of the code
is based on these and later versions of CakePHP and PHP.
However, there are still some branches compatible with previous versions of PHP.
#### For PHP 7.4 and CakePHP 4.0 later
Instead, the [cakephp4](//github.com/mirko-pagliai/cakephp-database-backup/tree/cakephp4) branch requires at least PHP
`>=7.4.0` and CakePHP `^4.0`.
In this case, you can install the package as well:
```bash
$ composer require --prefer-dist mirko-pagliai/cakephp-database-backup:dev-cakephp4
```
Note that the `cakephp4` branch will no longer be updated as of January 05, 2024,
except for security patches, and it matches the
[2.12.3](//github.com/mirko-pagliai/cakephp-database-backup/releases/tag/2.12.3) version.
#### For CakePHP 3.0 and PHP 5.6 or later
Instead, the [cakephp3](//github.com/mirko-pagliai/cakephp-database-backup/tree/cakephp3) branch requires at least PHP
`>=5.6 <7.4` and CakePHP `^3.5.1`.
In this case, you can install the package as well:
```bash
$ composer require --prefer-dist mirko-pagliai/cakephp-database-backup:dev-cakephp3
```
Note that the `cakephp3` branch will no longer be updated as of April 29, 2021,
except for security patches, and it matches the
[2.8.5](//github.com/mirko-pagliai/cakephp-database-backup/releases/tag/2.8.5) version.
## Requirements
*DatabaseBackup* requires:
* `mysql` and `mysqldump` for *MySql* databases;
* `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.
Please forward, remember that the database user must have the correct
permissions (for example, for `mysql` the user must have the `LOCK TABLES`
permission).
## 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 [Cookbook](https://book.cakephp.org/4.0/en/core-libraries/email.html#configuring-transports).
## How to use
See our wiki:
* [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)
* [How to use the BackupShell](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell)
And refer to our [API](//mirko-pagliai.github.io/cakephp-database-backup).
## Testing
Tests are run for only one driver at a time, by default `mysql`.
To choose another driver to use, you can set the `driver_test` environment variable before running `phpunit`.
For example:
```bash
driver_test=sqlite vendor/bin/phpunit
driver_test=postgres vendor/bin/phpunit
```
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).