GEOSEARCHSTORE

Syntax text Syntax diagram API methods

GEOSEARCHSTORE destination source <FROMMEMBER member |
  FROMLONLAT longitude latitude> <BYRADIUS radius <M | KM | FT | MI>
  | BYBOX width height <M | KM | FT | MI>> [ASC | DESC] [COUNT count
  [ANY]] [STOREDIST]

Client:

geosearchstore(
    dest: KeyT,
    name: KeyT,
    member: Optional[FieldT] = None,
    longitude: Optional[float] = None,
    latitude: Optional[float] = None,
    unit: str = "m",
    radius: Optional[float] = None,
    width: Optional[float] = None,
    height: Optional[float] = None,
    sort: Optional[str] = None,
    count: Optional[int] = None,
    any: bool = False,
    storedist: bool = False
) → ResponseT

GEOSEARCHSTORE(
    destination: RedisArgument,
    source: RedisArgument,
    from: GeoSearchFrom,
    by: GeoSearchBy,
    options?: GeoSearchStoreOptions
) → Any

geosearchStore(
    dest: byte[],
    src: byte[],
    member: byte[],
    radius: double,
    unit: GeoUnit
) → long  // The number of results being stored

geosearchStore(
    dest: byte[],
    src: byte[],
    coord: GeoCoordinate,
    radius: double,
    unit: GeoUnit
) → long  // The number of results being stored

geosearchStore(
    dest: byte[],
    src: byte[],
    member: byte[],
    width: double,
    height: double,
    unit: GeoUnit
) → long  // The number of results being stored

geosearchStore(
    dest: byte[],
    src: byte[],
    coord: GeoCoordinate,
    width: double,
    height: double,
    unit: GeoUnit
) → long  // The number of results being stored

geosearchStore(
    dest: byte[],
    src: byte[],
    params: GeoSearchParam  // GeoSearchParam
) → long  // The number of results being stored

geosearchstore(
    destination: K,  // the destination where to store results.
    key: K,  // the key of the geo set.
    reference: GeoSearch.GeoRef<K>,  // the reference member or longitude/latitude coordinates.
    predicate: GeoSearch.GeoPredicate,  // the bounding box or radius to search in.
    storeDist: GeoArgs geoArgs boolean  // a floating-point number, in the same unit specified for that shape.
) → Long  // Long integer-reply the number of elements in the result. @since 6.1

geosearchstore(
    destination: K,  // the destination where to store results.
    key: K,  // the key of the geo set.
    reference: GeoSearch.GeoRef<K>,  // the reference member or longitude/latitude coordinates.
    geoArgs: GeoSearch.GeoPredicate predicate GeoArgs,  // args to control the result.
    storeDist: boolean  // a floating-point number, in the same unit specified for that shape.
) → RedisFuture<Long>  // Long integer-reply the number of elements in the result. @since 6.1

geosearchstore(
    destination: K,  // the destination where to store results.
    key: K,  // the key of the geo set.
    reference: GeoSearch.GeoRef<K>,  // the reference member or longitude/latitude coordinates.
    geoArgs: GeoSearch.GeoPredicate predicate GeoArgs,  // args to control the result.
    storeDist: boolean  // a floating-point number, in the same unit specified for that shape.
) → Mono<Long>  // Long integer-reply the number of elements in the result. @since 6.1

GeoSearchStore(
    ctx: context.Context,
    key: Any,
    store: string,
    q: *GeoSearchStoreQuery
) → *IntCmd

GeoSearchAndStore(
    sourceKey: RedisKey,  // The key of the set.
    destinationKey: RedisKey,  // .</returns> <remarks></remarks>
    member: RedisValue,
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    storeDistances: bool,  // If set to true, the resulting set will be a regular sorted-set containing only distances, rather than a geo-encoded sorted-set.
    flags: CommandFlags  // The flags for this operation.
) → long

GeoSearchAndStore(
    sourceKey: RedisKey,  // The key of the set.
    destinationKey: RedisKey,  // .</returns> <remarks></remarks>
    longitude: double,  // The longitude of the center point.
    latitude: double,  // The latitude of the center point.
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    storeDistances: bool,  // If set to true, the resulting set will be a regular sorted-set containing only distances, rather than a geo-encoded sorted-set.
    flags: CommandFlags  // The flags for this operation.
) → long

