https://github.com/beaten-sect0r/yii2-db-manager
Database Backup and Restore functionality
https://github.com/beaten-sect0r/yii2-db-manager
backup database dump yii2
Last synced: 5 months ago
JSON representation
Database Backup and Restore functionality
- Host: GitHub
- URL: https://github.com/beaten-sect0r/yii2-db-manager
- Owner: Beaten-Sect0r
- License: bsd-3-clause
- Created: 2016-05-27T14:04:57.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2022-05-02T14:55:25.000Z (about 4 years ago)
- Last Synced: 2025-09-05T17:59:39.695Z (10 months ago)
- Topics: backup, database, dump, yii2
- Language: PHP
- Homepage:
- Size: 426 KB
- Stars: 93
- Watchers: 8
- Forks: 32
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yii2 DB manager
Click on a :star:!
[](https://packagist.org/packages/beaten-sect0r/yii2-db-manager)
[](https://packagist.org/packages/beaten-sect0r/yii2-db-manager)
[](https://packagist.org/packages/beaten-sect0r/yii2-db-manager)
[](https://packagist.org/packages/beaten-sect0r/yii2-db-manager)
MySQL/PostgreSQL Database Backup and Restore functionality
## Installation
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```bash
composer require --prefer-dist beaten-sect0r/yii2-db-manager "*"
```
or add
```
"beaten-sect0r/yii2-db-manager": "*"
```
to the require section of your `composer.json` file.
## Configuration
Once the extension is installed, simply add it in your config by:
Basic ```config/web.php```
Advanced ```backend/config/main.php```
## Simple config
```php
'modules' => [
'db-manager' => [
'class' => 'bs\dbManager\Module',
// path to directory for the dumps
'path' => '@app/backups',
// list of registerd db-components
'dbList' => ['db'],
// Flysystem adapter (optional) creocoder\flysystem\LocalFilesystem will be used as default.
'flySystemDriver' => 'creocoder\flysystem\LocalFilesystem',
'as access' => [
'class' => 'yii\filters\AccessControl',
'rules' => [
[
'allow' => true,
'roles' => ['admin'],
],
],
],
],
],
```
## Advanced config
```php
'components' => [
// https://github.com/creocoder/yii2-flysystem
'backupStorage' => [
'class' => 'creocoder\flysystem\FtpFilesystem',
'host' => 'ftp.example.com',
//'port' => 21,
//'username' => 'your-username',
//'password' => 'your-password',
//'ssl' => true,
//'timeout' => 60,
//'root' => '/path/to/root',
//'permPrivate' => 0700,
//'permPublic' => 0744,
//'passive' => false,
//'transferMode' => FTP_TEXT,
],
],
'modules' => [
'db-manager' => [
'class' => 'bs\dbManager\Module',
// Flysystem adapter (optional) creocoder\flysystem\LocalFilesystem will be used as default.
'flySystemDriver' => 'creocoder\flysystem\LocalFilesystem',
// path to directory for the dumps
'path' => '@app/backups',
// list of registerd db-components
'dbList' => ['db', 'db1', 'db2'],
// process timeout
'timeout' => 3600,
// additional mysqldump/pg_dump presets (available for choosing in dump and restore forms)
'customDumpOptions' => [
'mysqlForce' => '--force',
'somepreset' => '--triggers --single-transaction',
'pgCompress' => '-Z2 -Fc',
],
'customRestoreOptions' => [
'mysqlForce' => '--force',
'pgForce' => '-f -d',
],
// options for full customizing default command generation
'mysqlManagerClass' => 'CustomClass',
'postgresManagerClass' => 'CustomClass',
// option for add additional DumpManagers
'createManagerCallback' => function($dbInfo) {
if ($dbInfo['dbName'] == 'exclusive') {
return new MyExclusiveManager;
} else {
return false;
}
}
'as access' => [
'class' => 'yii\filters\AccessControl',
'rules' => [
[
'allow' => true,
'roles' => ['admin'],
],
],
],
],
],
```
## Console config
```php
'modules' => [
'db-manager' => [
'class' => 'bs\dbManager\Module',
// Flysystem adapter (optional) creocoder\flysystem\LocalFilesystem will be used as default.
'flySystemDriver' => 'creocoder\flysystem\LocalFilesystem',
// path to directory for the dumps
'path' => '@app/backups',
// list of registerd db-components
'dbList' => ['db'],
],
],
```
Make sure you create a writable directory named backup on app root directory.
## Usage
Pretty url's ```/db-manager```
No pretty url's ```index.php?r=db-manager```
## Console usage
```-db``` - db component, default value: `db`
```-gz``` - gzip archive
```-s``` - file storage
```-f``` - file name, default last dump
Create dump
```bash
php yii dump/create -db=db -gz -s
```
Restore dump
```bash
php yii dump/restore -db=db -s -f=dump.sql
```
Deleting all dumps
```bash
php yii dump/delete-all
```
Test database connection
```bash
php yii dump/test-connection -db=db
```
## Changelog
- [Flysystem support](https://github.com/creocoder/yii2-flysystem)
- Console support
- Multiple database management
- Ability for customize dump and restore options; dump and restore processors
- Ability for run operations asynchronously
- Ability for compressing dumps