Type Parameters:: K - the type of the key; V - the type of the value

All Superinterfaces:: RedisCommands

All Known Implementing Classes:: BlockingGeoCommandsImpl

public interface GeoCommands<K,V> extends RedisCommands

Allows executing commands from the geo group. See the geo command list for further information about these commands.

Geo-localized items are tuples composed of longitude, latitude and the member. The member is of type <V&gt. Each key can store multiple items.

Method Summary

Modifier and Type

Method

Description

boolean

geoadd(K key, double longitude, double latitude, V member)

Execute the command GEOADD.

boolean

geoadd(K key, double longitude, double latitude, V member, GeoAddArgs args)

Execute the command GEOADD.

int

geoadd(K key, GeoAddArgs args, GeoItem<V>... items)

Execute the command GEOADD.

boolean

geoadd(K key, GeoItem<V> item)

Execute the command GEOADD.

int

geoadd(K key, GeoItem<V>... items)

Execute the command GEOADD.

boolean

geoadd(K key, GeoItem<V> item, GeoAddArgs args)

Execute the command GEOADD.

boolean

geoadd(K key, GeoPosition position, V member)

Execute the command GEOADD.

OptionalDouble

geodist(K key, V from, V to, GeoUnit unit)

Execute the command GEODIST.

List<String>

geohash(K key, V... members)

Execute the command GEOHASH.

List<GeoPosition>

geopos(K key, V... members)

Execute the command GEOPOS.

Set<V>

georadius(K key, double longitude, double latitude, double radius, GeoUnit unit)

Deprecated.
See https://redis.io/commands/georadius

List<GeoValue<V>>

georadius(K key, double longitude, double latitude, double radius, GeoUnit unit, GeoRadiusArgs geoArgs)

Deprecated.
See https://redis.io/commands/georadius

long

georadius(K key, double longitude, double latitude, double radius, GeoUnit unit, GeoRadiusStoreArgs<K> geoArgs)

Deprecated.
See https://redis.io/commands/georadius

Set<V>

georadius(K key, GeoPosition position, double radius, GeoUnit unit)

Deprecated.
See https://redis.io/commands/georadius

List<GeoValue<V>>

georadius(K key, GeoPosition position, double radius, GeoUnit unit, GeoRadiusArgs geoArgs)

Deprecated.
See https://redis.io/commands/georadius

long

georadius(K key, GeoPosition position, double radius, GeoUnit unit, GeoRadiusStoreArgs<K> geoArgs)

Deprecated.
See https://redis.io/commands/georadius

Set<V>

georadiusbymember(K key, V member, double distance, GeoUnit unit)

Deprecated.
See https://redis.io/commands/georadiusbymember

List<GeoValue<V>>

georadiusbymember(K key, V member, double distance, GeoUnit unit, GeoRadiusArgs geoArgs)

Deprecated.
See https://redis.io/commands/georadiusbymember

long

georadiusbymember(K key, V member, double distance, GeoUnit unit, GeoRadiusStoreArgs<K> geoArgs)

Deprecated.
See https://redis.io/commands/georadiusbymember

List<GeoValue<V>>

geosearch(K key, GeoSearchArgs<V> args)

Execute the command GEOSEARCH.

long

geosearchstore(K destination, K key, GeoSearchStoreArgs<V> args, boolean storeDist)

Execute the command GEOSEARCHSTORE.

Methods inherited from interface io.quarkus.redis.datasource.RedisCommands
getDataSource

Method Details
- geoadd
  
  boolean geoadd(K key, double longitude, double latitude, V member)
  
  Execute the command GEOADD. Summary: Add one geospatial item in the geospatial index represented using a sorted set Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  longitude - the longitude coordinate according to WGS84.
  
  latitude - the latitude coordinate according to WGS84.
  
  member - the member to add.
  
  Returns:
  
  true if the geospatial item was added, false otherwise
- geoadd
  
  boolean geoadd(K key, GeoPosition position, V member)
  
  Execute the command GEOADD. Summary: Add one geospatial item in the geospatial index represented using a sorted set Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  position - the geo position
  
  member - the member to add.
  
  Returns:
  
  true if the geospatial item was added, false otherwise
