Removing Jobs

Currently we have 3 available methods in queue class:

Drain

Removes all jobs that are waiting or delayed, but not active, waiting-children, completed or failed.

TypeScript

import { Queue } from 'bullmq';

const queue = new Queue('paint');

await queue.drain();

Python

Elixir

PHP

You can also drain delayed jobs by setting the delayed parameter:

TypeScript

import { Queue } from 'bullmq';

const queue = new Queue('paint');

// Also drain delayed jobs
await queue.drain(true);

Python

Elixir

PHP

Parent jobs that belong to the queue being drained will be kept in waiting-children status if they have pending children, but if they do not have any pending children they will just be removed.

Parent jobs in queues different from the one being drained will either stay in waiting-children if they have pending children in other queues, or just moved to wait.

Clean

Removes jobs in a specific state, but keeps jobs within a certain grace period.

import { Queue } from 'bullmq';

const queue = new Queue('paint');

const deletedJobIds = await queue.clean(
  60000, // 1 minute
  1000, // max number of jobs to clean
  'paused',
);

Obliterate

Completely obliterates a queue and all of its contents.

TypeScript

import { Queue } from 'bullmq';

const queue = new Queue('paint');

await queue.obliterate();

Python

Elixir

PHP

For more advanced scenarios where you need to force obliteration even with active jobs:

TypeScript

import { Queue } from 'bullmq';

const queue = new Queue('paint');

// Force obliteration even with active jobs
await queue.obliterate({ force: true });

Python

Elixir

PHP

Parent jobs in queues different from the one being obliterated will either stay in waiting-children if they have pending children in other queues, or just moved to wait.

Read more:

• 💡 Drain API Reference

• 💡 Clean API Reference

• 💡 Obliterate API Reference