io.lettuce.core.cluster.api.async

Interface NodeSelectionGeoAsyncCommands<K,V>

All Known Subinterfaces:

NodeSelectionAsyncCommands<K,V>

public interface NodeSelectionGeoAsyncCommands<K,V>

Asynchronous executed commands on a node selection for the Geo-API.

Since:

4.0

Author:

Mark Paluch

Generated class:

by io.lettuce.apigenerator.CreateAsyncNodeSelectionClusterApi

Method Summary

Modifier and Type	Method and Description
AsyncExecutions<Long>	geoadd(K key, double longitude, double latitude, V member) Single geo add.
AsyncExecutions<Long>	geoadd(K key, Object... lngLatMember) Multi geo add.
AsyncExecutions<Double>	geodist(K key, V from, V to, GeoArgs.Unit unit) Retrieve distance between points from and to.
AsyncExecutions<List<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.
AsyncExecutions<List<GeoCoordinates>>	geopos(K key, V... members) Get geo coordinates for the members.
AsyncExecutions<Set<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.
AsyncExecutions<List<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.
AsyncExecutions<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.
AsyncExecutions<Set<V>>	georadiusbymember(K key, V member, double distance, GeoArgs.Unit unit) Retrieve members selected by distance with the center of member.
AsyncExecutions<List<GeoWithin<V>>>	georadiusbymember(K key, V member, double distance, GeoArgs.Unit unit, GeoArgs geoArgs) Retrieve members selected by distance with the center of member.
AsyncExecutions<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.

Method Detail

geoadd

AsyncExecutions<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

AsyncExecutions<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

geohash

AsyncExecutions<List<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.

georadius

AsyncExecutions<Set<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

AsyncExecutions<List<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

AsyncExecutions<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

AsyncExecutions<Set<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

AsyncExecutions<List<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

AsyncExecutions<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

geopos

AsyncExecutions<List<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.

geodist

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