Skip to content
Search ffkv docs

Search the complete handbook, locally.

    BLMPOP

    Pops the first element from one of multiple lists. Blocks until an element is available otherwise. Deletes the list if the last element was popped.

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameBLMPOP
    Catalog groupList commands
    Upstream since7.0.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    BLMPOP timeout numkeys key [key ...] <LEFT | RIGHT> [COUNT count]

    A successful pop removes the item immediately: Redis list queues have no acknowledgement or automatic redelivery. Blocking calls do not wait in EXEC or Lua. Only large list/native-job bodies are SSD-offloaded in hybrid mode.

    Source: README.md:155–174, 810–825; tests/bdd/features/lists.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.

    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(N+M) where N is the number of provided keys and M is the number of elements returned.

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

    Command flags: WRITE, BLOCKING.

    ACL categories: LIST.

    ArgumentTypeConstraints / metadata
    timeoutdoubleRequired
    numkeysintegerRequired
    keykeymultiple; key_spec_index: 0
    whereoneofRequired
    ↳ leftpure-tokentoken: LEFT
    ↳ rightpure-tokentoken: RIGHT
    countintegeroptional; token: COUNT

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

    [
    {
    "flags": [
    "RW",
    "ACCESS",
    "DELETE"
    ],
    "begin_search": {
    "index": {
    "pos": 2
    }
    },
    "find_keys": {
    "keynum": {
    "keynumidx": 0,
    "firstkey": 1,
    "step": 1
    }
    }
    }
    ]
    Additional pinned upstream metadata
    {
    "group": "list",
    "since": "7.0.0"
    }

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

    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.

    • A blocked multi-pop consumes a batch from the first newly available list — tests/bdd/features/lists.feature:697; command tag and invocation observed.
    • Blocked consumers have FIFO priority and cancellation removes a waiter — tests/bdd/features/lists.feature:784; command tag and invocation observed.
    • Finite blocking timeouts return null without creating destination lists (Scenario Outline) — tests/bdd/features/lists.feature:833; command tag and invocation observed.
    • Blocking operations inside EXEC return immediately and later writes are not consumed — tests/bdd/features/lists.feature:858; command tag and invocation observed.
    • Blocked requests do not survive a server lifecycle but completed effects do — tests/bdd/features/lists.feature:907; command tag and invocation observed.
    • List commands reject incompatible source values without replacing them (Scenario Outline) — tests/bdd/features/lists.feature:1047; command tag and invocation observed.

    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.

    Finite blocking timeouts return null without creating destination lists — tests/bdd/features/lists.feature:835 (I execute:)

    Expanded from an actual Examples row: command=["BLMPOP","0.01","1","source","LEFT","COUNT","2"].

    [
    "BLMPOP",
    "0.01",
    "1",
    "source",
    "LEFT",
    "COUNT",
    "2"
    ]

    Next source assertion: the reply is null

    Blocking operations inside EXEC return immediately and later writes are not consumed — tests/bdd/features/lists.feature:860 (the following commands succeed:)

    [
    "BLMPOP",
    "0",
    "1",
    "source",
    "LEFT"
    ]

    Blocked consumers have FIFO priority and cancellation removes a waiter — tests/bdd/features/lists.feature:797 (client “second” sends:)

    [
    "BLMPOP",
    "0",
    "1",
    "q",
    "LEFT",
    "COUNT",
    "2"
    ]