XCLAIM

Changes, or acquires, ownership of a message in a consumer group, as if the message was delivered a consumer group member.

Browse all commands · Upstream source documentation

Reference field	Value
Canonical name	XCLAIM
Catalog group	Stream commands
Upstream since	5.0.0 — upstream Redis/module version, not an ffkv release
Pinned catalog	Redis 8.10.0

Syntax

XCLAIM key group consumer min-idle-time id [id ...] [IDLE ms]
  [TIME unix-time-milliseconds] [RETRYCOUNT count] [FORCE] [JUSTID]
  [LASTID lastid]

ffkv behavior and limits

Stream waits are bounded to 65,536 clients and 64 MiB of retained logical requests (also limited by the connection cap). Approximate MAXLEN trimming uses 100-entry granularity. EXEC/Lua reads never block. Physical index statistics describe ffkv, not Redis allocator internals.

Source: README.md:351–374; tests/bdd/features/streams.feature.

All requests share the 8 MiB framing/1,024-argument ingress limit; normal RESP replies have 64 MiB wire/logical budgets with bounded nesting/value counts. Management and Lua origins impose smaller budgets. These are not a process RSS cap. Catalog inclusion is not exhaustive option or wire-format parity. See limits and compatibility.

Upstream metadata

The following fields come from the pinned Redis metadata, not measured ffkv performance or an assertion that ffkv enforces every upstream flag. Running COMMAND INFO/COMMAND DOCS describe the current engine.

Upstream Redis complexity: O(log N) with N being the number of messages in the PEL of the consumer group.

Upstream arity: -6 (includes the command name; a negative number is a minimum).

Command flags: WRITE, FAST.

ACL categories: STREAM.

Command tips: NONDETERMINISTIC_OUTPUT.

Argument structure

Argument	Type	Constraints / metadata
key	key	key_spec_index: 0
group	string	Required
consumer	string	Required
min-idle-time	string	Required
ID	string	multiple
ms	integer	optional; token: IDLE
unix-time-milliseconds	unix-time	optional; token: TIME
count	integer	optional; token: RETRYCOUNT
force	pure-token	optional; token: FORCE
justid	pure-token	optional; token: JUSTID
lastid	string	optional; token: LASTID

Key specifications

Upstream key discovery descriptors (indexes are relative to the full command vector):

[
  {
    "flags": [
      "RW",
      "UPDATE"
    ],
    "begin_search": {
      "index": {
        "pos": 1
      }
    },
    "find_keys": {
      "range": {
        "lastkey": 0,
        "step": 1,
        "limit": 0
      }
    }
  }
]

Additional pinned upstream metadata

{
  "group": "stream",
  "since": "5.0.0"
}

Metadata source · Local snapshot: src/command_metadata.json, key xclaim.

BDD coverage and source examples

These are source observations, not a test run performed by this documentation build. A tag identifies scenario intent; an extracted vector identifies a command invocation, which may intentionally produce an error. Scenarios may require setup, multiple connections, persistence, cluster nodes or native-module fixtures.

• Claim and autoclaim transfer ownership and preserve message payload — tests/bdd/features/streams.feature:223; command tag and invocation observed.
• NACK releases owned work and makes it immediately claimable — tests/bdd/features/streams.feature:262; invocation observed.
• FORCE counts both creation and claim unless JUSTID or RETRYCOUNT changes the count (Scenario Outline) — tests/bdd/features/streams.feature:752; command tag and invocation observed.

Extracted command vectors

The following JSON arrays are the test harness’s argument vectors, not shell commands. Numeric arguments are converted by the harness; objects of the form {"base64":"…"} represent decoded binary bytes, not a literal JSON command argument. Preserve scenario setup and connection ordering. See the CLI guide for shell quoting and binary stdin. No reply is invented or inferred.

FORCE counts both creation and claim unless JUSTID or RETRYCOUNT changes the count — tests/bdd/features/streams.feature:758 (I execute:)

Expanded from an actual Examples row: options=, count=2, claimed=[["1-0",["f","a"]]].

[
  "XCLAIM",
  "events",
  "g",
  "c",
  0,
  "1-0",
  "FORCE"
]

Next source assertion: the reply equals:

[["1-0",["f","a"]]]

Claim and autoclaim transfer ownership and preserve message payload — tests/bdd/features/streams.feature:229 (I execute:)

[
  "XCLAIM",
  "events",
  "workers",
  "bob",
  0,
  "1000-0"
]

Next source assertion: the reply equals:

[["1000-0",["field","a","field","b"]]]

NACK releases owned work and makes it immediately claimable — tests/bdd/features/streams.feature:284 (I execute:)

[
  "XCLAIM",
  "events",
  "workers",
  "bob",
  9223372036854776000,
  "1000-0"
]

Next source assertion: the reply equals:

[["1000-0",["field","a","field","b"]]]