Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tighten/quicksand
Easily schedule regular cleanup of old soft-deleted Eloquent data.
https://github.com/tighten/quicksand
eloquent hacktoberfest laravel pivot-tables quicksand
Last synced: 2 days ago
JSON representation
Easily schedule regular cleanup of old soft-deleted Eloquent data.
- Host: GitHub
- URL: https://github.com/tighten/quicksand
- Owner: tighten
- License: mit
- Archived: true
- Created: 2016-07-07T16:42:55.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-03-12T12:09:13.000Z (8 months ago)
- Last Synced: 2024-10-12T00:14:21.164Z (24 days ago)
- Topics: eloquent, hacktoberfest, laravel, pivot-tables, quicksand
- Language: PHP
- Homepage:
- Size: 335 KB
- Stars: 295
- Watchers: 18
- Forks: 18
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-laravel-framework - QuickSand - Easily schedule regular cleanup of old soft-deleted Eloquent data (Popular Packages)
README
# Quicksand
Schedule a force delete of your soft deleted Eloquent models or pivot tables after they've been soft deleted for a given period of time.
Quicksand is an Artisan command that you can run in your scheduler daily.
## Requirements
- If you are using Laravel 5.6 or higher, use version `2.0` of this package.
- If you are using Laravel 5.5 and running PHP 7.1 or higher, use version `1.0` of this package.
- If you are using Laravel 5.4 or lower, or PHP 7.0 or lower, please use version `0.2` of this package.
## Installation
1. Add Quicksand to your Composer file: `composer require tightenco/quicksand`
2. Register the Quicksand Service provider in `config/app.php` (you can skip this step if you're using Laravel 5.5 or higher due to package auto-discovery):
```php
'providers' => [
...
Tightenco\Quicksand\QuicksandServiceProvider::class,
```
3. Publish your config: `php artisan vendor:publish --provider="Tightenco\Quicksand\QuicksandServiceProvider"`
4. Edit your config. Define which classes and/or pivot tables you'd like to have Quicksand clean up for you, how many days Quicksand should wait to clean up, and whether or not the results should be logged. The default `'days'` until cleaning up is overridable by specifying a `'days'` key when registering a model or pivot table:
1. _Note: Quicksand will disregard any global scopes applied to models when deleting._
2. _Note: Prior to version 2.3 the `deletables` configuration key was named `models` and did not support pivot tables._
```php
'days' => 30,
'deletables' => [
App\Default::class,
App\CleanEveryTwentyDays::class => [
'days' => 20 // override default 'days'
],
'example_pivot',
'example_pivot' => [
'days' => 20 // override default 'days'
]
]
```
5. Schedule the command in `app/Console/Kernel.php`:
```php
protected function schedule(Schedule $schedule)
{
$schedule->command('quicksand:run')
->daily();
}
```
### Using a Custom Log File
If you are using Laravel 5.6 or higher, you can customize the logger Quicksand uses by adding a `quicksand` channel to your `logging.php` config file like so:
```php
'channels' => [
/* ... */
'quicksand' => [
'driver' => 'single',
'path' => storage_path('logs/quicksand.log'),
'level' => 'info',
],
]
```
If you are using Laravel 5.5 or lower, you can customize the logger Quicksand uses by editing the `custom_log_file` option in your `quicksand.php` config file.
By default, Quicksand will log to the standard `laravel.log` file.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/tighten/quicksand/tags).
## Authors
* **Benson Lee** - [besologic](https://github.com/besologic)
* **Matt Stauffer** - [mattstauffer](https://github.com/mattstauffer)
See also the list of [contributors](https://github.com/tighten/quicksand/graphs/contributors) who participated in this project.
This package is developed and maintained by [Tighten](https://tighten.co).
## Testing
You can test this package by running
```
composer test
```
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details