org.springframework.data.redis.connection

Interface RedisGeoCommands

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection

public interface RedisGeoCommands

Geo-specific Redis commands.

Since:

1.8

Author:

Ninad Divadkar, Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	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 and Description
Long	geoAdd(byte[] key, Iterable<RedisGeoCommands.GeoLocation<byte[]>> locations) Add RedisGeoCommands.GeoLocations to key
Long	geoAdd(byte[] key, Map<byte[],org.springframework.data.geo.Point> memberCoordinateMap) Add Map of member / Point pairs to key.
Long	geoAdd(byte[] key, org.springframework.data.geo.Point point, byte[] member) Add Point with given member name to key.
default Long	geoAdd(byte[] key, RedisGeoCommands.GeoLocation<byte[]> location) Add RedisGeoCommands.GeoLocation to key.
org.springframework.data.geo.Distance	geoDist(byte[] key, byte[] member1, byte[] member2) Get the Distance between member1 and member2.
org.springframework.data.geo.Distance	geoDist(byte[] key, byte[] member1, byte[] member2, org.springframework.data.geo.Metric metric) Get the Distance between member1 and member2 in the given Metric.
List<String>	geoHash(byte[] key, byte[]... members) Get Geohash representation of the position for one or more members.
List<org.springframework.data.geo.Point>	geoPos(byte[] key, byte[]... members) Get the Point representation of positions for one or more members.
org.springframework.data.geo.GeoResults<RedisGeoCommands.GeoLocation<byte[]>>	geoRadius(byte[] key, org.springframework.data.geo.Circle within) Get the members within the boundaries of a given Circle.
org.springframework.data.geo.GeoResults<RedisGeoCommands.GeoLocation<byte[]>>	geoRadius(byte[] key, org.springframework.data.geo.Circle within, RedisGeoCommands.GeoRadiusCommandArgs args) Get the members within the boundaries of a given Circle applying RedisGeoCommands.GeoRadiusCommandArgs.
org.springframework.data.geo.GeoResults<RedisGeoCommands.GeoLocation<byte[]>>	geoRadiusByMember(byte[] key, byte[] member, org.springframework.data.geo.Distance radius) Get the members within the circle defined by the members coordinates and given Distance.
org.springframework.data.geo.GeoResults<RedisGeoCommands.GeoLocation<byte[]>>	geoRadiusByMember(byte[] key, byte[] member, org.springframework.data.geo.Distance radius, RedisGeoCommands.GeoRadiusCommandArgs args) Get the members within the circle defined by the members coordinates, given Distance and RedisGeoCommands.GeoRadiusCommandArgs.
default org.springframework.data.geo.GeoResults<RedisGeoCommands.GeoLocation<byte[]>>	geoRadiusByMember(byte[] key, byte[] member, double radius) Get the members within the circle defined by the members coordinates and given radius.
Long	geoRemove(byte[] key, byte[]... members) Remove the members.
org.springframework.data.geo.GeoResults<RedisGeoCommands.GeoLocation<byte[]>>	geoSearch(byte[] key, GeoReference<byte[]> reference, GeoShape predicate, 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[] destKey, byte[] key, GeoReference<byte[]> reference, GeoShape predicate, 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 Detail

geoAdd

@Nullable
Long geoAdd(byte[] key,
                      org.springframework.data.geo.Point point,
                      byte[] 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

@Nullable
default Long geoAdd(byte[] key,
                              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

@Nullable
Long geoAdd(byte[] key,
                      Map<byte[],org.springframework.data.geo.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

@Nullable
Long geoAdd(byte[] key,
                      Iterable<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

@Nullable
org.springframework.data.geo.Distance geoDist(byte[] key,
                                                        byte[] member1,
                                                        byte[] 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

@Nullable
org.springframework.data.geo.Distance geoDist(byte[] key,
                                                        byte[] member1,
                                                        byte[] member2,
                                                        org.springframework.data.geo.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

@Nullable
List<String> geoHash(byte[] key,
                               byte[]... 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

@Nullable
List<org.springframework.data.geo.Point> geoPos(byte[] key,
                                                          byte[]... 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

@Nullable
org.springframework.data.geo.GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadius(byte[] key,
                                                                                                  org.springframework.data.geo.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

@Nullable
org.springframework.data.geo.GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadius(byte[] key,
                                                                                                  org.springframework.data.geo.Circle within,
                                                                                                  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

@Nullable
default org.springframework.data.geo.GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadiusByMember(byte[] key,
                                                                                                                  byte[] 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

@Nullable
org.springframework.data.geo.GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadiusByMember(byte[] key,
                                                                                                          byte[] member,
                                                                                                          org.springframework.data.geo.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

@Nullable
org.springframework.data.geo.GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadiusByMember(byte[] key,
                                                                                                          byte[] member,
                                                                                                          org.springframework.data.geo.Distance radius,
                                                                                                          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

@Nullable
Long geoRemove(byte[] key,
                         byte[]... 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

@Nullable
org.springframework.data.geo.GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoSearch(byte[] key,
                                                                                                  GeoReference<byte[]> reference,
                                                                                                  GeoShape predicate,
                                                                                                  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

@Nullable
Long geoSearchStore(byte[] destKey,
                              byte[] key,
                              GeoReference<byte[]> reference,
                              GeoShape predicate,
                              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