XCLAIM - Upstash Documentation

const result = await redis.xclaim(
  "mystream",
  "mygroup",
  "consumer1",
  60000,
  ["1638360173533-0", "1638360173533-1"]
);

const result = await redis.xclaim(
  "mystream",
  "mygroup", 
  "consumer1",
  60000,
  ["1638360173533-0"],
  { justid: true, force: true }
);

[
  ["1638360173533-0", ["field1", "value1", "field2", "value2"]],
  ["1638360173533-1", ["field1", "value3", "field2", "value4"]]
]

Arguments

string

required

The key of the stream.

string

required

The consumer group name.

string

required

The consumer name that will claim the messages.

number

required

The minimum idle time in milliseconds for messages to be claimed.

string | string[]

required

The ID(s) of the message(s) to claim. Can be a single ID or an array of IDs.

Show options

number

Set the idle time of the message.

number

Set the idle time to a specific Unix time.

number

Set the retry counter to the specified value.

boolean

Create the pending message entry even if certain IDs are not already pending.

boolean

Return only the message IDs instead of the full message data.

Returns an array of claimed messages. If justid option is used, returns only message IDs.

const result = await redis.xclaim(
  "mystream",
  "mygroup",
  "consumer1",
  60000,
  ["1638360173533-0", "1638360173533-1"]
);

const result = await redis.xclaim(
  "mystream",
  "mygroup", 
  "consumer1",
  60000,
  ["1638360173533-0"],
  { justid: true, force: true }
);

[
  ["1638360173533-0", ["field1", "value1", "field2", "value2"]],
  ["1638360173533-1", ["field1", "value3", "field2", "value4"]]
]

⌘I