Skip to content
Search ffkv docs

Search the complete handbook, locally.

    GETEX

    Returns the string value of a key after setting its expiration time.

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameGETEX
    Catalog groupString commands
    Upstream since6.2.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    GETEX key [EX seconds | PX milliseconds | EXAT unix-time-seconds |
    PXAT unix-time-milliseconds | PERSIST]

    Keys and values are binary-safe bytes. Conditional SET and DELEX comparisons use the stored bytes; DIGEST uses XXH3, not a cryptographic digest.

    Source: README.md:571–585; src/engine/strings.rs; tests/bdd/features/strings.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(1)

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

    Command flags: WRITE, FAST.

    ACL categories: STRING.

    ArgumentTypeConstraints / metadata
    keykeykey_spec_index: 0
    expirationoneofoptional
    ↳ secondsintegertoken: EX
    ↳ millisecondsintegertoken: PX
    ↳ unix-time-secondsunix-timetoken: EXAT
    ↳ unix-time-millisecondsunix-timetoken: PXAT
    ↳ persistpure-tokentoken: PERSIST

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

    [
    {
    "notes": "RW and UPDATE because it changes the TTL",
    "flags": [
    "RW",
    "ACCESS",
    "UPDATE"
    ],
    "begin_search": {
    "index": {
    "pos": 1
    }
    },
    "find_keys": {
    "range": {
    "lastkey": 0,
    "step": 1,
    "limit": 0
    }
    }
    }
    ]
    Additional pinned upstream metadata
    {
    "group": "string",
    "since": "6.2.0"
    }

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

    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.

    • Getex preserves or changes expiration without changing bytes — tests/bdd/features/strings.feature:442; command tag and invocation observed.
    • String type errors never destroy a collection (Scenario Outline) — tests/bdd/features/strings.feature:1139; 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.

    Getex preserves or changes expiration without changing bytes — tests/bdd/features/strings.feature:448 (I execute:)

    [
    "GETEX",
    "item"
    ]

    Next source assertion: the reply equals:

    "payload"

    String type errors never destroy a collection — tests/bdd/features/strings.feature:1145 (I execute:)

    Expanded from an actual Examples row: argv=["GETEX","typed","PERSIST"], code=WRONGTYPE.

    [
    "GETEX",
    "typed",
    "PERSIST"
    ]

    Next source assertion: the reply is an error with code “WRONGTYPE”

    Getex preserves or changes expiration without changing bytes — tests/bdd/features/strings.feature:464 (I execute:)

    [
    "GETEX",
    "item",
    "PERSIST"
    ]

    Next source assertion: the reply equals:

    "payload"