Module spring.data.redis

Package org.springframework.data.redis.core

Interface ReactiveGeoOperations<K,M>

public interface ReactiveGeoOperations<K,M>

Reactive Redis operations for Geo Commands.

Since:

2.0

Author:

Mark Paluch, Christoph Strobl

See Also:

• Redis Documentation: Geo Commands

Method Summary

Modifier and Type	Method	Description
Mono<Long>	add(K key, Iterable<RedisGeoCommands.GeoLocation<M>> locations)	Add RedisGeoCommands.GeoLocations to key
Mono<Long>	add(K key, Map<M,Point> memberCoordinateMap)	Add Map of member / Point pairs to key.
Flux<Long>	add(K key, Publisher<? extends Collection<RedisGeoCommands.GeoLocation<M>>> locations)	Add RedisGeoCommands.GeoLocations to key
Mono<Long>	add(K key, Point point, M member)	Add Point with given member name to key.
Mono<Long>	add(K key, RedisGeoCommands.GeoLocation<M> location)	Add RedisGeoCommands.GeoLocation to key.
Mono<Boolean>	delete(K key)	Removes the given key.
Mono<Distance>	distance(K key, M member1, M member2)	Get the Distance between member1 and member2.
Mono<Distance>	distance(K key, M member1, M member2, Metric metric)	Get the Distance between member1 and member2 in the given Metric.
Mono<String>	hash(K key, M member)	Get Geohash representation of the position for one or more members.
Mono<List<String>>	hash(K key, M... members)	Get Geohash representation of the position for one or more members.
Mono<Point>	position(K key, M member)	Get the Point representation of positions for one or more members.
Mono<List<Point>>	position(K key, M... members)	Get the Point representation of positions for one or more members.
Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>>	radius(K key, M member, double radius)	Get the members within the circle defined by the members coordinates and given radius.
Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>>	radius(K key, M member, Distance distance)	Get the members within the circle defined by the members coordinates and given radius applying Metric.
Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>>	radius(K key, M member, Distance distance, RedisGeoCommands.GeoRadiusCommandArgs args)	Get the members within the circle defined by the members coordinates and given radius applying Metric and RedisGeoCommands.GeoRadiusCommandArgs.
Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>>	radius(K key, Circle within)	Get the members within the boundaries of a given Circle.
Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>>	radius(K key, Circle within, RedisGeoCommands.GeoRadiusCommandArgs args)	Get the members within the boundaries of a given Circle applying RedisGeoCommands.GeoRadiusCommandArgs.
Mono<Long>	remove(K key, M... members)	Remove the members.
default Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>>	search(K key, Circle within)	Get the members within the boundaries of a given Circle.
default Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>>	search(K key, GeoReference<M> reference, Distance radius)	Get the members using GeoReference as center of the query within the boundaries of a given radius.
default Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>>	search(K key, GeoReference<M> reference, Distance radius, RedisGeoCommands.GeoSearchCommandArgs args)	Get the members using GeoReference as center of the query within the boundaries of a given radius applying RedisGeoCommands.GeoRadiusCommandArgs.
default Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>>	search(K key, GeoReference<M> reference, BoundingBox boundingBox)	Get the members using GeoReference as center of the query within the boundaries of a given bounding box.
default Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>>	search(K key, GeoReference<M> reference, BoundingBox boundingBox, RedisGeoCommands.GeoSearchCommandArgs args)	Get the members using GeoReference as center of the query within the boundaries of a given bounding box applying RedisGeoCommands.GeoRadiusCommandArgs.
Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>>	search(K key, GeoReference<M> reference, GeoShape geoPredicate, RedisGeoCommands.GeoSearchCommandArgs args)	Get the members using GeoReference as center of the query within the boundaries of a given predicate applying RedisGeoCommands.GeoRadiusCommandArgs.
default Mono<Long>	searchAndStore(K key, K destKey, Circle within)	Get the members within the boundaries of a given Circle and store results at destKey.
default Mono<Long>	searchAndStore(K key, K destKey, GeoReference<M> reference, Distance radius)	Get the members using GeoReference as center of the query within the boundaries of a given radius and store results at destKey.
default Mono<Long>	searchAndStore(K key, K destKey, GeoReference<M> reference, Distance radius, RedisGeoCommands.GeoSearchStoreCommandArgs args)	Get the members using GeoReference as center of the query within the boundaries of a given radius applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.
default Mono<Long>	searchAndStore(K key, K destKey, GeoReference<M> reference, BoundingBox boundingBox)	Get the members using GeoReference as center of the query within the boundaries of a given bounding box and store results at destKey.
default Mono<Long>	searchAndStore(K key, K destKey, GeoReference<M> reference, BoundingBox boundingBox, RedisGeoCommands.GeoSearchStoreCommandArgs args)	Get the members using GeoReference as center of the query within the boundaries of a given bounding box applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.
Mono<Long>	searchAndStore(K key, K destKey, GeoReference<M> reference, GeoShape geoPredicate, RedisGeoCommands.GeoSearchStoreCommandArgs args)	Get the members using GeoReference as center of the query within the boundaries of a given predicate applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.

