GEOSEARCH

Queries a geospatial index for members inside an area of a box or a circle.

Browse all commands · Upstream source documentation

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

Syntax

GEOSEARCH key <FROMMEMBER member | FROMLONLAT longitude latitude>
  <BYRADIUS radius <M | KM | FT | MI> | BYBOX width height <M | KM |
  FT | MI>> [ASC | DESC] [COUNT count [ANY]] [WITHCOORD] [WITHDIST]
  [WITHHASH]

ffkv behavior and limits

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.

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+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape

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

Command flags: READONLY.

ACL categories: GEO.

Argument structure

Argument	Type	Constraints / metadata
key	key	key_spec_index: 0
from	oneof	Required
↳ member	string	token: FROMMEMBER
↳ fromlonlat	block	token: FROMLONLAT
↳ ↳ longitude	double	Required
↳ ↳ latitude	double	Required
by	oneof	Required
↳ circle	block	Required
↳ ↳ radius	double	token: BYRADIUS
↳ ↳ unit	oneof	Required
↳ ↳ ↳ m	pure-token	token: m
↳ ↳ ↳ km	pure-token	token: km
↳ ↳ ↳ ft	pure-token	token: ft
↳ ↳ ↳ mi	pure-token	token: mi
↳ box	block	Required
↳ ↳ width	double	token: BYBOX
↳ ↳ height	double	Required
↳ ↳ unit	oneof	Required
↳ ↳ ↳ m	pure-token	token: m
↳ ↳ ↳ km	pure-token	token: km
↳ ↳ ↳ ft	pure-token	token: ft
↳ ↳ ↳ mi	pure-token	token: mi
order	oneof	optional
↳ asc	pure-token	token: ASC
↳ desc	pure-token	token: DESC
count-block	block	optional
↳ count	integer	token: COUNT
↳ any	pure-token	optional; token: ANY
withcoord	pure-token	optional; token: WITHCOORD
withdist	pure-token	optional; token: WITHDIST
withhash	pure-token	optional; token: WITHHASH

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": "geo",
  "since": "6.2.0",
  "history": [
    [
      "7.0.0",
      "Added support for uppercase unit names."
    ]
  ]
}

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

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.

• Box search and stored distance scores replace a destination with selected members — tests/bdd/features/geo.feature:125; command tag and invocation observed.
• Underflowing geo arguments cannot delete an aliased source destination (Scenario Outline) — tests/bdd/features/geo.feature:165; 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.

Underflowing geo arguments cannot delete an aliased source destination — tests/bdd/features/geo.feature:176 (I execute:)

Expanded from an actual Examples row: longitude=0, latitude=0, radius=1e-9999.

[
  "GEOSEARCH",
  "geo",
  "FROMMEMBER",
  "a",
  "BYRADIUS",
  "1",
  "m"
]

Next source assertion: the reply equals:

["a"]

Box search and stored distance scores replace a destination with selected members — tests/bdd/features/geo.feature:131 (I execute:)

[
  "GEOSEARCH",
  "sicily",
  "FROMMEMBER",
  "Palermo",
  "BYBOX",
  400,
  400,
  "km",
  "DESC",
  "COUNT",
  1
]

Next source assertion: the reply equals:

["Catania"]