Prevent Running the Same Console Command Multiple Times

Prevent Running the Same Console Command Multiple Times

You can use locks) to prevent the same command from running multiple times on the same server. The Lock component provides multiple classes to create locks based on the filesystem (FlockStore), shared memory (SemaphoreStore) and even databases and Redis servers.

In addition, the Console component provides a PHP trait called LockableTrait that adds two convenient methods to lock and release commands:

  1. // ...
  2. use Symfony\Component\Console\Command\Command;
  3. use Symfony\Component\Console\Command\LockableTrait;
  4. use Symfony\Component\Console\Input\InputInterface;
  5. use Symfony\Component\Console\Output\OutputInterface;
  7. class UpdateContentsCommand extends Command
  8. {
  9.     use LockableTrait;
  11.     // ...
  13.     protected function execute(InputInterface $input, OutputInterface $output): int
  14.     {
  15.         if (!$this->lock()) {
  16.             $output->writeln('The command is already running in another process.');
  18.             return 0;
  19.         }
  21.         // If you prefer to wait until the lock is released, use this:
  22.         // $this->lock(null, true);
  24.         // ...
  26.         // if not released explicitly, Symfony releases the lock
  27.         // automatically when the execution of the command ends
  28.         $this->release();
  30.         return 0;
  31.     }
  32. }

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.