Method Details

add

Mono<Long> add(K key,
 Point point,
 M 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.

See Also:

• Redis Documentation: GEOADD

add

Mono<Long> add(K key,
 RedisGeoCommands.GeoLocation<M> location)

Add RedisGeoCommands.GeoLocation to key.

Parameters:

key - must not be null.

location - must not be null.

Returns:

Number of elements added.

See Also:

• Redis Documentation: GEOADD

add

Mono<Long> add(K key,
 Map<M,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.

See Also:

• Redis Documentation: GEOADD

add

Mono<Long> add(K key,
 Iterable<RedisGeoCommands.GeoLocation<M>> locations)

Add RedisGeoCommands.GeoLocations to key

Parameters:

key - must not be null.

locations - must not be null.

Returns:

Number of elements added.

See Also:

• Redis Documentation: GEOADD

add

Flux<Long> add(K key,
 Publisher<? extends Collection<RedisGeoCommands.GeoLocation<M>>> locations)

Add RedisGeoCommands.GeoLocations to key

Parameters:

key - must not be null.

locations - must not be null.

Returns:

Number of elements added.

See Also:

• Redis Documentation: GEOADD

distance

Mono<Distance> distance(K key,
 M member1,
 M 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.

See Also:

• Redis Documentation: GEODIST

distance

Mono<Distance> distance(K key,
 M member1,
 M member2,
 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.

See Also:

• Redis Documentation: GEODIST

hash

Mono<String> hash(K key,
 M member)

Get Geohash representation of the position for one or more members.

Parameters:

key - must not be null.

member - must not be null.

Returns:

never null.

See Also:

• Redis Documentation: GEOHASH

hash

Mono<List<String>> hash(K key,
 M... members)

Get Geohash representation of the position for one or more members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null.

See Also:

• Redis Documentation: GEOHASH

position

Mono<Point> position(K key,
 M member)

Get the Point representation of positions for one or more members.

Parameters:

key - must not be null.

member - must not be null.

Returns:

never null.

See Also:

• Redis Documentation: GEOPOS

position

Mono<List<Point>> position(K key,
 M... members)

Get the Point representation of positions for one or more members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null.

See Also:

• Redis Documentation: GEOPOS

radius

Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>> radius(K key,
 Circle within)

Get the members within the boundaries of a given Circle.

Parameters:

key - must not be null.

within - must not be null.

Returns:

never null.

See Also:

• Redis Documentation: GEORADIUS

radius

Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>> radius(K key,
 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:

never null.

See Also:

• Redis Documentation: GEORADIUS

radius

Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>> radius(K key,
 M 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:

never null.

See Also:

• Redis Documentation: GEORADIUSBYMEMBER

radius

Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>> radius(K key,
 M member,
 Distance distance)

Get the members within the circle defined by the members coordinates and given radius applying Metric.

Parameters:

key - must not be null.

member - must not be null.

distance - must not be null.

Returns:

never null.

See Also:

• Redis Documentation: GEORADIUSBYMEMBER

radius

Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>> radius(K key,
 M member,
 Distance distance,
 RedisGeoCommands.GeoRadiusCommandArgs args)

Get the members within the circle defined by the members coordinates and given radius applying Metric and RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

key - must not be null.

member - must not be null.

distance - must not be null.

args - must not be null.

Returns:

never null.

See Also:

• Redis Documentation: GEORADIUSBYMEMBER

remove

Mono<Long> remove(K key,
 M... members)

Remove the members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

Number of elements removed.

delete

Mono<Boolean> delete(K key)

Removes the given key.

Parameters:

key - must not be null.

search

default Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>> search(K key,
 Circle within)

Get the members within the boundaries of a given Circle.

Parameters:

key - must not be null.

within - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

search

default Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>> search(K key,
 GeoReference<M> reference,
 Distance radius)

Get the members using GeoReference as center of the query within the boundaries of a given radius.

Parameters:

key - must not be null.

reference - must not be null.

radius - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

search

default Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>> search(K key,
 GeoReference<M> reference,
 Distance radius,
 RedisGeoCommands.GeoSearchCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given radius applying RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

key - must not be null.

reference - must not be null.

radius - must not be null.

args - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

search

default Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>> search(K key,
 GeoReference<M> reference,
 BoundingBox boundingBox)

Get the members using GeoReference as center of the query within the boundaries of a given bounding box.

Parameters:

key - must not be null.

reference - must not be null.

boundingBox - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

search

default Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>> search(K key,
 GeoReference<M> reference,
 BoundingBox boundingBox,
 RedisGeoCommands.GeoSearchCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given bounding box applying RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

key - must not be null.

reference - must not be null.

boundingBox - must not be null.

args - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

search

Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>> search(K key,
 GeoReference<M> reference,
 GeoShape geoPredicate,
 RedisGeoCommands.GeoSearchCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given predicate applying RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

key - must not be null.

reference - must not be null.

geoPredicate - must not be null.

args - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

searchAndStore

default Mono<Long> searchAndStore(K key,
 K destKey,
 Circle within)

Get the members within the boundaries of a given Circle and store results at destKey.

Parameters:

key - must not be null.

within - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCHSTORE

searchAndStore

default Mono<Long> searchAndStore(K key,
 K destKey,
 GeoReference<M> reference,
 Distance radius)

Get the members using GeoReference as center of the query within the boundaries of a given radius and store results at destKey.

Parameters:

key - must not be null.

reference - must not be null.

radius - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCHSTORE

searchAndStore

default Mono<Long> searchAndStore(K key,
 K destKey,
 GeoReference<M> reference,
 Distance radius,
 RedisGeoCommands.GeoSearchStoreCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given radius applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.

Parameters:

key - must not be null.

reference - must not be null.

radius - must not be null.

args - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCHSTORE

searchAndStore

default Mono<Long> searchAndStore(K key,
 K destKey,
 GeoReference<M> reference,
 BoundingBox boundingBox)

Get the members using GeoReference as center of the query within the boundaries of a given bounding box and store results at destKey.

Parameters:

key - must not be null.

reference - must not be null.

boundingBox - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCHSTORE

searchAndStore

default Mono<Long> searchAndStore(K key,
 K destKey,
 GeoReference<M> reference,
 BoundingBox boundingBox,
 RedisGeoCommands.GeoSearchStoreCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given bounding box applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.

Parameters:

key - must not be null.

reference - must not be null.

boundingBox - must not be null.

args - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCHSTORE

searchAndStore

Mono<Long> searchAndStore(K key,
 K destKey,
 GeoReference<M> reference,
 GeoShape geoPredicate,
 RedisGeoCommands.GeoSearchStoreCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given predicate applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.

Parameters:

key - must not be null.

reference - must not be null.

geoPredicate - must not be null.

args - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCHSTORE