Laravel DB Snapshots is a package that allows you to create and manage snapshots (backups) of your database. This can be especially useful for maintaining backup copies of your database, restoring it to a previous state, or cloning it for testing and development environments.
Key Features:
- Create Snapshots: Quickly take snapshots of your database.
- Restore Snapshots: Restore the database to a previous state using a saved snapshot.
- Disk Storage: Store database snapshots on different disks (e.g., local, s3, etc.).
- Cross-Environment Usage: Easily clone or copy databases between environments (e.g., production to staging).
- Multiple Databases: Supports taking snapshots of multiple databases.
- Easy Integration: Simple Artisan commands for creating and restoring snapshots.
Installation
- Install the package via Composer:
bash
1composer require spatie/laravel-db-snapshots - Publish the configuration file:
bash
1php artisan vendor:publish --provider="Spatie\DbSnapshots\DbSnapshotsServiceProvider" --tag="config" - Ensure you have proper disk storage configured in your
config/filesystems.phpfor saving your snapshots. You can store the snapshots on local storage, S3, or other configured disks.
Usage
Once the package is installed, you can use Artisan commands to create, list, and restore snapshots.
1. Create a Snapshot:
To create a snapshot of your database, run the following command:
bash
|
1 |
php artisan snapshot:create my_snapshot |
This will create a snapshot with the name my_snapshot. You can specify where to save the snapshot by choosing a disk:
bash
|
1 |
php artisan snapshot:create my_snapshot --disk=s3 |
2. List All Snapshots:
To list all available snapshots, use the following command:
bash
|
1 |
php artisan snapshot:list |
3. Restore a Snapshot:
To restore a specific snapshot, use the command below:
bash
|
1 |
php artisan snapshot:restore my_snapshot |
This will restore the database using the snapshot named my_snapshot. If the snapshot is stored on a specific disk, you can specify it:
bash
|
1 |
php artisan snapshot:restore my_snapshot --disk=s3 |
4. Delete a Snapshot:
To delete a snapshot, run:
bash
|
1 |
php artisan snapshot:delete my_snapshot |
This will remove the snapshot from the storage disk.
Configuration
In the config/db-snapshots.php file, you can customize settings such as:
- Disk: Specify where to store the snapshots (
local,s3, etc.). - Database Connection: Define which database connection to use for snapshots (MySQL, SQLite, etc.).
- Compression: Enable compression for snapshots to save storage space.
Example configuration in db-snapshots.php:
php
|
1 2 3 4 5 6 7 |
return [ 'disk' => env('DB_SNAPSHOTS_DISK', 'local'), 'compress' => false, 'connection' => env('DB_SNAPSHOTS_CONNECTION', 'mysql'), ]; |
Scheduling Snapshots
You can automate snapshot creation by scheduling it in your App\Console\Kernel.php file:
php
|
1 2 3 4 |
protected function schedule(Schedule $schedule) { $schedule->command('snapshot:create daily_snapshot')->daily(); } |
This will automatically create a snapshot every day.
Restoring Snapshots to a Different Database
You can also restore snapshots to a different database connection by specifying the connection:
bash
|
1 |
php artisan snapshot:restore my_snapshot --connection=mysql_other |
This is useful when moving data between environments, such as from production to staging.
Conclusion
Laravel DB Snapshots simplifies the process of creating and managing database backups. It provides an easy way to snapshot your database, store it securely on various disks, and restore it when needed. This is an excellent tool for ensuring data safety, facilitating smooth deployments, and providing a reliable fallback mechanism in case of issues.
- Laravel Breeze – Simple authentication starter kit
- Laravel Jetstream – Scaffolding for Laravel apps
- Laravel Passport – API authentication via OAuth2
- Laravel Sanctum – Simple API authentication
- Spatie Laravel Permission – Role and permission management
- Laravel Cashier – Subscription billing with Stripe
- Laravel Scout – Full-text search using Algolia
- Laravel Socialite – OAuth authentication (Google, Facebook, etc.)
- Laravel Excel – Excel import and export for Laravel
- Laravel Horizon – Redis queues monitoring
- Laravel Nova – Admin panel for Laravel
- Laravel Fortify – Backend authentication for Laravel
- Laravel Vapor – Serverless deployment on AWS
- Laravel Telescope – Debugging assistant for Laravel
- Laravel Dusk – Browser testing
- Laravel Mix – API for compiling assets
- Spatie Laravel Backup – Backup management
- Laravel Livewire – Building dynamic UIs
- Spatie Laravel Media Library – Manage media uploads
- Laravel Excel – Excel spreadsheet handling
- Laravel Debugbar – Debug tool for Laravel
- Laravel WebSockets – Real-time communication
- Spatie Laravel Sitemap – Generate sitemaps
- Laravel Spark – SaaS scaffolding
- Laravel Envoy – Task runner for deployment
- Spatie Laravel Translatable – Multilingual model support
- Laravel Backpack – Admin panel
- Laravel AdminLTE – Admin interface template
- Laravel Collective Forms & HTML – Simplified form and HTML generation
- Spatie Laravel Analytics – Google Analytics integration
- Laravel Eloquent Sluggable – Automatically create slugs
- Laravel Charts – Chart integration
- Laravel Auditing – Track changes in models
- Laravel JWT Auth – JSON Web Token authentication
- Laravel Queue Monitor – Monitor job queues
- Spatie Laravel Query Builder – Filter, sort, and include relationships in Eloquent queries
- Laravel Datatables – jQuery Datatables API
- Laravel Localization – Multilingual support for views and routes
- Laravel Acl Manager – Access control list manager
- Laravel Activity Log – Record activity in your app
- Laravel Roles – Role-based access control
- Spatie Laravel Tags – Tagging models
- Laravel Installer – CLI installer for Laravel
- Laravel Breadcrumbs – Generate breadcrumbs in Laravel
- Laravel Mailgun – Mailgun integration for Laravel
- Laravel Trustup Model History – Store model change history
- Laravel Deployer – Deployment automation tool
- Laravel Auth – Custom authentication guards
- Laravel CORS – Cross-Origin Resource Sharing (CORS) support
- Laravel Notifications – Send notifications through multiple channels
- Spatie Laravel Http Logger – Log HTTP requests
- Laravel Permission Manager – Manage permissions easily
- Laravel Stubs – Customize default stubs in Laravel
- Laravel Fast Excel – Speed up Excel exports
- Laravel Image – Image processing
- Spatie Laravel Backup Server – Centralize backups for Laravel apps
- Laravel Forge API – Manage servers through the Forge API
- Laravel Blade SVG – Use SVGs in Blade templates
- Laravel Ban – Ban/unban users from your application
- Laravel API Response – Standardize API responses
- Laravel SEO – Manage SEO meta tags
- Laravel Settings – Store and retrieve settings
- Laravel DOMPDF – Generate PDFs
- Laravel Turbo – Full-stack framework for building modern web apps
- Spatie Laravel Event Sourcing – Event sourcing implementation
- Laravel Jetstream Inertia – Jetstream’s Inertia.js integration
- Laravel Envoy Tasks – Task automation
- Laravel Likeable – Like/dislike functionality
- Laravel GeoIP – Determine visitor’s geographic location
- Laravel Country State City – Dropdowns for country, state, and city
- Laravel Hashids – Generate short unique hashes
- Laravel Repository – Repository pattern for Laravel
- Laravel UUID – UUID generation for models
- Spatie Laravel Medialibrary Pro – Enhanced media management
- Laravel Queue Monitor – Monitor Laravel job queues
- Laravel User Activity – Monitor user activity
- Laravel DB Snapshots – Create database snapshots
- Laravel Twilio – Twilio integration
- Laravel Roles – Role-based permission handling
- Laravel Translatable – Add translations to Eloquent models
- Laravel Teamwork – Manage teams in multi-tenant apps
- Laravel Full Text Search – Add full-text search to Laravel models
- Laravel File Manager – File and media management
- Laravel User Timezones – Automatically detect user time zones
- Laravel ChartsJS – Render charts with ChartsJS
- Laravel Stripe – Stripe API integration
- Laravel PDF Generator – PDF generation
- Laravel Elasticsearch – Elasticsearch integration
- Laravel Simple Qrcode – Generate QR codes
- Laravel Timezone – Manage timezones and conversions
- Laravel Collective API – API management for Laravel
- Laravel Rest API Boilerplate – REST API starter kit
- Laravel Multi Auth – Multi-authentication functionality
- Laravel Voyager – Admin panel for Laravel
- Laravel Voyager Database – Database manager for Voyager
- Laravel Categories – Handle categories for models
- Laravel Multitenancy – Multi-tenancy implementation
- Laravel Access Control – Advanced access control for users
- Laravel Menus – Menu management
- Laravel Translatable Routes – Multilingual route handling