silverbullet/website/API/mq.md

Message Queue API

The Message Queue API provides functions for implementing a simple message queue system.

Message Operations

mq.send(queue, body)

Sends a message to a queue.

Example:

mq.send("tasks", {type = "process", data = "sample"})

mq.batchSend(queue, bodies)

Sends multiple messages to a queue in a single operation.

Example:

local messages = {
    {type = "task1", data = "sample1"},
    {type = "task2", data = "sample2"}
}
mq.batchSend("tasks", messages)

mq.ack(queue, id)

Acknowledges a message from a queue, marking it as processed.

Example:

mq.ack("tasks", "message-123")

mq.batchAck(queue, ids)

Acknowledges multiple messages from a queue in a single operation.

Example:

local messageIds = {"msg1", "msg2", "msg3"}
mq.batchAck("tasks", messageIds)

Queue Management

mq.getQueueStats(queue)

Retrieves statistics about a particular queue.

Example:

local stats = mq.getQueueStats("tasks")
print("Queue size: " .. stats.size)
print("Processing: " .. stats.processing)