io.lettuce.core.api.reactive

Interface RedisGeoReactiveCommands<K,V>

All Known Subinterfaces:

RedisAdvancedClusterReactiveCommands<K,V>, RedisClusterPubSubReactiveCommands<K,V>, RedisClusterReactiveCommands<K,V>, RedisPubSubReactiveCommands<K,V>, RedisReactiveCommands<K,V>

All Known Implementing Classes:

AbstractRedisReactiveCommands, RedisAdvancedClusterReactiveCommandsImpl, RedisClusterPubSubReactiveCommandsImpl, RedisPubSubReactiveCommandsImpl, RedisReactiveCommandsImpl, RedisSentinelReactiveCommandsImpl

public interface RedisGeoReactiveCommands<K,V>

Reactive executed commands for the Geo-API.

Since:

4.0

Author:

Mark Paluch

Generated class:

by io.lettuce.apigenerator.CreateReactiveApi

Method Summary

Modifier and Type	Method and Description
Mono<Long>	geoadd(K key, double longitude, double latitude, V member) Single geo add.
Mono<Long>	geoadd(K key, double longitude, double latitude, V member, GeoAddArgs args) Single geo add.
Mono<Long>	geoadd(K key, GeoAddArgs args, GeoValue<V>... values) Multi geo add.
Mono<Long>	geoadd(K key, GeoAddArgs args, Object... lngLatMember) Multi geo add.
Mono<Long>	geoadd(K key, GeoValue<V>... values) Multi geo add.
Mono<Long>	geoadd(K key, Object... lngLatMember) Multi geo add.
Mono<Double>	geodist(K key, V from, V to, GeoArgs.Unit unit) Retrieve distance between points from and to.
Flux<Value<String>>	geohash(K key, V... members) Retrieve Geohash strings representing the position of one or more elements in a sorted set value representing a geospatial index.
Flux<Value<GeoCoordinates>>	geopos(K key, V... members) Get geo coordinates for the members.
Flux<V>	georadius(K key, double longitude, double latitude, double distance, GeoArgs.Unit unit) Retrieve members selected by distance with the center of longitude and latitude.
Flux<GeoWithin<V>>	georadius(K key, double longitude, double latitude, double distance, GeoArgs.Unit unit, GeoArgs geoArgs) Retrieve members selected by distance with the center of longitude and latitude.
Mono<Long>	georadius(K key, double longitude, double latitude, double distance, GeoArgs.Unit unit, GeoRadiusStoreArgs<K> geoRadiusStoreArgs) Perform a georadius(Object, double, double, double, GeoArgs.Unit, GeoArgs) query and store the results in a sorted set.
Flux<V>	georadiusbymember(K key, V member, double distance, GeoArgs.Unit unit) Retrieve members selected by distance with the center of member.
Flux<GeoWithin<V>>	georadiusbymember(K key, V member, double distance, GeoArgs.Unit unit, GeoArgs geoArgs) Retrieve members selected by distance with the center of member.
Mono<Long>	georadiusbymember(K key, V member, double distance, GeoArgs.Unit unit, GeoRadiusStoreArgs<K> geoRadiusStoreArgs) Perform a georadiusbymember(Object, Object, double, GeoArgs.Unit, GeoArgs) query and store the results in a sorted set.
Flux<V>	geosearch(K key, GeoSearch.GeoRef<K> reference, GeoSearch.GeoPredicate predicate) Retrieve members selected by distance with the center of reference the search predicate.
Flux<GeoWithin<V>>	geosearch(K key, GeoSearch.GeoRef<K> reference, GeoSearch.GeoPredicate predicate, GeoArgs geoArgs) Retrieve members selected by distance with the center of reference the search predicate.
Mono<Long>	geosearchstore(K destination, K key, GeoSearch.GeoRef<K> reference, GeoSearch.GeoPredicate predicate, GeoArgs geoArgs, boolean storeDist) Perform a geosearch(Object, GeoSearch.GeoRef, GeoSearch.GeoPredicate, GeoArgs) query and store the results in a sorted set.

