Package io.quarkus.redis.datasource.geo
Interface ReactiveGeoCommands<K,V>
-
- Type Parameters:
K
- the type of the keyV
- the type of the value
- All Superinterfaces:
ReactiveRedisCommands
- All Known Implementing Classes:
ReactiveGeoCommandsImpl
public interface ReactiveGeoCommands<K,V> extends ReactiveRedisCommands
Allows executing commands from thegeo
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>
. Each key can store multiple items.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description io.smallrye.mutiny.Uni<Boolean>
geoadd(K key, double longitude, double latitude, V member)
Execute the command GEOADD.io.smallrye.mutiny.Uni<Boolean>
geoadd(K key, double longitude, double latitude, V member, GeoAddArgs args)
Execute the command GEOADD.io.smallrye.mutiny.Uni<Integer>
geoadd(K key, GeoAddArgs args, GeoItem<V>... items)
Execute the command GEOADD.io.smallrye.mutiny.Uni<Boolean>
geoadd(K key, GeoItem<V> item)
Execute the command GEOADD.io.smallrye.mutiny.Uni<Integer>
geoadd(K key, GeoItem<V>... items)
Execute the command GEOADD.io.smallrye.mutiny.Uni<Boolean>
geoadd(K key, GeoItem<V> item, GeoAddArgs args)
Execute the command GEOADD.io.smallrye.mutiny.Uni<Boolean>
geoadd(K key, GeoPosition position, V member)
Execute the command GEOADD.io.smallrye.mutiny.Uni<Double>
geodist(K key, V from, V to, GeoUnit unit)
Execute the command GEODIST.io.smallrye.mutiny.Uni<List<String>>
geohash(K key, V... members)
Execute the command GEOHASH.io.smallrye.mutiny.Uni<List<GeoPosition>>
geopos(K key, V... members)
Execute the command GEOPOS.io.smallrye.mutiny.Uni<Set<V>>
georadius(K key, double longitude, double latitude, double radius, GeoUnit unit)
Deprecated.See https://redis.io/commands/georadiusio.smallrye.mutiny.Uni<List<GeoValue<V>>>
georadius(K key, double longitude, double latitude, double radius, GeoUnit unit, GeoRadiusArgs geoArgs)
Deprecated.See https://redis.io/commands/georadiusio.smallrye.mutiny.Uni<Long>
georadius(K key, double longitude, double latitude, double radius, GeoUnit unit, GeoRadiusStoreArgs<K> geoArgs)
Deprecated.See https://redis.io/commands/georadiusio.smallrye.mutiny.Uni<Set<V>>
georadius(K key, GeoPosition position, double radius, GeoUnit unit)
Deprecated.See https://redis.io/commands/georadiusio.smallrye.mutiny.Uni<List<GeoValue<V>>>
georadius(K key, GeoPosition position, double radius, GeoUnit unit, GeoRadiusArgs geoArgs)
Deprecated.See https://redis.io/commands/georadiusio.smallrye.mutiny.Uni<Long>
georadius(K key, GeoPosition position, double radius, GeoUnit unit, GeoRadiusStoreArgs<K> geoArgs)
Deprecated.See https://redis.io/commands/georadiusio.smallrye.mutiny.Uni<Set<V>>
georadiusbymember(K key, V member, double distance, GeoUnit unit)
Deprecated.See https://redis.io/commands/georadiusbymemberio.smallrye.mutiny.Uni<List<GeoValue<V>>>
georadiusbymember(K key, V member, double distance, GeoUnit unit, GeoRadiusArgs geoArgs)
Deprecated.See https://redis.io/commands/georadiusbymemberio.smallrye.mutiny.Uni<Long>
georadiusbymember(K key, V member, double distance, GeoUnit unit, GeoRadiusStoreArgs<K> geoArgs)
Deprecated.See https://redis.io/commands/georadiusbymemberio.smallrye.mutiny.Uni<List<GeoValue<V>>>
geosearch(K key, GeoSearchArgs<V> args)
Execute the command GEOSEARCH.io.smallrye.mutiny.Uni<Long>
geosearchstore(K destination, K key, GeoSearchStoreArgs<V> args, boolean storeDist)
Execute the command GEOSEARCHSTORE.-
Methods inherited from interface io.quarkus.redis.datasource.ReactiveRedisCommands
getDataSource
-
-
-
-
Method Detail
-
geoadd
io.smallrye.mutiny.Uni<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 keylongitude
- 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
io.smallrye.mutiny.Uni<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 keyposition
- the geo positionmember
- the member to add.- Returns:
true
if the geospatial item was added,false
otherwise
-
geoadd
io.smallrye.mutiny.Uni<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 keyitem
- the item to add- Returns:
true
if the geospatial item was added,false
otherwise
-
geoadd
io.smallrye.mutiny.Uni<Integer> 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 keyitems
- 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
io.smallrye.mutiny.Uni<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 keylongitude
- 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
io.smallrye.mutiny.Uni<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 keyitem
- the item to addargs
- additional arguments.- Returns:
true
if the geospatial item was added,false
otherwise
-
geoadd
io.smallrye.mutiny.Uni<Integer> 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 keyargs
- 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
io.smallrye.mutiny.Uni<Double> 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 keyfrom
- from memberto
- to memberunit
- 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
io.smallrye.mutiny.Uni<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 keymembers
- 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
io.smallrye.mutiny.Uni<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 keymembers
- the items- Returns:
- The command returns an array where each element is a
GeoPosition
representing longitude and latitude (x,y) of each member name passed as argument to the command. Non-existing elements are reported asnull
elements.
-
georadius
@Deprecated io.smallrye.mutiny.Uni<Set<V>> georadius(K key, double longitude, double latitude, double radius, GeoUnit unit)
Deprecated.See https://redis.io/commands/georadiusExecute the command GEORADIUS. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a poUniGroup: geo Requires Redis 3.2.0 - Parameters:
key
- the keylongitude
- the longitudelatitude
- the latituderadius
- the radiusunit
- the unit- Returns:
- the list of values.
-
georadius
@Deprecated io.smallrye.mutiny.Uni<Set<V>> georadius(K key, GeoPosition position, double radius, GeoUnit unit)
Deprecated.See https://redis.io/commands/georadiusExecute the command GEORADIUS. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a poUniGroup: geo Requires Redis 3.2.0 - Parameters:
key
- the keyposition
- the positionradius
- the radiusunit
- the unit- Returns:
- the list of values.
-
georadius
@Deprecated io.smallrye.mutiny.Uni<List<GeoValue<V>>> georadius(K key, double longitude, double latitude, double radius, GeoUnit unit, GeoRadiusArgs geoArgs)
Deprecated.See https://redis.io/commands/georadiusExecute the command GEORADIUS. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a poUniGroup: geo Requires Redis 3.2.0
-
georadius
@Deprecated io.smallrye.mutiny.Uni<List<GeoValue<V>>> georadius(K key, GeoPosition position, double radius, GeoUnit unit, GeoRadiusArgs geoArgs)
Deprecated.See https://redis.io/commands/georadiusExecute the command GEORADIUS. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a poUniGroup: geo Requires Redis 3.2.0
-
georadius
@Deprecated io.smallrye.mutiny.Uni<Long> georadius(K key, double longitude, double latitude, double radius, GeoUnit unit, GeoRadiusStoreArgs<K> geoArgs)
Deprecated.See https://redis.io/commands/georadiusExecute the command GEORADIUS. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a poUni. It also stores the results in a sorted set. Group: geo Requires Redis 3.2.0 - Parameters:
key
- the keylongitude
- the longitudelatitude
- the latituderadius
- the radiusunit
- the unitgeoArgs
- the extraSTORE
arguments of theGEORADIUS
command- Returns:
- The number of items contained in the result written at the configured key.
-
georadius
@Deprecated io.smallrye.mutiny.Uni<Long> georadius(K key, GeoPosition position, double radius, GeoUnit unit, GeoRadiusStoreArgs<K> geoArgs)
Deprecated.See https://redis.io/commands/georadiusExecute the command GEORADIUS. Summary: Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a poUni. It also stores the results in a sorted set. Group: geo Requires Redis 3.2.0 - Parameters:
key
- the keyposition
- the positionradius
- the radiusunit
- the unitgeoArgs
- the extraSTORE
arguments of theGEORADIUS
command- Returns:
- The number of items contained in the result written at the configured key.
-
georadiusbymember
@Deprecated io.smallrye.mutiny.Uni<Set<V>> georadiusbymember(K key, V member, double distance, GeoUnit unit)
Deprecated.See https://redis.io/commands/georadiusbymemberExecute 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 keymember
- the memberdistance
- the max distance- Returns:
- the set of values
-
georadiusbymember
@Deprecated io.smallrye.mutiny.Uni<List<GeoValue<V>>> georadiusbymember(K key, V member, double distance, GeoUnit unit, GeoRadiusArgs geoArgs)
Deprecated.See https://redis.io/commands/georadiusbymemberExecute 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
-
georadiusbymember
@Deprecated io.smallrye.mutiny.Uni<Long> georadiusbymember(K key, V member, double distance, GeoUnit unit, GeoRadiusStoreArgs<K> geoArgs)
Deprecated.See https://redis.io/commands/georadiusbymemberExecute 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 keymember
- the memberdistance
- the max distancegeoArgs
- the extra arguments of theGEORADIUS
command- Returns:
- The number of items contained in the result written at the configured key.
-
geosearch
io.smallrye.mutiny.Uni<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 inargs
.
-
geosearchstore
io.smallrye.mutiny.Uni<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.
-
-