Skip to content
Search ffkv docs

Search the complete handbook, locally.

    GEORADIUSBYMEMBER

    Queries a geospatial index for members within a distance from a member, optionally stores the result.

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameGEORADIUSBYMEMBER
    Catalog groupGeospatial commands
    Upstream since3.2.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    GEORADIUSBYMEMBER key member radius <M | KM | FT | MI> [WITHCOORD]
    [WITHDIST] [WITHHASH] [COUNT count [ANY]] [ASC | DESC] [STORE key
    | STOREDIST key]

    Geo indexes use sorted-set storage and Morton encoding. Units and radius/box bounds are significant; distance results are floating-point estimates.

    Source: README.md:281; src/engine/geospatial.rs; tests/bdd/features/geo.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+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.

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

    Command flags: WRITE, DENYOOM.

    ACL categories: GEO.

    Documentation flags: DEPRECATED.

    ArgumentTypeConstraints / metadata
    keykeykey_spec_index: 0
    memberstringRequired
    radiusdoubleRequired
    unitoneofRequired
    ↳ mpure-tokentoken: m
    ↳ kmpure-tokentoken: km
    ↳ ftpure-tokentoken: ft
    ↳ mipure-tokentoken: mi
    withcoordpure-tokenoptional; token: WITHCOORD
    withdistpure-tokenoptional; token: WITHDIST
    withhashpure-tokenoptional; token: WITHHASH
    count-blockblockoptional
    ↳ countintegertoken: COUNT
    ↳ anypure-tokenoptional; token: ANY
    orderoneofoptional
    ↳ ascpure-tokentoken: ASC
    ↳ descpure-tokentoken: DESC
    storeoneofoptional
    ↳ storekeykeytoken: STORE; key_spec_index: 1
    ↳ storedistkeykeytoken: STOREDIST; key_spec_index: 2

    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
    }
    }
    },
    {
    "notes": "Incomplete because duplicate STORE options use last-wins; fall back to georadiusGetKeys",
    "flags": [
    "OW",
    "UPDATE",
    "INCOMPLETE"
    ],
    "begin_search": {
    "keyword": {
    "keyword": "STORE",
    "startfrom": 5
    }
    },
    "find_keys": {
    "range": {
    "lastkey": 0,
    "step": 1,
    "limit": 0
    }
    }
    },
    {
    "notes": "Incomplete because duplicate STOREDIST options use last-wins; fall back to georadiusGetKeys",
    "flags": [
    "OW",
    "UPDATE",
    "INCOMPLETE"
    ],
    "begin_search": {
    "keyword": {
    "keyword": "STOREDIST",
    "startfrom": 5
    }
    },
    "find_keys": {
    "range": {
    "lastkey": 0,
    "step": 1,
    "limit": 0
    }
    }
    }
    ]
    Additional pinned upstream metadata
    {
    "group": "geo",
    "since": "3.2.0",
    "history": [
    [
    "6.2.0",
    "Added the `ANY` option for `COUNT`."
    ],
    [
    "7.0.0",
    "Added support for uppercase unit names."
    ]
    ],
    "deprecated_since": "6.2.0",
    "replaced_by": "`GEOSEARCH` and `GEOSEARCHSTORE` with the `BYRADIUS` and `FROMMEMBER` arguments"
    }

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

    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.

    • Radius queries honor coordinate and member centers and distance ordering — tests/bdd/features/geo.feature:70; 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.

    Radius queries honor coordinate and member centers and distance ordering — tests/bdd/features/geo.feature:84 (I execute:)

    [
    "GEORADIUSBYMEMBER",
    "sicily",
    "Palermo",
    200,
    "km",
    "ASC"
    ]

    Next source assertion: the reply equals:

    ["Palermo","Catania"]

    Radius queries honor coordinate and member centers and distance ordering — tests/bdd/features/geo.feature:108 (I execute:)

    [
    "GEORADIUSBYMEMBER",
    "sicily",
    "Palermo",
    10,
    "km",
    "STORE",
    "nearby"
    ]

    Next source assertion: the reply equals:

    1