witty/laravel-db-backup

Easy commands to backup and restore databases for Laravel 5 applications

1.0.0 2015-12-15 10:36 UTC

Requires

• php: >=5.4.0
• illuminate/support: 5.0.* | 5.1.*

MIT

• Larkin Whitaker

README

Based off of https://github.com/schickling/laravel-backup with support for Laravel 5 and 5.1.

Installation

Update your composer.json file to include this package as a dependency

"witty/laravel-db-backup": "dev-master"

Register the service provider by adding it to the providers array in the config/app.php file.

'providers' => array(
    'Witty\LaravelDbBackup\DBBackupServiceProvider'
)

Configuration

Copy the config file into your project by running

php artisan vendor:publish

This will generate a config file like this

return [

    // add a backup folder in the app/database/ or your dump folder
    'path' => app_path() . '/database/backup/',

    // add the path to the restore and backup command of mysql
    // this exemple is if your are using MAMP server on a mac
    // on windows: 'C:\\...\\mysql\\bin\\'
    // on linux: '/usr/bin/'
    // trailing slash is required
    'mysql' => [
        'dump_command_path' => '/Applications/MAMP/Library/bin/',
        'restore_command_path' => '/Applications/MAMP/Library/bin/',
    ],

    // s3 settings
    's3' => [
        'path'  => 'your/s3/dump/folder'
    ]

    // Use GZIP compression
    'compress' => false,
];

All settings are optional and have reasonable default values.

Usage

Backup

Creates a dump file in app/storage/dumps

$ php artisan db:backup

Use specific database

$ php artisan db:backup --database=mysql

Upload to AWS S3

$ php artisan db:backup --upload-s3 your-bucket

You can use the --keep-only-s3 option if you don't want to keep a local copy of the SQL dump.

Uses the aws/aws-sdk-php-laravel package which needs to be configured.

Restore

Paths are relative to the app/storage/dumps folder.

Restore a dump

$ php artisan db:restore dump.sql

Restore from last backup dump

$ php artisan db:restore --last-dump

List dumps

$ php artisan db:restore