A simple mysql database backup library for php. This library helps you backup your mysql database to a directory in your project or download it to your machine.
The library also allows you import or restore a database without stress. Follow the instructions below to get started.
Open your terminal or command prompt and type the below command:
composer require coderatio/simple-backup
- You can now chain static
::start()
on `SimpleBackup class. - This version includes fluent chaining of database settings.
- Added
->includeOnly(array $tables)
which allows you to export data for only tables mentioned in$tables
variable. - Added
->excludeOnly(array $tables)
which removes the inclussion of tables mentioned in$tables
variable during export.
SimpleBackup::start()
->setDbName('db_name')
->setDbUser('db_username')
->setDbPassword('db_password')
->includeOnly(['carts', 'houses', 'categories'])
->then()->storeAfterExportTo('backups')
->then()->getResponse();
SimpleBackup::start()
->setDbName('db_name')
->setDbUser('db_username')
->setDbPassword('db_password')
->excludeOnly(['users', 'posts'])
->then()->storeAfterExportTo('backups')
->then()->getResponse();
The export can be done in two ways.
- Store in a directory
- Download to your machine
To store the export in a directory, do this:
require 'vendor/autoload.php';
use Coderatio\SimpleBackup\SimpleBackup;
// Set the database to backup
$simpleBackup = SimpleBackup::setDatabase(['db_name', 'db_user', 'db_password', 'db_host'])
->storeAfterExportTo('pathtostore', 'file_name (optional)');
To get the stored file name, you can echo it out like this:
echo $simpleBackup->getExportedName();
You can also get the reponse by doing this:
/**
* @return object
**/
var_dump($simpleBackup->getResponse());
To download the export to your machine, do this:
require 'vendor/autoload.php';
use Coderatio\SimpleBackup\SimpleBackup;
// Set the database to backup
$simpleBackup = SimpleBackup::setDatabase(['db_name', 'db_user', 'db_password', 'db_host'])
->downloadAfterExport($file_name (optional));
If $file_name isn't provided, a random name will be generated for the download.
To add where clauses as you would do on SQL, you can do this before exporting:
Note: $tables
variable must be an associative array e.g
$tables = [
'users' => 'is_active = true'
];
$simpleBackup->setTableConditions(array $tables);
To limit how many rows to be included in your backup for a table, do this before exporting:
Note: Just like adding where clauses, the $tables
variable here must be an associative array. e.g
$tables = [
'users' => 50,
'posts' => 50
]
$simpleBackup->setTableLimitsOn(array $tables);
This package makes importing or restoring your mysql database easy. To import your database, do this:
require 'vendor/autoload.php';
use Coderatio\SimpleBackup\SimpleBackup;
// Set the database to backup
$simpleBackup = SimpleBackup::setDatabase(['db_name', 'db_user', 'db_password', 'db_host (optional)']])
->importFrom('pathtosql_file or sql_contents');
/**
* You can then dump the response like this.
*
* @return object
**/
var_dump($simpleBackup->getResponse());
Note: You can provide sql statements as the parameter. You may also overwrite the database configuration by passing it as second parameter to the importFrom(). e.g importFrom(pathtosql_file, array $db_config);
.
- Add a scheduler method to use with cron
- Store backup in Dropbox, Google Drive.
- Send backup to emails
To contribute to this project, send a pull request or find me on Twitter.
This project is licenced with the MIT license.