Prevent Running the Same Console Command Multiple Times

5.2 version

Maintained

4.4 5.2 current 5.3 dev

Unmaintained

3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1

edit this page

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:

// ...
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Command\LockableTrait;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class UpdateContentsCommand extends Command
{
    use LockableTrait;

    // ...

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        if (!$this->lock()) {
            $output->writeln('The command is already running in another process.');

            return Command::SUCCESS;
        }

        // If you prefer to wait until the lock is released, use this:
        // $this->lock(null, true);

        // ...

        // if not released explicitly, Symfony releases the lock
        // automatically when the execution of the command ends
        $this->release();

        return Command::SUCCESS;
    }
}

New in version 5.1: The Command::SUCCESS constant was introduced in Symfony 5.1.

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