1. Home
  2. Documentation
  3. Console
  4. Prevent Multiple Executions of a Console Command

Prevent Multiple Executions of a Console Command

5.0 version
Maintained
3.4 4.3 4.4 5.1 master
Unmaintained
3.2 3.3 4.0 4.1 4.2
edit this page

Prevent Multiple Executions of a Console CommandΒΆ

A simple but effective way to prevent multiple executions of the same command in a single server is to use locks. 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
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
// ...
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 0;
        }

        // 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();
    }
}

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