Method Detail

geoadd

Mono<Long> geoadd(K key,
                  double longitude,
                  double latitude,
                  V member)

Single geo add.

Parameters:

key - the key of the geo set.

longitude - the longitude coordinate according to WGS84.

latitude - the latitude coordinate according to WGS84.

member - the member to add.

Returns:

Long integer-reply the number of elements that were added to the set.

geoadd

Mono<Long> geoadd(K key,
                  double longitude,
                  double latitude,
                  V member,
                  GeoAddArgs args)

Single geo add.

Parameters:

key - the key of the geo set.

longitude - the longitude coordinate according to WGS84.

latitude - the latitude coordinate according to WGS84.

member - the member to add.

args - additional arguments.

Returns:

Long integer-reply the number of elements that were added to the set.

Since:

6.1

geoadd

Mono<Long> geoadd(K key,
                  Object... lngLatMember)

Multi geo add.

Parameters:

key - the key of the geo set.

lngLatMember - triplets of double longitude, double latitude and V member.

Returns:

Long integer-reply the number of elements that were added to the set.

geoadd

Mono<Long> geoadd(K key,
                  GeoValue<V>... values)

Multi geo add.

Parameters:

key - the key of the geo set.

values - GeoValue values to add.

Returns:

Long integer-reply the number of elements that were added to the set.

Since:

6.1

geoadd

Mono<Long> geoadd(K key,
                  GeoAddArgs args,
                  Object... lngLatMember)

Multi geo add.

Parameters:

key - the key of the geo set.

args - additional arguments.

lngLatMember - triplets of double longitude, double latitude and V member.

Returns:

Long integer-reply the number of elements that were added to the set.

Since:

6.1

geoadd

Mono<Long> geoadd(K key,
                  GeoAddArgs args,
                  GeoValue<V>... values)

Multi geo add.

Parameters:

key - the key of the geo set.

args - additional arguments.

values - GeoValue values to add.

Returns:

Long integer-reply the number of elements that were added to the set.

Since:

6.1

geodist

Mono<Double> geodist(K key,
                     V from,
                     V to,
                     GeoArgs.Unit unit)

Retrieve distance between points from and to. If one or more elements are missing null is returned. Default in meters by, otherwise according to unit

Parameters:

key - the key of the geo set.

from - from member.

to - to member.

unit - distance unit.

Returns:

distance between points from and to. If one or more elements are missing null is returned.

geohash

Flux<Value<String>> geohash(K key,
                            V... members)

Retrieve Geohash strings representing the position of one or more elements in a sorted set value representing a geospatial index.

Parameters:

key - the key of the geo set.

members - the members.

Returns:

bulk reply Geohash strings in the order of members. Returns null if a member is not found.

geopos

Flux<Value<GeoCoordinates>> geopos(K key,
                                   V... members)

Get geo coordinates for the members.

Parameters:

key - the key of the geo set.

members - the members.

Returns:

a list of GeoCoordinatess representing the x,y position of each element specified in the arguments. For missing elements null is returned.

georadius

Flux<V> georadius(K key,
                  double longitude,
                  double latitude,
                  double distance,
                  GeoArgs.Unit unit)

Retrieve members selected by distance with the center of longitude and latitude.

Parameters:

key - the key of the geo set.

longitude - the longitude coordinate according to WGS84.

latitude - the latitude coordinate according to WGS84.

distance - radius distance.

unit - distance unit.

Returns:

bulk reply.

georadius

Flux<GeoWithin<V>> georadius(K key,
                             double longitude,
                             double latitude,
                             double distance,
                             GeoArgs.Unit unit,
                             GeoArgs geoArgs)

Retrieve members selected by distance with the center of longitude and latitude.

Parameters:

key - the key of the geo set.

longitude - the longitude coordinate according to WGS84.

latitude - the latitude coordinate according to WGS84.

distance - radius distance.

unit - distance unit.

geoArgs - args to control the result.

Returns:

nested multi-bulk reply. The GeoWithin contains only fields which were requested by GeoArgs.

