Skip to content
Search ffkv docs

Search the complete handbook, locally.

    JSON.GET

    Gets the value at one or more paths in JSON serialized form

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameJSON.GET
    Catalog groupJSON commands
    Upstream since1.0.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    JSON.GET key [INDENT indent] [NEWLINE newline] [SPACE space] [path
    [path ...]]

    Documents cap at 4 MiB compact JSON, 262,144 nodes and depth 128. Paths cap at 16 KiB and matching at 65,536 results, with additional expression/projection work budgets. JSON trees stay RAM-resident in hybrid mode.

    Source: README.md:357–358, 375–377; tests/bdd/features/json.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.

    This command is in the canonical catalog but has no matching entry in the pinned src/command_metadata.json. Argument flags, complexity and key specifications are not invented. Use the syntax, upstream source documentation and actual scenario evidence below.

    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.

    • Conditional path assignment selects values rather than returning stored source text — tests/bdd/features/json.feature:5; command tag and invocation observed.
    • Array insertion indexing popping and trimming preserve JSON values — tests/bdd/features/json.feature:54; invocation observed.
    • Numeric boolean and string updates operate across matched nodes — tests/bdd/features/json.feature:130; invocation observed.
    • Merge patch deletion forgetting and clear apply distinct transformations — tests/bdd/features/json.feature:225; invocation observed.
    • Debug memory distinguishes present data from unmatched paths without pinning allocator sizes — tests/bdd/features/json.feature:344; invocation observed.
    • Repeated read selectors preserve their sequence while mutations use unique targets — tests/bdd/features/json.feature:373; 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.

    Repeated read selectors preserve their sequence while mutations use unique targets — tests/bdd/features/json.feature:428 (I execute:)

    [
    "JSON.GET",
    "j",
    "$"
    ]

    Next source assertion: the reply equals:

    "[[21]]"

    Array insertion indexing popping and trimming preserve JSON values — tests/bdd/features/json.feature:108 (I execute:)

    [
    "JSON.GET",
    "doc",
    "$.a"
    ]

    Next source assertion: the reply equals:

    "[[2,3]]"

    Merge patch deletion forgetting and clear apply distinct transformations — tests/bdd/features/json.feature:295 (I execute:)

    [
    "JSON.GET",
    "doc",
    "$.n"
    ]

    Next source assertion: the reply equals:

    "[0]"