ReactiveGeoOperations (Spring Data Redis 2.4.3 API)

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`reactor.core.publisher.Mono<Long>`	`add(K key, Iterable<RedisGeoCommands.GeoLocation<M>> locations)` Add `RedisGeoCommands.GeoLocation`s to key
`reactor.core.publisher.Mono<Long>`	`add(K key, Map<M,Point> memberCoordinateMap)` Add `Map` of member / `Point` pairs to key.
`reactor.core.publisher.Mono<Long>`	`add(K key, Point point, M member)` Add `Point` with given member name to key.
`reactor.core.publisher.Flux<Long>`	`add(K key, org.reactivestreams.Publisher<? extends Collection<RedisGeoCommands.GeoLocation<M>>> locations)` Add `RedisGeoCommands.GeoLocation`s to key
`reactor.core.publisher.Mono<Long>`	`add(K key, RedisGeoCommands.GeoLocation<M> location)` Add `RedisGeoCommands.GeoLocation` to key.
`reactor.core.publisher.Mono<Boolean>`	`delete(K key)` Removes the given key.
`reactor.core.publisher.Mono<Distance>`	`distance(K key, M member1, M member2)` Get the `Distance` between member1 and member2.
`reactor.core.publisher.Mono<Distance>`	`distance(K key, M member1, M member2, Metric metric)` Get the `Distance` between member1 and member2 in the given `Metric`.
`reactor.core.publisher.Mono<List<String>>`	`hash(K key, M... members)` Get Geohash representation of the position for one or more members.
`reactor.core.publisher.Mono<String>`	`hash(K key, M member)` Get Geohash representation of the position for one or more members.
`reactor.core.publisher.Mono<List<Point>>`	`position(K key, M... members)` Get the `Point` representation of positions for one or more members.
`reactor.core.publisher.Mono<Point>`	`position(K key, M member)` Get the `Point` representation of positions for one or more members.
`reactor.core.publisher.Flux<GeoResult<RedisGeoCommands.GeoLocation<M>>>`	`radius(K key, Circle within)` Get the members within the boundaries of a given `Circle`.
`reactor.core.publisher.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`.
`reactor.core.publisher.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`.
`reactor.core.publisher.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`.
`reactor.core.publisher.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.
`reactor.core.publisher.Mono<Long>`	`remove(K key, M... members)` Remove the members.

Method Detail

add

reactor.core.publisher.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
```
reactor.core.publisher.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
```
reactor.core.publisher.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

reactor.core.publisher.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

reactor.core.publisher.Flux<Long> add(K key,
                                      org.reactivestreams.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

reactor.core.publisher.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

reactor.core.publisher.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
```
reactor.core.publisher.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
```
reactor.core.publisher.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
```
reactor.core.publisher.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
```
reactor.core.publisher.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

reactor.core.publisher.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

reactor.core.publisher.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

reactor.core.publisher.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

reactor.core.publisher.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

reactor.core.publisher.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

reactor.core.publisher.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
```
reactor.core.publisher.Mono<Boolean> delete(K key)
```
Removes the given key.

Parameters:

key - must not be null.

Interface ReactiveGeoOperations<K,M>

Method Summary

Method Detail

add

add

add

add

add

distance

distance

hash

hash

position

position

radius

radius

radius

radius

radius

remove

delete