This package provides Artisan commands to quickly dump and load databases in a Laravel application.
# Create a dump
php artisan snapshot:create my-first-dump
# Make some changes to your db
# ...
# Create another dump
php artisan snapshot:create my-second-dump
# Load up the first dump
php artisan snapshot:load my-first-dump
# Load up the latest dump
php artisan snapshot:load --latest
# List all snapshots
php artisan snapshot:list
# Remove old snapshots. Keeping only the most recent
php artisan snapshot:cleanup --keep=2This package supports MySQL, PostgreSQL and SQLite.
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
For PHP 7.x and/or Laravel 6.x, use v1.x of this package.
You can install the package via Composer:
composer require spatie/laravel-db-snapshotsYou should add a disk named snapshots to app/config/filesystems.php on which the snapshots will be saved. This would be a typical configuration:
// ...
'disks' => [
// ...
'snapshots' => [
'driver' => 'local',
'root' => database_path('snapshots'),
],
// ... Optionally, you may publish the configuration file with:
php artisan vendor:publish --provider="Spatie\DbSnapshots\DbSnapshotsServiceProvider" --tag="config"This is the content of the published file:
return [
/**
* The name of the disk on which the snapshots are stored.
*/
'disk' => 'snapshots',
/**
* The connection to be used to create snapshots. Set this to null
* to use the default configured in `config/database.php`
*/
'default_connection' => null,
/**
* The directory where temporary files will be stored.
*/
'temporary_directory_path' => storage_path('app/laravel-db-snapshots/temp'),
/*
* Create dump files that are gzipped
*/
'compress' => false,
/*
* Only these tables will be included in the snapshot. Set to `null` to include all tables.
*
* Default: `null`
*/
'tables' => null,
];To create a snapshot (which is just a dump from the database) run:
php artisan snapshot:create my-first-dumpGiving your snapshot a name is optional. If you don't pass a name the current date time will be used:
# Creates a snapshot named something like `2017-03-17 14:31`
php artisan snapshot:createMaybe you only want to snapshot a couple of tables. You can do this by passing the --table multiple times or as a comma separated list:
# Bot commands create a snapshot containing only the posts and users tables:
php artisan snapshot:create --table=posts,users
php artisan snapshot:create --table=posts --table=usersWhen creating snapshots, you can optionally create compressed snapshots. To do this either pass the --compress option on the command line, or set the db-snapshots.compress configuration option to true:
# Creates a snapshot named my-compressed-dump.sql.gz
php artisan snapshot:create my-compressed-dump --compressAfter you've made some changes to the database you can create another snapshot:
php artisan snapshot:create my-second-dumpTo load a previous dump issue this command:
php artisan snapshot:load my-first-dumpTo load a previous dump to another DB connection:
php artisan snapshot:load my-first-dump --connection=connectionNameBy default, snapshot:load will drop all existing tables in the database. If you don't want this behaviour, you can pass the --drop-tables=0 option:
php artisan snapshot:load my-first-dump --drop-tables=0To list all the dumps run:
php artisan snapshot:listA dump can be deleted with:
php artisan snapshot:delete my-first-dumpTo remove all backups except the most recent 2
php artisan snapshot:cleanup --keep=2If you need to pass extra options to the underlying db-dumper, add a dump key to the database connection with a key of addExtraOptions and a value of the option. For example, to prevent the Postgres db dumper from setting the owner, you'd add:
'dump' => [
'addExtraOption' => '--no-owner',
],
To the pgsql connection in database.php
There are several events fired which can be used to perform some logic of your own:
Spatie\DbSnapshots\Events\CreatingSnapshot: will be fired before a snapshot is createdSpatie\DbSnapshots\Events\CreatedSnapshot: will be fired after a snapshot has been createdSpatie\DbSnapshots\Events\LoadingSnapshot: will be fired before a snapshot is loadedSpatie\DbSnapshots\Events\LoadedSnapshot: will be fired after a snapshot has been loadedSpatie\DbSnapshots\Events\DeletingSnapshot: will be fired before a snapshot is deletedSpatie\DbSnapshots\Events\DeletedSnapshot: will be fired after a snapshot has been deleted
composer testPlease see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.