Download the PHP package amdadulhaq/database-backup-laravel without Composer

Database Backup for Laravel

Simple database backups for Laravel. Dumps one PostgreSQL or MySQL / MariaDB connection (SQLite also supported) and stores it on any Laravel filesystem disk — the local disk by default, or an S3-compatible API such as Cloudflare R2, MinIO, DigitalOcean Spaces, Backblaze B2 or AWS S3.

Requirements

• PHP 8.2, 8.3, 8.4, or 8.5
• Laravel 12 or 13
• PHP extensions intl and zlib; pdo_sqlite with SQLite 3.27+ for SQLite backups
• pg_dump for PostgreSQL, mysqldump for MySQL/MariaDB (SQLite needs neither)
• league/flysystem-aws-s3-v3 when the destination disk is an S3 disk

Installation

You can install the package via composer:

Publish the config file:

The service provider is auto-discovered.

Destination disk

Any disk from config/filesystems.php works. Point DB_BACKUP_DISK at it.

AWS S3

Cloudflare R2

MinIO

DigitalOcean Spaces

Backblaze B2 (S3-compatible)

Local / any other disk

Usage

Schedule it in routes/console.php:

Restore

The file is pulled from the backup disk, gunzipped if needed, then piped into psql / mysql (a SQLite file is swapped in atomically and its stale -wal / -shm files are removed). PostgreSQL restores run in a single transaction with ON_ERROR_STOP, and the default pg_dump options include --clean --if-exists so a restore drops existing objects first. MySQL restores stop at the first error; mysqldump emits DROP TABLE IF EXISTS for every table in the dump, but tables that exist in the target and not in the backup are left in place.

MySQL / MariaDB restores are not transactional. DDL (DROP / CREATE TABLE) commits immediately, so a restore that fails halfway leaves the database partially restored. Take a fresh backup before restoring.

The backup's type must match the connection: a .sql[.gz] file for pgsql / mysql / mariadb, a .sqlite[.gz] file for sqlite.

Configuration (config/database-backup.php / env)

Backups are stored per connection as {path}/{connection}/{connection}-{database}-{Y-m-d_His}.sql (.sqlite for SQLite, .gz appended when compression is on). A short random suffix keeps backups started in the same second apart, and a .sha256 checksum is stored next to each backup and verified before a restore. The folder uses the connection name as-is. Backups written by older releases directly into {path}/ are still listed, restored and pruned when their name matches the connection and database exactly.

Connections are resolved like Laravel does: url / DB_URL is expanded, and for read/write splits the write host is used. PostgreSQL sslmode, sslcert, sslkey and sslrootcert are passed to pg_dump / psql; MySQL SSL PDO options (PDO::MYSQL_ATTR_SSL_CA, _CERT, _KEY, _CAPATH, _CIPHER, _VERIFY_SERVER_CERT) become --ssl-* flags. The MySQL password is passed in a private option file (--defaults-extra-file), not the environment. Local dump files are created with mode 0600 in a per-user 0700 temp directory.

Events

• AmdadulHaq\DatabaseBackup\Events\BackupCompleted — connection, disk, remotePath, bytes
• AmdadulHaq\DatabaseBackup\Events\BackupFailed — connection, exception
• AmdadulHaq\DatabaseBackup\Events\BackupPruneFailed — connection, exception (the backup itself succeeded)
• AmdadulHaq\DatabaseBackup\Events\BackupChecksumFailed — connection, remotePath, exception (the backup itself succeeded)
• AmdadulHaq\DatabaseBackup\Events\RestoreCompleted — connection, disk, remotePath
• AmdadulHaq\DatabaseBackup\Events\RestoreFailed — connection, exception

Drivers

Each database type is a small class implementing the Dumper contract (src/Dumpers/) and the Restorer contract (src/Restorers/):

Testing

The integration tests back up and restore a real MySQL, MariaDB or PostgreSQL server; they are skipped unless DB_BACKUP_IT_DRIVER is set:

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

• Amdadul Haq

License

The MIT License (MIT). Please see License File for more information.