GEORADIUSBYMEMBER Deprecated

As of Redis version 6.2.0, this command is regarded as deprecated.

It can be replaced by GEOSEARCH and GEOSEARCHSTORE with the BYRADIUS and FROMMEMBER arguments when migrating or writing new code.

Syntax text Syntax diagram API methods

GEORADIUSBYMEMBER key member radius <M | KM | FT | MI> [WITHCOORD]
  [WITHDIST] [WITHHASH] [COUNT count [ANY]] [ASC | DESC] [STORE key
  | STOREDIST key]

Client:

georadiusbymember(
    name: KeyT,
    member: FieldT,
    radius: float,
    unit: Optional[str] = None,
    withdist: bool = False,
    withcoord: bool = False,
    withhash: bool = False,
    count: Optional[int] = None,
    sort: Optional[str] = None,
    store: Union[KeyT, None] = None,
    store_dist: Union[KeyT, None] = None,
    any: bool = False
) → ResponseT

GEORADIUSBYMEMBER(
    key: RedisArgument,
    from: RedisArgument,
    radius: number,
    unit: GeoUnits,
    options?: GeoSearchOptions
) → Any

georadiusByMember(
    key: byte[],
    radius: byte[] member final double,  // of the area
    unit: GeoUnit  // can be M, KM, MI or FT
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

georadiusByMember(
    key: byte[],
    radius: byte[] member final double,  // of the area
    unit: GeoUnit,  // can be M, KM, MI or FT
    param: GeoRadiusParam  // GeoRadiusParam
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

georadiusByMember(
    key: String,
    radius: String member final double,  // of the area
    unit: GeoUnit  // can be M, KM, MI or FT
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

georadiusByMember(
    key: String,
    radius: String member final double,  // of the area
    unit: GeoUnit,  // can be M, KM, MI or FT
    param: GeoRadiusParam  // GeoRadiusParam
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

georadiusByMember(
    key: String,
    member: String,  // represents the center of the area
    radius: double,  // of the area
    unit: GeoUnit  // can be M, KM, MI or FT
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

georadiusbymember(
    key: K,  // the key of the geo set.
    member: V,  // reference member.
    distance: double,  // radius distance.
    unit: GeoArgs.Unit  // distance unit.
) → Set<V>  // Long integer-reply the number of elements in the result.

georadiusbymember(
    key: K,  // the key of the geo set.
    member: V,  // reference member.
    distance: double,  // radius distance.
    unit: GeoArgs.Unit,  // distance unit.
    geoArgs: GeoArgs
) → List<GeoWithin<V>>  // Long integer-reply the number of elements in the result.

georadiusbymember(
    key: K,  // the key of the geo set.
    member: V,  // reference member.
    distance: double,  // radius distance.
    unit: GeoArgs.Unit,  // distance unit.
    geoRadiusStoreArgs: GeoRadiusStoreArgs<K>  // their locations a sorted set.
) → Long  // Long integer-reply the number of elements in the result.

georadiusbymember(
    key: K,  // the key of the geo set.
    member: V,  // reference member.
    distance: double,  // radius distance.
    unit: GeoArgs.Unit  // distance unit.
) → RedisFuture<Set<V>>  // Long integer-reply the number of elements in the result.

georadiusbymember(
    key: K,  // the key of the geo set.
    member: V,  // reference member.
    distance: double,  // radius distance.
    unit: GeoArgs.Unit,  // distance unit.
    geoArgs: GeoArgs
) → RedisFuture<List<GeoWithin<V>>>  // Long integer-reply the number of elements in the result.

georadiusbymember(
    key: K,  // the key of the geo set.
    member: V,  // reference member.
    distance: double,  // radius distance.
    geoRadiusStoreArgs: GeoArgs.Unit unit GeoRadiusStoreArgs<K>  // their locations a sorted set.
) → RedisFuture<Long>  // Long integer-reply the number of elements in the result.

georadiusbymember(
    key: K,  // the key of the geo set.
    member: V,  // reference member.
    distance: double,  // radius distance.
    unit: GeoArgs.Unit  // distance unit.
) → Flux<V>  // Long integer-reply the number of elements in the result.

georadiusbymember(
    key: K,  // the key of the geo set.
    member: V,  // reference member.
    distance: double,  // radius distance.
    unit: GeoArgs.Unit,  // distance unit.
    geoArgs: GeoArgs
) → Flux<GeoWithin<V>>  // Long integer-reply the number of elements in the result.

georadiusbymember(
    key: K,  // the key of the geo set.
    member: V,  // reference member.
    distance: double,  // radius distance.
    unit: GeoArgs.Unit,  // distance unit.
    geoRadiusStoreArgs: GeoRadiusStoreArgs<K>  // their locations a sorted set.
) → Mono<Long>  // Long integer-reply the number of elements in the result.

GeoRadiusByMember(
    ctx: context.Context,
    key: Any,
    member: string,
    query: *GeoRadiusQuery
) → *GeoLocationCmd

georadiusbymember(
    $key: string,
    $member: Any,
    $radius: Any,
    $unit: Any,
    ?array $options = null: Any
) → array

geo_radius_by_member(
    key: K,
    member: M,
    radius: f64,
    unit: geo,
    options: geo
) → (Vec<geo::RadiusSearchResult>)

geo_radius_by_member(
    key: K,
    member: M,
    radius: f64,
    unit: geo,
    options: geo
) → (Vec<geo::RadiusSearchResult>)

Available since:: Redis Open Source 3.2.0
Time 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.
ACL categories:: @write, @geo, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Note:

This command's behavior varies in clustered Redis environments. See the multi-key operations page for more information.

This command is exactly like GEORADIUS with the sole difference that instead of taking, as the center of the area to query, a longitude and latitude value, it takes the name of a member already existing inside the geospatial index represented by the sorted set.

The position of the specified member is used as the center of the query.

Please check the example below and the GEORADIUS documentation for more information about the command and its options.

Note that GEORADIUSBYMEMBER_RO is also available since Redis 3.2.10 and Redis 4.0.0 in order to provide a read-only command that can be used in replicas. See the GEORADIUS page for more information.

Required arguments

key

The name of the key that holds the geospatial index (a sorted set).

member

The member whose position is used as the center of the search.

radius

The radius of the search circle, in the unit given by the following argument.

M | KM | FT | MI

The unit for radius: meters (M), kilometers (KM), feet (FT), or miles (MI).

Optional arguments

WITHCOORD

Also return the longitude and latitude of each matching item.

WITHDIST

Also return the distance of each matching item from the center, in the same unit as the radius.

WITHHASH

Also return the raw 52-bit geohash-encoded score of each matching item.

COUNT count [ANY]

Return at most count matches. With ANY, the command returns as soon as enough matches are found — faster, but the results may be unsorted.

ASC | DESC

Sort the results by distance from the center: nearest first (ASC) or farthest first (DESC).

STORE key

Store the results as a geospatial index in key instead of returning them. STORE and STOREDIST are mutually exclusive.

STOREDIST key

Store the results in key as a sorted set of distances from the center, instead of returning them.

Examples

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active	Deprecated as of Redis v6.2.0.

Return information

RESP2 RESP3

One of the following:

If no WITH* option is specified, an Array reply of matched member names
If WITHCOORD, WITHDIST, or WITHHASH options are specified, the command returns an Array reply of arrays, where each sub-array represents a single item:
- The distance from the center as a floating point number, in the same unit specified in the radius.
- The Geohash integer.
- The coordinates as a two items x,y array (longitude,latitude).

One of the following:

If no WITH* option is specified, an Array reply of matched member names
If WITHCOORD, WITHDIST, or WITHHASH options are specified, the command returns an Array reply of arrays, where each sub-array represents a single item:
- The distance from the center as a floating point number, in the same unit specified in the radius.
- The Geohash integer.
- The coordinates as a two items x,y array (longitude,latitude).

History

Starting with Redis version 6.2.0: Added the ANY option for COUNT.
Starting with Redis version 7.0.0: Added support for uppercase unit names.