https://github.com/watheqalshowaiter/backup-tables
Backup single or multiple database tables with ease.
https://github.com/watheqalshowaiter/backup-tables
laravel laravel-package model mysql php php-package postgresql sql sqlite sqlserver yemenopensource
Last synced: 26 days ago
JSON representation
Backup single or multiple database tables with ease.
- Host: GitHub
- URL: https://github.com/watheqalshowaiter/backup-tables
- Owner: WatheqAlshowaiter
- License: mit
- Created: 2024-08-19T16:10:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-06T10:11:26.000Z (10 months ago)
- Last Synced: 2025-02-10T19:03:50.154Z (9 months ago)
- Topics: laravel, laravel-package, model, mysql, php, php-package, postgresql, sql, sqlite, sqlserver, yemenopensource
- Language: PHP
- Homepage: https://packagist.org/packages/watheqalshowaiter/backup-tables
- Size: 370 KB
- Stars: 26
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Backup Tables
[![Required Laravel Version][ico-laravel]][link-packagist]
[![Required PHP Version][ico-php]][link-packagist]
[![Latest Version on Packagist][ico-version]][link-packagist]
![GitHub Tests For Laravel Versions Action Status][ico-tests-for-laravel-versions]
![GitHub Tests For Databases Action Status][ico-tests-for-databases]
![GitHub Code Style Action Status][ico-code-style]
[![Total Downloads][ico-downloads]][link-downloads]
![GitHub Stars][ico-github-stars]
[![StandWithPalestine][ico-palestine]][link-palestine]
[ico-laravel]: https://img.shields.io/badge/Laravel-%E2%89%A56.0-ff2d20?style=flat-square&logo=laravel
[ico-php]: https://img.shields.io/packagist/php-v/watheqalshowaiter/backup-tables?color=%238892BF&style=flat-square&logo=php
[ico-version]: https://img.shields.io/packagist/v/watheqalshowaiter/backup-tables.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/watheqalshowaiter/backup-tables.svg?style=flat-square&color=%23007ec6
[ico-code-style]: https://img.shields.io/github/actions/workflow/status/watheqalshowaiter/backup-tables/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square
[ico-tests-for-laravel-versions]: https://img.shields.io/github/actions/workflow/status/watheqalshowaiter/backup-tables/tests-for-laravel-versions.yml?branch=main&label=laravel%20versions%20tests&style=flat-square
[ico-tests-for-databases]: https://img.shields.io/github/actions/workflow/status/watheqalshowaiter/backup-tables/tests-for-databases.yml?branch=main&label=databases%20tests&style=flat-square
[ico-github-stars]: https://img.shields.io/github/stars/watheqalshowaiter/backup-tables?style=flat-square
[ico-palestine]: https://raw.githubusercontent.com/TheBSD/StandWithPalestine/main/badges/StandWithPalestine.svg
[link-packagist]: https://packagist.org/packages/watheqalshowaiter/backup-tables
[link-downloads]: https://packagist.org/packages/watheqalshowaiter/backup-tables/stats
[link-palestine]: https://github.com/TheBSD/StandWithPalestine/blob/main/docs/README.md
Backup single or multiple database tables with ease.
> [!NOTE]
> If you want a full database backup with many features, go
> for [Spatie Laravel Backup](https://github.com/spatie/laravel-backup).
## Installation
You can install the package via Composer:
```sh
composer require watheqalshowaiter/backup-tables
```
## Usage
Use the `BackupTables::generateBackup($tableToBackup)` Facade anywhere in your application and it will
generate `$tableToBackup_backup_2024_08_22_17_40_01` table in the database with all the data and structure. Note that
the datetime `2024_08_22_17_40_01` will be varied based on your datetime.
You can also use the `php artisan backup:tables ` command to back up tables,
where `` is a space-separated list of table names or models.
```php
use WatheqAlshowaiter\BackupTables\BackupTables; // import the facade
class ChangeSomeData
{
public function handle()
{
BackupTables::generateBackup('users');
// result: users_backup_2024_08_22_17_40_01
// change some data..
}
}
```
And More Customizations
- You can use an array to back up more than one table
```php
BackupTables::generateBackup(['users', 'posts']);
// users_backup_2024_08_22_17_40_01
// posts_backup_2024_08_22_17_40_01
```
- Or add Classes as parameters, It will backup their tables
```php
BackupTables::generateBackup(User::class);
// users_backup_2024_08_22_17_40_01
// or
BackupTables::generateBackup([User::class, Post::class]);
// users_backup_2024_08_22_17_40_01, posts_backup_2024_08_22_17_40_01
```
- You can customize the $dataTime format to whatever you want
```php
BackupTables::generateBackup('users', 'Y_d_m_H_i');
// users_backup_2024_22_08_17_40
```
> [!WARNING]
> When customizing the datetime format, be aware that backups with identical datetime values will be skipped.
> For example, if you use this `Y_d_m_H` you cannot generate the same backup in the same hour.
> The default format (Y_m_d_H_i_s) is recommended for most cases.
```php
BackupTables::generateBackup('users', 'Y_d_m_H');
// can not generate the same backup in the same hour
BackupTables::generateBackup('users', 'Y_d_m');
// can not generate the same backup in the same day
```
- Using the artisan command for one or more tables/models
```bash
php artisan backup:tables users posts
# users_backup_2024_08_22_17_40_01, posts_backup_2024_08_22_17_40_01
php artisan backup:tables \\App\\Models\\User \\App\\Models\\Post
# users_backup_2024_08_22_17_40_01, posts_backup_2024_08_22_17_40_01
```
## Why?
Sometimes you want to back up some database tables before changing data for whatever reason, this package serves this
need.
I used it personally before adding foreign keys to tables that required removing unlinked fields from parent tables.
You may find some situation where you play with table data, or you're afraid of missing data, so you back up these
tables
beforehand.
## Features
✅ Backup tables from the code using (Facade) or from the console command.
✅ Supports Laravel versions: 12, 11, 10, 9, 8, 7, and 6.
✅ Supports PHP versions: 8.4, 8.3, 8.2, 8.1, 8.0, and 7.4.
✅ Supports SQL databases: SQLite, MySQL/MariaDB, PostgreSQL, and SQL Server.
✅ Fully automated tested with PHPUnit.
✅ Full GitHub Action CI pipeline to format code and test against all Laravel and PHP versions.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on recent changes.
## Contributing
If you have any ideas or suggestions to improve it or fix bugs, your contribution is welcome.
I encourage you to look at [issues](https://github.com/WatheqAlshowaiter/backup-tables/issues) which are the most
important features
that need to be added.
If you have something different, submit an issue first to discuss or report a bug, then do a pull request.
## Security Vulnerabilities
If you find any security vulnerabilities don't hesitate to contact me at `watheqalshowaiter[at]gmail[dot]com` to fix
them.
## Related Packages
- **[Model Fields](https://github.com/WatheqAlshowaiter/model-fields)** - Quickly retrieve required, nullable, and default fields for any Laravel model.
- **[Filament Sticky Table Header](https://github.com/WatheqAlshowaiter/filament-sticky-table-header)** - Make Filament table headers stick when scrolling for better UX.
## Credits
- [Watheq Alshowaiter](https://github.com/WatheqAlshowaiter)
- [Omar Alalwi](https://github.com/omaralalwi) - This package is based on his initial code.
- [All Contributors](https://github.com/WatheqAlshowaiter/backup-tables/graphs/contributors)
And a special thanks to [The King Creative](https://www.facebook.com/thkingcreative) for the logo ✨
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.