Removing jobs

Sometimes it is necessary to remove a job. For example, there could be a job that has bad data.

TypeScript

import { Queue } from 'bullmq';

const queue = new Queue('paint');

const job = await queue.add('wall', { color: 1 });

await job.remove();

Python

from bullmq import Queue

queue = Queue('paint')

job = await queue.add('wall', {'color': 1})

await job.remove()

Elixir

{:ok, job} = BullMQ.Queue.add("paint", "wall", %{color: 1}, connection: :my_redis)

{:ok, _removed} =
  BullMQ.Queue.remove_job("paint", job.id, connection: :my_redis, remove_children: true)

.NET

using BullMQ;

await using var queue = new Queue("paint", new QueueOptions
{
    Connection = ConnectionOptions.FromString("localhost:6379"),
});

var job = await queue.AddAsync("wall", new { color = 1 });

await job.RemoveAsync();

Rust

use bullmq::Queue;

let queue = Queue::new("paint").await?;

let job = queue.add("wall", serde_json::json!({"color": 1})).await?;

// Returns `true` if the job was removed, or `false` if it (or one of its
// dependencies) is locked and could not be removed.
let removed = queue.remove(job.id()).await?;

PHP

<?php

use BullMQ\Queue;

$queue = new Queue('paint');

$job = $queue->add('wall', ['color' => 1]);

$queue->remove($job->id);

WARNING

Locked jobs (in active state) cannot be removed. In TypeScript and Python, an error will be thrown, while the other SDKs report it in the return value (for example, in Rust Queue::remove returns Ok(false)).

Having a parent job

There are 2 possible cases:

1. There are not pending dependencies; in this case the parent is moved to wait status, we may try to process this job.
2. There are pending dependencies; in this case the parent is kept in waiting-children status.

INFO

Take into consideration that processed values will be kept in processed hset from the parent if this child is in completed state at the time when it's removed.

Having pending dependencies

We may try to remove all its pending descendants first.

WARNING

If any of the children are locked, the deletion process will be stopped.

Read more:

• 💡 Remove API Reference