HRANDFIELD

Returns one or more random fields from a hash.

Browse all commands · Upstream source documentation

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

Syntax

HRANDFIELD key [count [WITHVALUES]]

ffkv behavior and limits

Hash fields have independent expiration. Counted field forms use FIELDS n; HSETEX counts field/value pairs. Key TTL and field TTL are distinct.

Source: README.md:587–599; tests/bdd/features/hashes.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(N) where N is the number of fields returned

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

Command flags: READONLY.

ACL categories: HASH.

Command tips: NONDETERMINISTIC_OUTPUT.

Argument structure

Argument	Type	Constraints / metadata
key	key	key_spec_index: 0
options	block	optional
↳ count	integer	Required
↳ withvalues	pure-token	optional; token: WITHVALUES

Key specifications

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

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

Additional pinned upstream metadata

{
  "group": "hash",
  "since": "6.2.0"
}

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

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.

• Random field count modes and RESP2 values preserve duplicates correctly — tests/bdd/features/hashes.feature:702; command tag and invocation observed.
• RESP3 random values are ordered field-value pairs — tests/bdd/features/hashes.feature:768; command tag and invocation observed.
• Hash operations reject incompatible key types — tests/bdd/features/hashes.feature:816; command tag and invocation observed.
• WITHVALUES count overflow is rejected before looking up the key — tests/bdd/features/hashes.feature:1545; command tag and invocation observed.
• Random access indexes survive field deletion expiry and reinsertion — tests/bdd/features/hashes.feature:1564; command tag and invocation observed.
• Positive random counts return every distinct field at most once — tests/bdd/features/hashes.feature:1604; 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.

Random field count modes and RESP2 values preserve duplicates correctly — tests/bdd/features/hashes.feature:708 (I execute:)

[
  "HRANDFIELD",
  "h"
]

Next source assertion: the reply equals:

"only"

Positive random counts return every distinct field at most once — tests/bdd/features/hashes.feature:1610 (I execute:)

[
  "HRANDFIELD",
  "h",
  "20"
]

Next source assertion: the reply contains:

["a","b"]

RESP3 random values are ordered field-value pairs — tests/bdd/features/hashes.feature:775 (client “three” executes:)

[
  "HRANDFIELD",
  "h",
  "-2",
  "WITHVALUES"
]

Next source assertion: the reply equals:

[["only","value"],["only","value"]]