- geoadd
  
  boolean geoadd(K key, GeoItem<V> item)
  
  Execute the command GEOADD. Summary: Add one geospatial item in the geospatial index represented using a sorted set Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  item - the item to add
  
  Returns:
  
  true if the geospatial item was added, false otherwise
- geoadd
  
  int geoadd(K key, GeoItem<V>... items)
  
  Execute the command GEOADD. Summary: Add one or more geospatial items in the geospatial index represented using a sorted set Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  items - the geo-item triplets containing the longitude, latitude and name / value
  
  Returns:
  
  the number of elements added to the sorted set (excluding score updates).
- geoadd
  
  boolean geoadd(K key, double longitude, double latitude, V member, GeoAddArgs args)
  
  Execute the command GEOADD. Summary: Add one geospatial item in the geospatial index represented using a sorted set Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  longitude - the longitude coordinate according to WGS84.
  
  latitude - the latitude coordinate according to WGS84.
  
  member - the member to add.
  
  args - additional arguments.
  
  Returns:
  
  true if the geospatial item was added, false otherwise
- geoadd
  
  boolean geoadd(K key, GeoItem<V> item, GeoAddArgs args)
  
  Execute the command GEOADD. Summary: Add one geospatial item in the geospatial index represented using a sorted set Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  item - the item to add
  
  args - additional arguments.
  
  Returns:
  
  true if the geospatial item was added, false otherwise
- geoadd
  
  int geoadd(K key, GeoAddArgs args, GeoItem<V>... items)
  
  Execute the command GEOADD. Summary: Add one or more geospatial items in the geospatial index represented using a sorted set Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  args - additional arguments.
  
  items - the items containing the longitude, latitude and name / value
  
  Returns:
  
  the number of elements added to the sorted set (excluding score updates). If the CH option is specified, the number of elements that were changed (added or updated).
- geodist
  
  OptionalDouble geodist(K key, V from, V to, GeoUnit unit)
  
  Execute the command GEODIST. Summary: Returns the distance between two members of a geospatial index Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  from - from member
  
  to - to member
  
  unit - the unit
  
  Returns:
  
  The command returns the distance as a double in the specified unit, or empty if one or both the elements are missing.
- geohash
  
  List<String> geohash(K key, V... members)
  
  Execute the command GEOHASH. Summary: Returns members of a geospatial index as standard geohash strings Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  members - the members
  
  Returns:
  
  The command returns an array where each element is the Geohash corresponding to each member name passed as argument to the command.
- geopos
  
  List<GeoPosition> geopos(K key, V... members)
  
  Execute the command GEOPOS. Summary: Returns longitude and latitude of members of a geospatial index Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  members - the items
  
  Returns:
  
  The command returns an array where each element is aGeoPosition representing longitude and latitude (x,y) of each member name passed as argument to the command. Non-existing elements are reported as null elements.
- georadius
  
  @Deprecated Set<V> georadius(K key, double longitude, double latitude, double radius, GeoUnit unit)
  
  Deprecated.
  See https://redis.io/commands/georadius
  
  Execute the command GEORADIUS. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  longitude - the longitude
  
  latitude - the latitude
  
  radius - the radius
  
  unit - the unit
  
  Returns:
  
  the list of values.
- georadius
  
  @Deprecated Set<V> georadius(K key, GeoPosition position, double radius, GeoUnit unit)
  
  Deprecated.
  See https://redis.io/commands/georadius
  
  Execute the command GEORADIUS. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  position - the position
  
  radius - the radius
  
  unit - the unit
  
  Returns:
  
  the list of values.
- georadius
  
  @Deprecated List<GeoValue<V>> georadius(K key, double longitude, double latitude, double radius, GeoUnit unit, GeoRadiusArgs geoArgs)
  
  Deprecated.
  See https://redis.io/commands/georadius
  
  Execute the command GEORADIUS. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  longitude - the longitude
  
  latitude - the latitude
  
  radius - the radius
  
  unit - the unit
  
  geoArgs - the extra arguments of the GEORADIUS command
  
  Returns:
  
  the list of GeoValue. Only the field requested using geoArgs are populated in the returned GeoValue.
- georadius
  
  @Deprecated List<GeoValue<V>> georadius(K key, GeoPosition position, double radius, GeoUnit unit, GeoRadiusArgs geoArgs)
  
  Deprecated.
  See https://redis.io/commands/georadius
  
  Execute the command GEORADIUS. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  position - the position
  
  radius - the radius
  
  unit - the unit
  
  geoArgs - the extra arguments of the GEORADIUS command
  
  Returns:
  
  the list of GeoValue. Only the field requested using geoArgs are populated in the returned GeoValue.
- georadius
  
  @Deprecated long georadius(K key, double longitude, double latitude, double radius, GeoUnit unit, GeoRadiusStoreArgs<K> geoArgs)
  
  Deprecated.
  See https://redis.io/commands/georadius
  
  Execute the command GEORADIUS. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point. It also stores the results in a sorted set. Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  longitude - the longitude
  
  latitude - the latitude
  
  radius - the radius
  
  unit - the unit
  
  geoArgs - the extra STORE arguments of the GEORADIUS command
  
  Returns:
  
  The number of items contained in the result written at the configured key.
- georadius
  
  @Deprecated long georadius(K key, GeoPosition position, double radius, GeoUnit unit, GeoRadiusStoreArgs<K> geoArgs)
  
  Deprecated.
  See https://redis.io/commands/georadius
  
  Execute the command GEORADIUS. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point. It also stores the results in a sorted set. Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  position - the position
  
  radius - the radius
  
  unit - the unit
  
  geoArgs - the extra STORE arguments of the GEORADIUS command
  
  Returns:
  
  The number of items contained in the result written at the configured key.
- georadiusbymember
  
  @Deprecated Set<V> georadiusbymember(K key, V member, double distance, GeoUnit unit)
  
  Deprecated.
  See https://redis.io/commands/georadiusbymember
  
  Execute the command GEORADIUSBYMEMBER. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  member - the member
  
  distance - the max distance
  
  Returns:
  
  the set of values
- georadiusbymember
  
  @Deprecated List<GeoValue<V>> georadiusbymember(K key, V member, double distance, GeoUnit unit, GeoRadiusArgs geoArgs)
  
  Deprecated.
  See https://redis.io/commands/georadiusbymember
  
  Execute the command GEORADIUSBYMEMBER. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  member - the member
  
  distance - the max distance
  
  geoArgs - the extra arguments of the GEORADIUS command
  
  Returns:
  
  the list of GeoValue. Only the field requested using geoArgs are populated in the returned values.
- georadiusbymember
  
  @Deprecated long georadiusbymember(K key, V member, double distance, GeoUnit unit, GeoRadiusStoreArgs<K> geoArgs)
  
  Deprecated.
  See https://redis.io/commands/georadiusbymember
  
  Execute the command GEORADIUSBYMEMBER. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member. It also stores the results in a sorted set. Group: geo Requires Redis 3.2.0
  
  Parameters:
  
  key - the key
  
  member - the member
  
  distance - the max distance
  
  geoArgs - the extra arguments of the GEORADIUS command
  
  Returns:
  
  The number of items contained in the result written at the configured key.
- geosearch
  
  List<GeoValue<V>> geosearch(K key, GeoSearchArgs<V> args)
  
  Execute the command GEOSEARCH. Summary: Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle. Group: geo Requires Redis 6.2.0
  
  Returns:
  
  the list of GeoValue<V>>. The populated data depends on the parameters configured in args.
- geosearchstore
  
  long geosearchstore(K destination, K key, GeoSearchStoreArgs<V> args, boolean storeDist)
  
  Execute the command GEOSEARCHSTORE. Summary: Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle, and store the result in another key. Group: geo Requires Redis 6.2.0
  
  Returns:
  
  the number of elements in the resulting set.

Interface GeoCommands<K,V>

Method Summary

Methods inherited from interface io.quarkus.redis.datasource.RedisCommands

Method Details

geoadd

geoadd

geoadd

geoadd

geoadd

geoadd

geoadd

geodist

geohash

geopos

georadius

georadius

georadius

georadius

georadius

georadius

georadiusbymember

georadiusbymember

georadiusbymember

geosearch

geosearchstore