Global Rate Limit

The global rate limit config is a queue option that determines how many jobs are allowed to be processed in a specific period of time.

TypeScript

import { Queue } from 'bullmq';

// 1 job per second
await queue.setGlobalRateLimit(1, 1000);

Python (Redis only)

from bullmq import Queue

# 1 job per second
await queue.setGlobalRateLimit(1, 1000)

Rust

use bullmq::Queue;

// 1 job per second
queue.set_global_rate_limit(1, 1000).await?;

In order to get these values:

TypeScript

const { max, duration } = await queue.getGlobalRateLimit();

Python (Redis only)

rate_limit = await queue.getGlobalRateLimit()
max_jobs, duration = rate_limit["max"], rate_limit["duration"]

Elixir

{:ok, %{max: max, duration: duration}} =
  BullMQ.Queue.get_global_rate_limit("my-queue", connection: :my_redis)

Rust

if let Some((max, duration)) = queue.get_global_rate_limit().await? {
    println!("{max} jobs every {duration} ms");
}

And in order to get current ttl:

TypeScript

const ttl = await queue.getRateLimitTtl();

Python

ttl = await queue.getRateLimitTtl()

Elixir

{:ok, ttl} = BullMQ.Queue.get_rate_limit_ttl("my-queue", connection: :my_redis)

.NET

long ttl = await queue.GetRateLimitTtlAsync();

Rust

let ttl = queue.get_rate_limit_ttl(None).await?;

PHP

<?php

$ttl = $queue->getRateLimitTtl();

INFO

Note that if you choose a rate limit level in your workers, it won't override the global one.

Remove Global Rate Limit

It can be done using the following method:

TypeScript

await queue.removeGlobalRateLimit();

Python (Redis only)

await queue.removeGlobalRateLimit()

Rust

queue.remove_global_rate_limit().await?;

Read more:

• 💡 Set Global Rate Limit API Reference
• 💡 Get Global Rate Limit API Reference
• 💡 Get Rate Limit Ttl API Reference
• 💡 Remove Global Rate Limit API Reference