Interface RedisGeoCommands

All Known Subinterfaces:

DefaultedRedisClusterConnection, DefaultedRedisConnection, RedisClusterConnection, RedisCommands, RedisConnection, RedisConnectionUtils.RedisConnectionProxy, StringRedisConnection

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection

@NullUnmarked
public interface RedisGeoCommands

Geo-specific Redis commands.

Since:

1.8

Author:

Ninad Divadkar, Christoph Strobl, Mark Paluch

See Also:

• RedisCommands

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	RedisGeoCommands.DistanceUnit	Metrics supported by Redis.
static interface	RedisGeoCommands.GeoCommandArgs	Arguments to be used with RedisGeoCommands.
static class	RedisGeoCommands.GeoLocation<T>	RedisGeoCommands.GeoLocation representing a Point associated with a name.
static class	RedisGeoCommands.GeoRadiusCommandArgs	Additional arguments (like count/sort/...) to be used with RedisGeoCommands.
static class	RedisGeoCommands.GeoSearchCommandArgs	Additional arguments (like count/sort/...) to be used with RedisGeoCommands.
static class	RedisGeoCommands.GeoSearchStoreCommandArgs	Additional arguments (like count/sort/...) to be used with RedisGeoCommands.

Method Summary

Modifier and Type	Method	Description
Long	geoAdd(byte @NonNull [] key, @NonNull Iterable<@NonNull RedisGeoCommands.GeoLocation<byte[]>> locations)	Add RedisGeoCommands.GeoLocations to key
Long	geoAdd(byte @NonNull [] key, @NonNull Map<byte @NonNull [], @NonNull Point> memberCoordinateMap)	Add Map of member / Point pairs to key.
Long	geoAdd(byte @NonNull [] key, @NonNull Point point, byte @NonNull [] member)	Add Point with given member name to key.
default Long	geoAdd(byte @NonNull [] key, @NonNull RedisGeoCommands.GeoLocation<byte[]> location)	Add RedisGeoCommands.GeoLocation to key.
Distance	geoDist(byte @NonNull [] key, byte @NonNull [] member1, byte @NonNull [] member2)	Get the Distance between member1 and member2.
Distance	geoDist(byte @NonNull [] key, byte @NonNull [] member1, byte @NonNull [] member2, @NonNull Metric metric)	Get the Distance between member1 and member2 in the given Metric.
List<@NonNull String>	geoHash(byte @NonNull [] key, byte @NonNull [] @NonNull ... members)	Get Geohash representation of the position for one or more members.
List<@NonNull Point>	geoPos(byte @NonNull [] key, byte @NonNull [] @NonNull ... members)	Get the Point representation of positions for one or more members.
GeoResults<RedisGeoCommands.GeoLocation<byte[]>>	geoRadius(byte @NonNull [] key, @NonNull Circle within)	Get the members within the boundaries of a given Circle.
GeoResults<RedisGeoCommands.GeoLocation<byte[]>>	geoRadius(byte @NonNull [] key, @NonNull Circle within, @NonNull RedisGeoCommands.GeoRadiusCommandArgs args)	Get the members within the boundaries of a given Circle applying RedisGeoCommands.GeoRadiusCommandArgs.
default GeoResults<RedisGeoCommands.GeoLocation<byte[]>>	geoRadiusByMember(byte @NonNull [] key, byte @NonNull [] member, double radius)	Get the members within the circle defined by the members coordinates and given radius.
GeoResults<RedisGeoCommands.GeoLocation<byte[]>>	geoRadiusByMember(byte @NonNull [] key, byte @NonNull [] member, @NonNull Distance radius)	Get the members within the circle defined by the members coordinates and given Distance.
GeoResults<RedisGeoCommands.GeoLocation<byte[]>>	geoRadiusByMember(byte @NonNull [] key, byte @NonNull [] member, @NonNull Distance radius, @NonNull RedisGeoCommands.GeoRadiusCommandArgs args)	Get the members within the circle defined by the members coordinates, given Distance and RedisGeoCommands.GeoRadiusCommandArgs.
Long	geoRemove(byte @NonNull [] key, byte @NonNull [] @NonNull ... members)	Remove the members.
GeoResults<RedisGeoCommands.GeoLocation<byte[]>>	geoSearch(byte @NonNull [] key, @NonNull GeoReference<byte[]> reference, @NonNull GeoShape predicate, @NonNull RedisGeoCommands.GeoSearchCommandArgs args)	Return the members of a geo set which are within the borders of the area specified by a given shape.
Long	geoSearchStore(byte @NonNull [] destKey, byte @NonNull [] key, @NonNull GeoReference<byte[]> reference, @NonNull GeoShape predicate, @NonNull RedisGeoCommands.GeoSearchStoreCommandArgs args)	Query the members of a geo set which are within the borders of the area specified by a given shape and store the result at destKey.

Method Details

geoAdd

Long geoAdd(byte @NonNull [] key,
 @NonNull Point point,
 byte @NonNull [] member)

Add Point with given member name to key.

Parameters:

