Removing Jobs

/**
 * Completely remove the job from the queue.
 * Note, this call will throw an exception if the job
 * is being processed when the call is performed.
 *
 * @param opts - Options to remove a job
 */
async remove({ removeChildren = true } = {}): Promise<void> {
  await this.queue.waitUntilReady();

  const queue = this.queue;
  const job = this;

  const removed = await this.scripts.remove(job.id, removeChildren);
  if (removed) {
    queue.emit('removed', job);
  } else {
    throw new Error(
      `Job ${this.id} could not be removed because it is locked by another worker`,
    );
  }
}

import { Queue } from 'bullmq';

const queue = new Queue('Paint');

// Remove immediately after completion
await queue.add('wall', { color: 'pink' }, { removeOnComplete: true });

// Keep only the last 100 completed jobs
await queue.add('wall', { color: 'blue' }, { removeOnComplete: 100 });

// Keep jobs for 24 hours or max 1000 jobs
await queue.add(
  'wall',
  { color: 'green' },
  {
    removeOnComplete: {
      age: 24 * 3600, // seconds
      count: 1000,
    },
  },
);

// Remove immediately after failure
await queue.add('wall', { color: 'pink' }, { removeOnFail: true });

// Keep only the last 50 failed jobs
await queue.add('wall', { color: 'blue' }, { removeOnFail: 50 });

// Keep failed jobs for 7 days or max 500 jobs
await queue.add(
  'wall',
  { color: 'green' },
  {
    removeOnFail: {
      age: 7 * 24 * 3600, // seconds
      count: 500,
    },
  },
);

interface DefaultJobOptions {
  /**
   * If true, removes the job when it successfully completes
   * When given a number, it specifies the maximum amount of
   * jobs to keep, or you can provide an object specifying max
   * age and/or count to keep. It overrides whatever setting is used in the worker.
   * Default behavior is to keep the job in the completed set.
   */
  removeOnComplete?: boolean | number | KeepJobs;

  /**
   * If true, removes the job when it fails after all attempts.
   * When given a number, it specifies the maximum amount of
   * jobs to keep, or you can provide an object specifying max
   * age and/or count to keep. It overrides whatever setting is used in the worker.
   * Default behavior is to keep the job in the failed set.
   */
  removeOnFail?: boolean | number | KeepJobs;
}

// Remove job and all its children
await parentJob.remove({ removeChildren: true });

// Remove only the parent (children remain)
await parentJob.remove({ removeChildren: false });

/**
 * Remove all children from this job that are not yet processed,
 * in other words that are in any other state than completed, failed or active.
 *
 * @remarks
 *  - Jobs with locks (most likely active) are ignored.
 *  - This method can be slow if the number of children is large (> 1000).
 */
async removeUnprocessedChildren(): Promise<void> {
  const jobId = this.id;
  await this.scripts.removeUnprocessedChildren(jobId);
}

import { Job, Queue } from 'bullmq';

const queue = new Queue('myQueue');
const job = await Job.fromId(queue, 'child-job-id');

const wasRemoved = await job.removeChildDependency();

if (wasRemoved) {
  console.log('Child dependency removed successfully');
}

/**
 * Removes child dependency from parent when child is not yet finished
 *
 * @returns True if the relationship existed and if it was removed.
 */
async removeChildDependency(): Promise<boolean> {
  const childDependencyIsRemoved = await this.scripts.removeChildDependency(
    this.id,
    this.parentKey,
  );
  if (childDependencyIsRemoved) {
    this.parent = undefined;
    this.parentKey = undefined;
    return true;
  }

  return false;
}

import { Queue } from 'bullmq';

const queue = new Queue('Paint');

// Remove all failed jobs
const failedJobs = await queue.getFailed();
for (const job of failedJobs) {
  await job.remove();
}

// Or use queue methods
await queue.clean(0, 100, 'failed'); // Remove up to 100 failed jobs
await queue.clean(24 * 3600 * 1000, 0, 'completed'); // Remove completed jobs older than 24 hours

import { Queue } from 'bullmq';

const queue = new Queue('Paint');

queue.on('removed', (job) => {
  console.log(`Job ${job.id} was removed`);
});