[8.x] Add command to clean batches table

src/Illuminate/Bus/DatabaseBatchRepository.php

@@ -4,6 +4,7 @@
 
 use Carbon\CarbonImmutable;
 use Closure;
+use DateTimeInterface;
 use Illuminate\Database\Connection;
 use Illuminate\Database\Query\Expression;
 use Illuminate\Support\Str;
@@ -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/Foundation/Providers/ArtisanServiceProvider.php

@@ -63,6 +63,7 @@
 use Illuminate\Queue\Console\BatchesTableCommand;
 use Illuminate\Queue\Console\ClearCommand as QueueClearCommand;
 use Illuminate\Queue\Console\FailedTableCommand;
+use Illuminate\Queue\Console\FlushBatchCommand as FlushBatchQueueCommand;
 use Illuminate\Queue\Console\FlushFailedCommand as FlushFailedQueueCommand;
 use Illuminate\Queue\Console\ForgetFailedCommand as ForgetFailedQueueCommand;
 use Illuminate\Queue\Console\ListenCommand as QueueListenCommand;
@@ -105,6 +106,7 @@ class ArtisanServiceProvider extends ServiceProvider implements DeferrableProvid
         'QueueClear' => 'command.queue.clear',
         'QueueFailed' => 'command.queue.failed',
         'QueueFlush' => 'command.queue.flush',
+        'QueueFlushBatch' => 'command.queue.flush-batch',
         'QueueForget' => 'command.queue.forget',
         'QueueListen' => 'command.queue.listen',
         'QueueRestart' => 'command.queue.restart',
@@ -672,6 +674,18 @@ protected function registerQueueFlushCommand()
         });
     }
 
+    /**
+     * Register the command.
+     *
+     * @return void
+     */
+    protected function registerQueueFlushBatchCommand()
+    {
+        $this->app->singleton('command.queue.flush-batch', function () {
+            return new FlushBatchQueueCommand;
+        });
+    }
+
     /**
      * Register the command.
      *

src/Illuminate/Queue/Console/FlushBatchCommand.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Illuminate\Queue\Console;
+
+use Carbon\Carbon;
+use Illuminate\Bus\BatchRepository;
+use Illuminate\Console\Command;
+
+class FlushBatchCommand extends Command
+{
+    /**
+     * The console command signature.
+     *
+     * @var string
+     */
+    protected $signature = 'queue:flush-batch {--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 (method_exists($repository, 'prune')) {
+            $hours = $this->option('hours');
+
+            $before = Carbon::now()->subHours($hours);
+
+            $count = $repository->prune($before);
+        }
+
+        $this->info("{$count} entries deleted!");
+    }
+}

src/Illuminate/Support/Testing/Fakes/BatchRepositoryFake.php

@@ -4,6 +4,7 @@
 
 use Carbon\CarbonImmutable;
 use Closure;
+use DateTimeInterface;
 use Illuminate\Bus\Batch;
 use Illuminate\Bus\BatchRepository;
 use Illuminate\Bus\PendingBatch;
@@ -134,4 +135,15 @@ public function transaction(Closure $callback)
     {
         return $callback();
     }
+
+    /**
+     * Prune all of the entries older than the given date.
+     *
+     * @param  DateTimeInterface  $before
+     * @return int
+     */
+    public function prune(DateTimeInterface $before)
+    {
+        return 0;
+    }
 }