Automatically remove models using Prunable trait in Laravel 8.x

Amit Merchant · November 14, 2021 ·

I recently saw a tweet by Philo Hermans which states the slick use of a recently added Prunable trait in Laravel 8.x

Essentially, from the version 8.50.0, Laravel comes with a Prunable trait, which is when added to the models, allows to remove obsolete model records.

Using Prunable trait

For this, all you need is to add the Illuminate\Database\Eloquent\Prunable trait to the model that you want to make prunable. Next, you’ll need to implement the prunable method where you need to write the condition that determines which records to prune.

For instance, if you want to prune all the model records older than 15 days, this is how you can do so.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Prunable;
use Illuminate\Database\Eloquent\SoftDeletes;

class Post extends Model
{
    use SoftDeletes;

    use Prunable; 

    /**
     * Determines the prunable query.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function prunable()
    {
        return $this->where('created_at', '<=', now()->subDays(15));
    }
}

Once that is done, you’ll then need to schedule the db:prune artisan command in your App\Console\Kernel class like so.

/**
 * Define the application's command schedule.
 *
 * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
 * @return void
 */
protected function schedule(Schedule $schedule)
{
    $schedule->command('db:prune')->daily();
}

This will allow Laravel to scan and detect all the models that have the Prunable trait under the app/models folder and prune the model records accordingly.

The pruning method

Now, there might be a scenario where the model records might have some additional resources associated with them. Obviously, when the model records are being pruned, you also want these associated resources to be removed as well.

For this exact purpose, the pruning method can be used alongside the prunable method. This method will be called before the model is deleted.

So, for instance, if you want the associated S3 files to be deleted with the model records, this is how you can do so.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Prunable;
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Support\Facades\Storage;

class File extends Model
{
    use SoftDeletes;

    use Prunable; 

    /**
     * Determines the prunable query.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function prunable()
    {
        return $this->where('created_at', '<=', now()->subDays(15));
    }

    /**
     * Prepare the model for pruning.
     *
     * @return void
     */
    protected function pruning()
    {
        // Remove the associated file from S3 before deleting the model
        Storage::disk('s3')->delete($this->filename)
    }
}

👋 Hi there! I'm Amit. I write articles about all things web development. If you like what I write and want me to continue doing the same, I would like you buy me some coffees. I'd highly appreciate that. Cheers!

Comments?