[8.x] Add command to clean batches table

src/Illuminate/Bus/DatabaseBatchRepository.php

@@ -4,11 +4,12 @@
 
 use Carbon\CarbonImmutable;
 use Closure;
+use DateTimeInterface;
 use Illuminate\Database\Connection;
 use Illuminate\Database\Query\Expression;
 use Illuminate\Support\Str;
 
-class DatabaseBatchRepository implements BatchRepository
+class DatabaseBatchRepository implements BatchRepository, Prunable
 {
     /**
      * The batch factory instance.
@@ -243,6 +244,29 @@ public function transaction(Closure $callback)
         });
     }
 
+    /**
+     * Prune all of the entries older than the given date.
+     *
+     * @param  DateTimeInterface  $before
+     * @return int
+     */
+    public function prune(DateTimeInterface $before)
+    {
+        $query = $this->connection->table($this->table)
+            ->whereNotNull('finished_at')
+            ->where('finished_at', '<', $before->getTimestamp());
+
+        $totalDeleted = 0;
+
+        do {
+            $deleted = $query->take(1000)->delete();
+
+            $totalDeleted += $deleted;
+        } while ($deleted !== 0);
+
+        return $totalDeleted;
+    }
+
     /**
      * Convert the given raw batch to a Batch object.
      *

src/Illuminate/Bus/Prunable.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Illuminate\Bus;
+
+use DateTimeInterface;
+
+interface Prunable
+{
+    /**
+     * Prune all of the entries older than the given date.
+     *
+     * @param  DateTimeInterface  $before
+     * @return int
+     */
+    public function prune(DateTimeInterface $before);
+}

src/Illuminate/Foundation/Providers/ArtisanServiceProvider.php

@@ -67,6 +67,7 @@
 use Illuminate\Queue\Console\ForgetFailedCommand as ForgetFailedQueueCommand;
 use Illuminate\Queue\Console\ListenCommand as QueueListenCommand;
 use Illuminate\Queue\Console\ListFailedCommand as ListFailedQueueCommand;
+use Illuminate\Queue\Console\PruneBatchesCommand as PruneBatchesQueueCommand;
 use Illuminate\Queue\Console\RestartCommand as QueueRestartCommand;
 use Illuminate\Queue\Console\RetryBatchCommand as QueueRetryBatchCommand;
 use Illuminate\Queue\Console\RetryCommand as QueueRetryCommand;
@@ -107,6 +108,7 @@ class ArtisanServiceProvider extends ServiceProvider implements DeferrableProvid
         'QueueFlush' => 'command.queue.flush',
         'QueueForget' => 'command.queue.forget',
         'QueueListen' => 'command.queue.listen',
+        'QueuePruneBatches' => 'command.queue.prune-batches',
         'QueueRestart' => 'command.queue.restart',
         'QueueRetry' => 'command.queue.retry',
         'QueueRetryBatch' => 'command.queue.retry-batch',
@@ -684,6 +686,18 @@ protected function registerQueueListenCommand()
         });
     }
 
+    /**
+     * Register the command.
+     *
+     * @return void
+     */
+    protected function registerQueuePruneBatchesCommand()
+    {
+        $this->app->singleton('command.queue.prune-batches', function () {
+            return new PruneBatchesQueueCommand;
+        });
+    }
+
     /**
      * Register the command.
      *

src/Illuminate/Queue/Console/PruneBatchesCommand.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Illuminate\Queue\Console;
+
+use Carbon\Carbon;
+use Illuminate\Bus\BatchRepository;
+use Illuminate\Bus\Prunable;
+use Illuminate\Console\Command;
+
+class PruneBatchesCommand extends Command
+{
+    /**
+     * The console command signature.
+     *
+     * @var string
+     */
+    protected $signature = 'queue:prune-batches {--hours=24 : The number of hours to retain batch data}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Prune stale entries from the batches database';
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        $count = 0;
+
+        $repository = $this->laravel[BatchRepository::class];
+
+        if ($repository instanceof Prunable) {
+            $hours = $this->option('hours');
+
+            $before = Carbon::now()->subHours($hours);
+
+            $count = $repository->prune($before);
+        }
+
+        $this->info("{$count} entries deleted!");
+    }
+}