HPTTL

Returns the TTL in milliseconds of a hash field.

Browse all commands · Upstream source documentation

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

Syntax

HPTTL key FIELDS numfields field [field ...]

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 specified fields

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

Command flags: READONLY, FAST.

ACL categories: HASH.

Command tips: NONDETERMINISTIC_OUTPUT.

Argument structure

Argument	Type	Constraints / metadata
key	key	key_spec_index: 0
fields	block	token: FIELDS
↳ numfields	integer	Required
↳ field	string	multiple

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": "7.4.0",
  "history": []
}

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

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.

• Get-with-expiry supports absolute deadlines persistence and immediate expiration — tests/bdd/features/hashes.feature:343; invocation observed.
• TTL states distinguish persistent missing and removed expirations — tests/bdd/features/hashes.feature:662; command tag and invocation observed.
• Prepared layouts preserve declared field order and replace complete hashes — tests/bdd/features/hashes.feature:877; 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.

Get-with-expiry supports absolute deadlines persistence and immediate expiration — tests/bdd/features/hashes.feature:373 (I execute:)

[
  "HPTTL",
  "h",
  "FIELDS",
  "1",
  "a"
]

Next source assertion: the reply equals:

[-1]

TTL states distinguish persistent missing and removed expirations — tests/bdd/features/hashes.feature:684 (I execute:)

[
  "HPTTL",
  "h",
  "FIELDS",
  "3",
  "a",
  "b",
  "missing"
]

Next source assertion: the reply equals:

[-1,-1,-2]

Prepared layouts preserve declared field order and replace complete hashes — tests/bdd/features/hashes.feature:908 (I execute:)

[
  "HPTTL",
  "user",
  "FIELDS",
  "3",
  "name",
  "email",
  "age"
]

Next source assertion: the reply equals:

[-1,-1,-1]