georadius

Mono<Long> georadius(K key,
                     double longitude,
                     double latitude,
                     double distance,
                     GeoArgs.Unit unit,
                     GeoRadiusStoreArgs<K> geoRadiusStoreArgs)

Perform a georadius(Object, double, double, double, GeoArgs.Unit, GeoArgs) query and store the results in a sorted set.

Parameters:

key - the key of the geo set.

longitude - the longitude coordinate according to WGS84.

latitude - the latitude coordinate according to WGS84.

distance - radius distance.

unit - distance unit.

geoRadiusStoreArgs - args to store either the resulting elements with their distance or the resulting elements with their locations a sorted set.

Returns:

Long integer-reply the number of elements in the result.

georadiusbymember

Flux<V> georadiusbymember(K key,
                          V member,
                          double distance,
                          GeoArgs.Unit unit)

Retrieve members selected by distance with the center of member. The member itself is always contained in the results.

Parameters:

key - the key of the geo set.

member - reference member.

distance - radius distance.

unit - distance unit.

Returns:

set of members.

georadiusbymember

Flux<GeoWithin<V>> georadiusbymember(K key,
                                     V member,
                                     double distance,
                                     GeoArgs.Unit unit,
                                     GeoArgs geoArgs)

Retrieve members selected by distance with the center of member. The member itself is always contained in the results.

Parameters:

key - the key of the geo set.

member - reference member.

distance - radius distance.

unit - distance unit.

geoArgs - args to control the result.

Returns:

nested multi-bulk reply. The GeoWithin contains only fields which were requested by GeoArgs.

georadiusbymember

Mono<Long> georadiusbymember(K key,
                             V member,
                             double distance,
                             GeoArgs.Unit unit,
                             GeoRadiusStoreArgs<K> geoRadiusStoreArgs)

Perform a georadiusbymember(Object, Object, double, GeoArgs.Unit, GeoArgs) query and store the results in a sorted set.

Parameters:

key - the key of the geo set.

member - reference member.

distance - radius distance.

unit - distance unit.

geoRadiusStoreArgs - args to store either the resulting elements with their distance or the resulting elements with their locations a sorted set.

Returns:

Long integer-reply the number of elements in the result.

geosearch

Flux<V> geosearch(K key,
                  GeoSearch.GeoRef<K> reference,
                  GeoSearch.GeoPredicate predicate)

Retrieve members selected by distance with the center of reference the search predicate. Use GeoSearch to create reference and predicate objects.

Parameters:

key - the key of the geo set.

reference - the reference member or longitude/latitude coordinates.

predicate - the bounding box or radius to search in.

Returns:

bulk reply.

Since:

6.1

geosearch

Flux<GeoWithin<V>> geosearch(K key,
                             GeoSearch.GeoRef<K> reference,
                             GeoSearch.GeoPredicate predicate,
                             GeoArgs geoArgs)

Retrieve members selected by distance with the center of reference the search predicate. Use GeoSearch to create reference and predicate objects.

Parameters:

key - the key of the geo set.

reference - the reference member or longitude/latitude coordinates.

predicate - the bounding box or radius to search in.

geoArgs - args to control the result.

Returns:

nested multi-bulk reply. The GeoWithin contains only fields which were requested by GeoArgs.

Since:

6.1

geosearchstore

Mono<Long> geosearchstore(K destination,
                          K key,
                          GeoSearch.GeoRef<K> reference,
                          GeoSearch.GeoPredicate predicate,
                          GeoArgs geoArgs,
                          boolean storeDist)

Perform a geosearch(Object, GeoSearch.GeoRef, GeoSearch.GeoPredicate, GeoArgs) query and store the results in a sorted set.

Parameters:

destination - the destination where to store results.

key - the key of the geo set.

reference - the reference member or longitude/latitude coordinates.

predicate - the bounding box or radius to search in.

geoArgs - args to control the result.

storeDist - 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.

Returns:

Long integer-reply the number of elements in the result.

Since:

6.1