GeoSearchAndStoreAsync(
    sourceKey: RedisKey,
    destinationKey: RedisKey,
    member: RedisValue,
    shape: GeoSearchShape,
    count: int,
    demandClosest: bool,
    order: Order?,
    storeDistances: bool,
    flags: CommandFlags
) → Task<long>

GeoSearchAndStoreAsync(
    sourceKey: RedisKey,
    destinationKey: RedisKey,
    longitude: double,
    latitude: double,
    shape: GeoSearchShape,
    count: int,
    demandClosest: bool,
    order: Order?,
    storeDistances: bool,
    flags: CommandFlags
) → Task<long>

GeoSearchAndStore(
    sourceKey: RedisKey,  // The key of the set.
    destinationKey: RedisKey,  // .</returns> <remarks></remarks>
    member: RedisValue,
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    storeDistances: bool,  // If set to true, the resulting set will be a regular sorted-set containing only distances, rather than a geo-encoded sorted-set.
    flags: CommandFlags  // The flags for this operation.
) → long

GeoSearchAndStoreAsync(
    sourceKey: RedisKey,
    destinationKey: RedisKey,
    member: RedisValue,
    shape: GeoSearchShape,
    count: int,
    demandClosest: bool,
    order: Order?,
    storeDistances: bool,
    flags: CommandFlags
) → Task<long>

GeoSearchAndStoreAsync(
    sourceKey: RedisKey,
    destinationKey: RedisKey,
    longitude: double,
    latitude: double,
    shape: GeoSearchShape,
    count: int,
    demandClosest: bool,
    order: Order?,
    storeDistances: bool,
    flags: CommandFlags
) → Task<long>

GeoSearchAndStore(
    sourceKey: RedisKey,  // The key of the set.
    destinationKey: RedisKey,  // .</returns> <remarks></remarks>
    member: RedisValue,
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    storeDistances: bool,  // If set to true, the resulting set will be a regular sorted-set containing only distances, rather than a geo-encoded sorted-set.
    flags: CommandFlags  // The flags for this operation.
) → long

GeoSearchAndStore(
    sourceKey: RedisKey,  // The key of the set.
    destinationKey: RedisKey,  // .</returns> <remarks></remarks>
    longitude: double,  // The longitude of the center point.
    latitude: double,  // The latitude of the center point.
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    storeDistances: bool,  // If set to true, the resulting set will be a regular sorted-set containing only distances, rather than a geo-encoded sorted-set.
    flags: CommandFlags  // The flags for this operation.
) → long

GeoSearchAndStore(
    sourceKey: RedisKey,  // The key of the set.
    destinationKey: RedisKey,  // .</returns> <remarks></remarks>
    member: RedisValue,
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    storeDistances: bool,  // If set to true, the resulting set will be a regular sorted-set containing only distances, rather than a geo-encoded sorted-set.
    flags: CommandFlags  // The flags for this operation.
) → long

geosearchstore(
    $destination: string,
    $source: string,
    $from: FromInterface,
    $by: ByInterface,
    ?string $sorting = null: Any,
    int $count = -1: Any,
    bool $any = false: Any,
    bool $storeDist = false: Any
) → int

Available since:: Redis Open Source 6.2.0
Time 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
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 similar to GEOSEARCH, but it stores the result in the provided destination.

This command replaces the now deprecated GEORADIUS and GEORADIUSBYMEMBER.

By default, it stores the results in the destination sorted set with their geospatial information.

When using the STOREDIST option, the command stores the items in a sorted set populated with their distance from the center of the circle or box, as a floating-point number, in the same unit specified for that shape.

Required arguments

destination

The key to store the results in.

source

The geospatial index key to search.

Query center points:

FROMMEMBER member

Use the position of the existing member as the center of the search. Mutually exclusive with FROMLONLAT.

FROMLONLAT longitude latitude

Use the given coordinates as the center of the search. Mutually exclusive with FROMMEMBER.

Query shape options:

BYRADIUS radius M | KM | FT | MI

Search within a circle of the given radius in the specified unit. Mutually exclusive with BYBOX.

BYBOX width height M | KM | FT | MI

Search within an axis-aligned box of the given width and height in the specified unit. Mutually exclusive with BYRADIUS.

Optional arguments

ASC | DESC

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

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.

STOREDIST

Store the distance from the center as the sorted-set score, instead of the geohash-encoded position.

Examples

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

Integer reply: the number of elements in the resulting set

History

Starting with Redis version 7.0.0: Added support for uppercase unit names.