key - must not be null.

point - must not be null.

member - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

See Also:

• Redis Documentation: GEOADD

geoAdd

default Long geoAdd(byte @NonNull [] key,
 @NonNull RedisGeoCommands.GeoLocation<byte[]> location)

Add RedisGeoCommands.GeoLocation to key.

Parameters:

key - must not be null.

location - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

See Also:

• Redis Documentation: GEOADD

geoAdd

Long geoAdd(byte @NonNull [] key,
 @NonNull Map<byte @NonNull [], @NonNull Point> memberCoordinateMap)

Add Map of member / Point pairs to key.

Parameters:

key - must not be null.

memberCoordinateMap - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

See Also:

• Redis Documentation: GEOADD

geoAdd

Long geoAdd(byte @NonNull [] key,
 @NonNull Iterable<@NonNull RedisGeoCommands.GeoLocation<byte[]>> locations)

Add RedisGeoCommands.GeoLocations to key

Parameters:

key - must not be null.

locations - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

See Also:

• Redis Documentation: GEOADD

geoDist

Distance geoDist(byte @NonNull [] key,
 byte @NonNull [] member1,
 byte @NonNull [] member2)

Get the Distance between member1 and member2.

Parameters:

key - must not be null.

member1 - must not be null.

member2 - must not be null.

Returns:

can be null. null when used in pipeline / transaction.

See Also:

• Redis Documentation: GEODIST

geoDist

Distance geoDist(byte @NonNull [] key,
 byte @NonNull [] member1,
 byte @NonNull [] member2,
 @NonNull Metric metric)

Get the Distance between member1 and member2 in the given Metric.

Parameters:

key - must not be null.

member1 - must not be null.

member2 - must not be null.

metric - must not be null.

Returns:

can be null. null when used in pipeline / transaction.

See Also:

• Redis Documentation: GEODIST

geoHash

List<@NonNull String> geoHash(byte @NonNull [] key,
 byte @NonNull [] @NonNull ... members)

Get Geohash representation of the position for one or more members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

empty list when key or members do not exists. null when used in pipeline / transaction.

See Also:

• Redis Documentation: GEOHASH

geoPos

List<@NonNull Point> geoPos(byte @NonNull [] key,
 byte @NonNull [] @NonNull ... members)

Get the Point representation of positions for one or more members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

empty List when key of members do not exist. null when used in pipeline / transaction.

See Also:

• Redis Documentation: GEOPOS

geoRadius

GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadius(byte @NonNull [] key,
 @NonNull Circle within)

Get the members within the boundaries of a given Circle.

Parameters:

key - must not be null.

within - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: GEORADIUS

geoRadius

GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadius(byte @NonNull [] key,
 @NonNull Circle within,
 @NonNull RedisGeoCommands.GeoRadiusCommandArgs args)

Get the members within the boundaries of a given Circle applying RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

key - must not be null.

within - must not be null.

args - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: GEORADIUS

geoRadiusByMember

default GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadiusByMember(byte @NonNull [] key,
 byte @NonNull [] member,
 double radius)

Get the members within the circle defined by the members coordinates and given radius.

Parameters:

key - must not be null.

member - must not be null.

radius -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadiusByMember(byte @NonNull [] key,
 byte @NonNull [] member,
 @NonNull Distance radius)

Get the members within the circle defined by the members coordinates and given Distance.

Parameters:

key - must not be null.

member - must not be null.

radius - must not be null.

Returns:

null when used in pipeline / transaction..

See Also:

• Redis Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadiusByMember(byte @NonNull [] key,
 byte @NonNull [] member,
 @NonNull Distance radius,
 @NonNull RedisGeoCommands.GeoRadiusCommandArgs args)

Get the members within the circle defined by the members coordinates, given Distance and RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

key - must not be null.

member - must not be null.

radius - must not be null.

args - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: GEORADIUSBYMEMBER

geoRemove

Long geoRemove(byte @NonNull [] key,
 byte @NonNull [] @NonNull ... members)

Remove the members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

Number of elements removed. null when used in pipeline / transaction.

See Also:

• Redis Documentation: ZREM

geoSearch

GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoSearch(byte @NonNull [] key,
 @NonNull GeoReference<byte[]> reference,
 @NonNull GeoShape predicate,
 @NonNull RedisGeoCommands.GeoSearchCommandArgs args)

Return the members of a geo set which are within the borders of the area specified by a given shape. The query's center point is provided by GeoReference.

Parameters:

key - must not be null.

reference - must not be null.

predicate - must not be null.

args - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

geoSearchStore

Long geoSearchStore(byte @NonNull [] destKey,
 byte @NonNull [] key,
 @NonNull GeoReference<byte[]> reference,
 @NonNull GeoShape predicate,
 @NonNull RedisGeoCommands.GeoSearchStoreCommandArgs args)

Query the members of a geo set which are within the borders of the area specified by a given shape and store the result at destKey. The query's center point is provided by GeoReference.

Parameters:

key - must not be null.

reference - must not be null.

predicate - must not be null.

args - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH