Skip to content
Search ffkv docs

Search the complete handbook, locally.

    HPEXPIREAT

    Set expiry for hash field using an absolute Unix timestamp (milliseconds)

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameHPEXPIREAT
    Catalog groupHash commands
    Upstream since7.4.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    HPEXPIREAT key unix-time-milliseconds [NX | XX | GT | LT]
    FIELDS numfields field [field ...]

    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.

    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: -6 (includes the command name; a negative number is a minimum).

    Command flags: WRITE, FAST.

    ACL categories: HASH.

    ArgumentTypeConstraints / metadata
    keykeykey_spec_index: 0
    unix-time-millisecondsunix-timeRequired
    conditiononeofoptional
    ↳ nxpure-tokentoken: NX
    ↳ xxpure-tokentoken: XX
    ↳ gtpure-tokentoken: GT
    ↳ ltpure-tokentoken: LT
    fieldsblocktoken: FIELDS
    ↳ numfieldsintegerRequired
    ↳ fieldstringmultiple

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

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

    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.

    • Copy across databases replaces only when requested and detaches hash values and field deadlines — tests/bdd/features/generic.feature:5; invocation observed.
    • Hash serialization preserves binary fields and absolute field expiration independently — tests/bdd/features/generic.feature:316; invocation observed.
    • Signed integer increments preserve existing field deadlines — tests/bdd/features/hashes.feature:197; invocation observed.
    • Floating increments normalize decimals and resolve durable values — tests/bdd/features/hashes.feature:242; invocation observed.
    • All-fields conditions are atomic and keep existing field expirations — tests/bdd/features/hashes.feature:430; invocation observed.
    • HPEXPIREAT exposes absolute deadlines and independent conditional outcomes — tests/bdd/features/hashes.feature:614; command tag and invocation observed.
    • TTL states distinguish persistent missing and removed expirations — tests/bdd/features/hashes.feature:662; invocation observed.
    • Prepared layouts preserve declared field order and replace complete hashes — tests/bdd/features/hashes.feature:877; invocation observed.
    • Duplicate layout preparation and mismatched imports preserve old state — tests/bdd/features/hashes.feature:934; invocation observed.
    • Expiry conditions may follow counted fields and mixed conditions fail atomically — tests/bdd/features/hashes.feature:1492; 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.

    HPEXPIREAT exposes absolute deadlines and independent conditional outcomes — tests/bdd/features/hashes.feature:644 (I execute:)

    [
    "HPEXPIREAT",
    "h",
    "1",
    "LT",
    "FIELDS",
    "1",
    "a"
    ]

    Next source assertion: the reply equals:

    [2]

    Signed integer increments preserve existing field deadlines — tests/bdd/features/hashes.feature:199 (the following commands succeed:)

    [
    "HPEXPIREAT",
    "h",
    "4102444800000",
    "FIELDS",
    "1",
    "n"
    ]

    All-fields conditions are atomic and keep existing field expirations — tests/bdd/features/hashes.feature:432 (the following commands succeed:)

    [
    "HPEXPIREAT",
    "h",
    "4102444800000",
    "FIELDS",
    "1",
    "a"
    ]