Laravel Spatie database backup tutorial. In this tutorial, you will learn how to backup a database in the laravel application using the Spatie Laravel backup package.
Laravel Spatie is a useful package that provides various other services but is best used for laravel database backup. The app’s database backup can be taken hourly and daily through a single command with this package.
Laravel 9 Spatie Backup with Database Dump Example
- Step 1: Download Laravel Project
- Step 2: Connect to Database
- Step 3: Add Spatie Library
- Step 3: Add Backup Email
- Step 4: Update Backup Service Provider
- Step 5: Configure Backup in Laravel
- Step 6: Clear Config Cache
- Step 7: Run Backup with PHP Artisan
Download Laravel Project
Since this tutorial is all about laravel database backup, we have to download the laravel app first.
You have to run the command to install the new laravel app and create the base of this guide.
composer create-project laravel/laravel --prefer-dist laravel-blog
Let’s invoke cd followed by your app name on the terminal to enter into the app folder.
Connect to Database
Connect the laravel application to the database; you have to insert the database details into the .env file.
DB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DATABASE=db_name DB_USERNAME=db_username DB_PASSWORD=db_password
Add Spatie Library
As mentioned earlier, we will use the spatie package for taking backup. Type the command on the console screen to install the laravel backup plugin.
composer require spatie/laravel-backup
Add Backup Email
Laravel spatie informs when the backup process is done; in this step, you have to add the email id in the .env file; this is the email where you get the backup alert.
Update Backup Service Provider
Open the config/app.php file, look for providers array, at the end of the array, add the BackupServiceProvider class as shown below.
'providers' => [ ... ... Spatie\Backup\BackupServiceProvider::class, ];
Configure Backup in Laravel
In this section, you will be configuring the laravel backup through the
php artisan vendor:publish --provider="Spatie\Backup\BackupServiceProvider"
That’s the mandatory setup you have to do to run the backup in laravel.
<?php return [ 'backup' => [ /* * The name of this application. You can use this name to monitor * the backups. */ 'name' => env('APP_NAME', 'laravel-backup'), 'source' => [ 'files' => [ /* * The list of directories and files that will be included in the backup. */ 'include' => [ base_path(), ], /* * These directories and files will be excluded from the backup. * * Directories used by the backup process will automatically be excluded. */ 'exclude' => [ base_path('vendor'), base_path('node_modules'), ], /* * Determines if symlinks should be followed. */ 'follow_links' => false, /* * Determines if it should avoid unreadable folders. */ 'ignore_unreadable_directories' => false, /* * This path is used to make directories in resulting zip-file relative * Set to `null` to include complete absolute path * Example: base_path() */ 'relative_path' => null, ], /* * The names of the connections to the databases that should be backed up * MySQL, PostgreSQL, SQLite and Mongo databases are supported. * * The content of the database dump may be customized for each connection * by adding a 'dump' key to the connection settings in config/database.php. * E.g. * 'mysql' => [ * ... * 'dump' => [ * 'excludeTables' => [ * 'table_to_exclude_from_backup', * 'another_table_to_exclude' * ] * ], * ], * * If you are using only InnoDB tables on a MySQL server, you can * also supply the useSingleTransaction option to avoid table locking. * * E.g. * 'mysql' => [ * ... * 'dump' => [ * 'useSingleTransaction' => true, * ], * ], * * For a complete list of available customization options, see https://github.com/spatie/db-dumper */ 'databases' => [ 'mysql', ], ], /* * The database dump can be compressed to decrease diskspace usage. * * Out of the box Laravel-backup supplies * Spatie\DbDumper\Compressors\GzipCompressor::class. * * You can also create custom compressor. More info on that here: * https://github.com/spatie/db-dumper#using-compression * * If you do not want any compressor at all, set it to null. */ 'database_dump_compressor' => null, /* * The file extension used for the database dump files. * * If not specified, the file extension will be .archive for MongoDB and .sql for all other databases * The file extension should be specified without a leading . */ 'database_dump_file_extension' => '', 'destination' => [ /* * The filename prefix used for the backup zip file. */ 'filename_prefix' => '', /* * The disk names on which the backups will be stored. */ 'disks' => [ 'local', ], ], /* * The directory where the temporary files will be stored. */ 'temporary_directory' => storage_path('app/backup-temp'), /* * The password to be used for archive encryption. * Set to `null` to disable encryption. */ 'password' => env('BACKUP_ARCHIVE_PASSWORD'), /* * The encryption algorithm to be used for archive encryption. * You can set it to `null` or `false` to disable encryption. * * When set to 'default', we'll use ZipArchive::EM_AES_256 if it is * available on your system. */ 'encryption' => 'default', ], /* * You can get notified when specific events occur. Out of the box you can use 'mail' and 'slack'. * For Slack you need to install laravel/slack-notification-channel. * * You can also use your own notification classes, just make sure the class is named after one of * the `Spatie\Backup\Events` classes. */ 'notifications' => [ 'notifications' => [ \Spatie\Backup\Notifications\Notifications\BackupHasFailedNotification::class => ['mail'], \Spatie\Backup\Notifications\Notifications\UnhealthyBackupWasFoundNotification::class => ['mail'], \Spatie\Backup\Notifications\Notifications\CleanupHasFailedNotification::class => ['mail'], \Spatie\Backup\Notifications\Notifications\BackupWasSuccessfulNotification::class => ['mail'], \Spatie\Backup\Notifications\Notifications\HealthyBackupWasFoundNotification::class => ['mail'], \Spatie\Backup\Notifications\Notifications\CleanupWasSuccessfulNotification::class => ['mail'], ], /* * Here you can specify the notifiable to which the notifications should be sent. The default * notifiable will use the variables specified in this config file. */ 'notifiable' => \Spatie\Backup\Notifications\Notifiable::class, 'mail' => [ 'to' => 'email@example.com', 'from' => [ 'address' => env('MAIL_FROM_ADDRESS', 'firstname.lastname@example.org'), 'name' => env('MAIL_FROM_NAME', 'Example'), ], ], 'slack' => [ 'webhook_url' => '', /* * If this is set to null the default channel of the webhook will be used. */ 'channel' => null, 'username' => null, 'icon' => null, ], 'discord' => [ 'webhook_url' => '', 'username' => null, 'avatar_url' => null, ], ], /* * Here you can specify which backups should be monitored. * If a backup does not meet the specified requirements the * UnHealthyBackupWasFound event will be fired. */ 'monitor_backups' => [ [ 'name' => env('APP_NAME', 'laravel-backup'), 'disks' => ['local'], 'health_checks' => [ \Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumAgeInDays::class => 1, \Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumStorageInMegabytes::class => 5000, ], ], /* [ 'name' => 'name of the second app', 'disks' => ['local', 's3'], 'health_checks' => [ \Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumAgeInDays::class => 1, \Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumStorageInMegabytes::class => 5000, ], ], */ ], 'cleanup' => [ /* * The strategy that will be used to cleanup old backups. The default strategy * will keep all backups for a certain amount of days. After that period only * a daily backup will be kept. After that period only weekly backups will * be kept and so on. * * No matter how you configure it the default strategy will never * delete the newest backup. */ 'strategy' => \Spatie\Backup\Tasks\Cleanup\Strategies\DefaultStrategy::class, 'default_strategy' => [ /* * The number of days for which backups must be kept. */ 'keep_all_backups_for_days' => 7, /* * The number of days for which daily backups must be kept. */ 'keep_daily_backups_for_days' => 16, /* * The number of weeks for which one weekly backup must be kept. */ 'keep_weekly_backups_for_weeks' => 8, /* * The number of months for which one monthly backup must be kept. */ 'keep_monthly_backups_for_months' => 4, /* * The number of years for which one yearly backup must be kept. */ 'keep_yearly_backups_for_years' => 2, /* * After cleaning up the backups remove the oldest backup until * this amount of megabytes has been reached. */ 'delete_oldest_backups_when_using_more_megabytes_than' => 5000, ], ], ];
Clear Config Cache
To profoundly run the backup, you have to clear all of your application’s configurations files, and this can be done via config:cache Artisan command.
php artisan config:clear
Run Backup with PHP Artisan
Ultimately, make a request to run the backup using the suggested command.
php artisan backup:run
In this tutorial, we went through essentials steps and learned how to take database backup of the laravel application using the Laravel spatie library.