PHPackages                             paulvl/backup - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. paulvl/backup

ActiveLibrary[Database & ORM](/categories/database)

paulvl/backup
=============

Database backup package for laravel

v4.0.2(5y ago)7987.9k↓35.7%30[3 PRs](https://github.com/paulvl/backup/pulls)2MITPHPPHP >=5.5.9

Since Oct 25Pushed 4y ago2 watchersCompare

[ Source](https://github.com/paulvl/backup)[ Packagist](https://packagist.org/packages/paulvl/backup)[ RSS](/packages/paulvl-backup/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (3)Versions (24)Used By (2)

Backup
------

[](#backup)

Backup is a Laravel package that allow the creation and restoration of database backups in an easy way.

> New version 4.\* works with laravel 8

[![Latest Stable Version](https://camo.githubusercontent.com/7ee7ba65011d3f0ef1fab2e4c19b5b98db04761482516d91b0642972465c216d/68747470733a2f2f706f7365722e707567782e6f72672f7061756c766c2f6261636b75702f762f737461626c65)](https://packagist.org/packages/paulvl/backup) [![Latest Unstable Version](https://camo.githubusercontent.com/3aca42e10bad0b6ed9c919dfd72d19d43da00cad001aa42c41e97da87887a399/68747470733a2f2f706f7365722e707567782e6f72672f7061756c766c2f6261636b75702f762f756e737461626c65)](https://packagist.org/packages/paulvl/backup) [![License](https://camo.githubusercontent.com/5d1970d2b8fdd37730c8a35b38aa62b44c076e360fc3f337b39e2ec4af8225db/68747470733a2f2f706f7365722e707567782e6f72672f7061756c766c2f6261636b75702f6c6963656e7365)](https://packagist.org/packages/paulvl/backup) [![Total Downloads](https://camo.githubusercontent.com/19c3a08ea49a3bc43e48bc97ce3325630d7bd5365b0f15f8804850b98c61ab42/68747470733a2f2f706f7365722e707567782e6f72672f7061756c766c2f6261636b75702f646f776e6c6f616473)](https://packagist.org/packages/paulvl/backup)

**Quick Installation**
----------------------

[](#quick-installation)

Begin by installing this package through Composer.

You can run:

```
composer require paulvl/backup 4.*

```

Or edit your project's composer.json file to require paulvl/backup.

```
    "require": {
        "paulvl/backup": "4.*"
    }

```

Next, update Composer from the Terminal:

```
composer update

```

Once the package's installation completes, the final step is to add the service provider. Open `config/app.php`, and add a new item to the providers array:

```
Backup\BackupServiceProvider::class,

```

Finally publish package's configuration file:

```
php artisan vendor:publish --provider="Backup\BackupServiceProvider" --tag="config"

```

Then the file `config/backup.php` will be created.

That's it! You're ready to go. Run the artisan command from the Terminal to see the new `backup` commands.

```
php artisan

```

**Mysql commands**
------------------

[](#mysql-commands)

### **mysql-dump** - Creating a backup

[](#mysql-dump----creating-a-backup)

To make a backup of you current aplication's database you have to run:

```
php artisan backup:mysql-dump

```

This will create an `.sql` file on your configured `local-storage.path` like `/this/is/my/path/dbname_20150101201505.sql`, this file is named using current datetime. If you want a custom name run:

```
php artisan backup:mysql-dump custom_name

```

This will create an `.sql` file on your configured `local-storage.path` like `/this/is/my/path/custom_name.sql`

#### **--connection=mysql** - Specify database connection name

[](#--connectionmysql----specify-database-connection-name)

Specify the database connection name, it uses the primary connection name by default.

```
php artisan backup:mysql-dump --connection=custom-connection

```

#### **--compress** - Enable file compression

[](#--compress----enable-file-compression)

> From versión *4.*\* compress option use *gzenconde*. To have your previous compressed files working with this versión see [fix-file](#fix-file----fix-backup-file-encoding-mode) command

Enable file compression regardless if is disabled in the configuration file. This option will always overwrite `--no-compress` option

```
php artisan backup:mysql-dump --compress

```

#### **--no-compress** - Disable file compression

[](#--no-compress----disable-file-compression)

Disable file compression regardless if is enabled in the configuration file. This option will be always overwrited by `--compress` option

```
php artisan backup:mysql-dump --no-compress

```

### **mysql-restore** - Restoring database from a file

[](#mysql-restore----restoring-database-from-a-file)

> From versión *4.*\* compress option use *gzenconde*. To have your previous compressed files working with this versión see [fix-file](#fix-file----fix-backup-file-encoding-mode) command

To restore a backup to your current aplication's database you have to run:

```
php artisan mysql:restore filename

```

This will display a list of your current backup files stored on your configured `local-storage.disk`.

#### **--filename | -f** - Especifiy a backup file name

[](#--filename---f----especifiy-a-backup-file-name)

Especifiy a backup file name

```
php artisan backup:mysql-restore --filename=backup_filename

```

#### **--all-backup-files | -A** - Display all backup files

[](#--all-backup-files---a----display-all-backup-files)

Display all available backup files on disk. By default displays files for current connection's database.

```
php artisan backup:mysql-restore --all-backup-files

```

#### **--from-cloud | -C** - Use cloud disk

[](#--from-cloud---c----use-cloud-disk)

Display a list of backup files from cloud disk.

```
php artisan backup:mysql-restore --from-cloud

```

#### **--restore-latest-backup | -L** - Restore latest backup file

[](#--restore-latest-backup---l----restore-latest-backup-file)

Use latest backup file to restore database.

```
php artisan backup:mysql-restore --restore-latest-backup

```

#### **--yes | -y** - Confirms restoration action

[](#--yes---y----confirms-restoration-action)

Confirms database restoration without asking.

```
php artisan backup:mysql-restore --yes

```

### **fix-file** - Fix backup file encoding mode

[](#fix-file----fix-backup-file-encoding-mode)

> Prior to version *4.*\* all backup files generated with compression option where compressed using *gzenconde*, by this the generated file was unable to use with any other uncompression software. Thats why we now use *gzencode* instead which is friendly to external software.

To fix the encoding mode of a compressed backup file you have to run:

```
php artisan mysql:fix-file

```

This will display a list of your current compressed backup files stored on your configured `local-storage.disk`.

#### **--filename | -f** - Especifiy a backup file name

[](#--filename---f----especifiy-a-backup-file-name-1)

Especifiy a backup file name

```
php artisan backup:fix-file --filename=backup_filename

```

#### **--from-cloud | -C** - Use cloud disk

[](#--from-cloud---c----use-cloud-disk-1)

Display a list of backup files from cloud disk.

```
php artisan backup:fix-file --from-cloud

```

#### **--yes | -y** - Confirms fixing action

[](#--yes---y----confirms-fixing-action)

Confirms file fixing without asking.

```
php artisan backup:fix-file --yes

```

### **Programing backups**

[](#programing-backups)

If you need to perform a backup for example, every day at midnight, at this like to yor schedule function on `app/Console/Commands/Kernel.php`:

```
protected function schedule(Schedule $schedule)
{
...
    $schedule->command('backup:mysql-dump')->dailyAt('00:00');
...
}

```

**Contribute and share ;-)**
----------------------------

[](#contribute-and-share--)

If you like this little piece of code share it with you friends and feel free to contribute with any improvements.

###  Health Score

42

—

FairBetter than 90% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity45

Moderate usage in the ecosystem

Community23

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 68.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~88 days

Total

22

Last Release

1997d ago

Major Versions

1.1.7 → 2.0.02016-01-08

1.1.8 → 3.0.02017-02-23

v3.1.1 → v4.0.02020-11-28

### Community

Maintainers

![](https://www.gravatar.com/avatar/8fdef0e996f65b82fd2c344429cd17177695635620eb34908c87dfbccd062fe0?d=identicon)[paulvl](/maintainers/paulvl)

---

Top Contributors

[![paulvl](https://avatars.githubusercontent.com/u/8441051?v=4)](https://github.com/paulvl "paulvl (15 commits)")[![ian-nisbet](https://avatars.githubusercontent.com/u/25204253?v=4)](https://github.com/ian-nisbet "ian-nisbet (3 commits)")[![carusogabriel](https://avatars.githubusercontent.com/u/16328050?v=4)](https://github.com/carusogabriel "carusogabriel (1 commits)")[![Dylan-DPC](https://avatars.githubusercontent.com/u/99973273?v=4)](https://github.com/Dylan-DPC "Dylan-DPC (1 commits)")[![geekcom](https://avatars.githubusercontent.com/u/3955933?v=4)](https://github.com/geekcom "geekcom (1 commits)")[![joshuadegier](https://avatars.githubusercontent.com/u/2580917?v=4)](https://github.com/joshuadegier "joshuadegier (1 commits)")

---

Tags

backupbackup-filesbasededatosbdcopia-de-seguridaddatabasedatabase-backupdatabase-backupsdumplaravellaravel-frameworklaravel-packagelaravel8mysqlmysql-restoremysqldumprestorationrestorerestore-database

### Embed Badge

![Health badge](/badges/paulvl-backup/health.svg)

```
[![Health](https://phpackages.com/badges/paulvl-backup/health.svg)](https://phpackages.com/packages/paulvl-backup)
```

###  Alternatives

[spatie/laravel-backup

A Laravel package to backup your application

6.0k21.8M191](/packages/spatie-laravel-backup)[tucker-eric/eloquentfilter

An Eloquent way to filter Eloquent Models

1.8k4.8M26](/packages/tucker-eric-eloquentfilter)[laravel-doctrine/orm

An integration library for Laravel and Doctrine ORM

8425.3M87](/packages/laravel-doctrine-orm)[ryangjchandler/orbit

A flat-file database driver for Eloquent.

922256.2k5](/packages/ryangjchandler-orbit)[clickbar/laravel-magellan

This package provides functionality for working with the postgis extension in Laravel.

423715.4k1](/packages/clickbar-laravel-magellan)[cybercog/laravel-clickhouse

ClickHouse migrations for Laravel

163166.8k](/packages/cybercog-laravel-clickhouse)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)