Package io.valkey.springframework.data.valkey.connection

Interface ReactiveGeoCommands

All Known Subinterfaces:

ReactiveClusterGeoCommands

public interface ReactiveGeoCommands

Valkey Geo commands executed using reactive infrastructure.

Since:

2.0

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ReactiveGeoCommands.GeoAddCommand	GEOADD command parameters.
static class	ReactiveGeoCommands.GeoDistCommand	GEODIST command parameters.
static class	ReactiveGeoCommands.GeoHashCommand	GEOHASH command parameters.
static class	ReactiveGeoCommands.GeoPosCommand	GEOPOS command parameters.
static class	ReactiveGeoCommands.GeoRadiusByMemberCommand	GEORADIUSBYMEMBER command parameters.
static class	ReactiveGeoCommands.GeoRadiusCommand	GEORADIUS command parameters.
static class	ReactiveGeoCommands.GeoSearchCommand	GEOSEARCH command parameters.
static class	ReactiveGeoCommands.GeoSearchStoreCommand	GEOSEARCHSTORE command parameters.

Method Summary

Modifier and Type	Method	Description
default reactor.core.publisher.Mono<Long>	geoAdd(ByteBuffer key, ValkeyGeoCommands.GeoLocation<ByteBuffer> location)	Add ValkeyGeoCommands.GeoLocation to key.
default reactor.core.publisher.Mono<Long>	geoAdd(ByteBuffer key, Collection<ValkeyGeoCommands.GeoLocation<ByteBuffer>> locations)	Add ValkeyGeoCommands.GeoLocation to key.
default reactor.core.publisher.Mono<Long>	geoAdd(ByteBuffer key, org.springframework.data.geo.Point point, ByteBuffer member)	Add Point with given member to key.
reactor.core.publisher.Flux<ReactiveValkeyConnection.NumericResponse<ReactiveGeoCommands.GeoAddCommand,Long>>	geoAdd(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoAddCommand> commands)	Add ValkeyGeoCommands.GeoLocations to key.
default reactor.core.publisher.Mono<org.springframework.data.geo.Distance>	geoDist(ByteBuffer key, ByteBuffer from, ByteBuffer to)	Get the Distance between from and to.
default reactor.core.publisher.Mono<org.springframework.data.geo.Distance>	geoDist(ByteBuffer key, ByteBuffer from, ByteBuffer to, org.springframework.data.geo.Metric metric)	Get the Distance between from and to.
reactor.core.publisher.Flux<ReactiveValkeyConnection.CommandResponse<ReactiveGeoCommands.GeoDistCommand,org.springframework.data.geo.Distance>>	geoDist(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoDistCommand> commands)	Get the Distance between from and to.
default reactor.core.publisher.Mono<String>	geoHash(ByteBuffer key, ByteBuffer member)	Get geohash representation of the position for the one member.
default reactor.core.publisher.Mono<List<String>>	geoHash(ByteBuffer key, Collection<ByteBuffer> members)	Get geohash representation of the position for one or more members.
reactor.core.publisher.Flux<ReactiveValkeyConnection.MultiValueResponse<ReactiveGeoCommands.GeoHashCommand,String>>	geoHash(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoHashCommand> commands)	Get geohash representation of the position for one or more members.
default reactor.core.publisher.Mono<org.springframework.data.geo.Point>	geoPos(ByteBuffer key, ByteBuffer member)	Get the Point representation of positions for the members.
default reactor.core.publisher.Mono<List<org.springframework.data.geo.Point>>	geoPos(ByteBuffer key, Collection<ByteBuffer> members)	Get the Point representation of positions for one or more members.
reactor.core.publisher.Flux<ReactiveValkeyConnection.MultiValueResponse<ReactiveGeoCommands.GeoPosCommand,org.springframework.data.geo.Point>>	geoPos(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoPosCommand> commands)	Get the Point representation of positions for one or more members.
default reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>>	geoRadius(ByteBuffer key, org.springframework.data.geo.Circle circle)	Get the members within the boundaries of a given Circle.
default reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>>	geoRadius(ByteBuffer key, org.springframework.data.geo.Circle circle, ValkeyGeoCommands.GeoRadiusCommandArgs geoRadiusArgs)	Get the members within the boundaries of a given Circle applying given parameters.
reactor.core.publisher.Flux<ReactiveValkeyConnection.CommandResponse<ReactiveGeoCommands.GeoRadiusCommand,reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>>>>	geoRadius(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoRadiusCommand> commands)	Get the members within the boundaries of a given Circle applying given parameters.
default reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>>	geoRadiusByMember(ByteBuffer key, ByteBuffer member, org.springframework.data.geo.Distance distance)	Get the members within given Distance from member applying given parameters.
default reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>>	geoRadiusByMember(ByteBuffer key, ByteBuffer member, org.springframework.data.geo.Distance distance, ValkeyGeoCommands.GeoRadiusCommandArgs geoRadiusArgs)	Get the members within given Distance from member applying given parameters.
reactor.core.publisher.Flux<ReactiveValkeyConnection.CommandResponse<ReactiveGeoCommands.GeoRadiusByMemberCommand,reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>>>>	geoRadiusByMember(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoRadiusByMemberCommand> commands)	Get the members within given Distance from member applying given parameters.
default reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>>	geoSearch(ByteBuffer key, GeoReference<ByteBuffer> reference, GeoShape shape, ValkeyGeoCommands.GeoSearchCommandArgs args)	Return the members of a geo set which are within the borders of the area specified by a given shape.
reactor.core.publisher.Flux<ReactiveValkeyConnection.CommandResponse<ReactiveGeoCommands.GeoSearchCommand,reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>>>>	geoSearch(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoSearchCommand> commands)	Get the members within given GeoShape from GeoReference applying given parameters.
default reactor.core.publisher.Mono<Long>	geoSearchStore(ByteBuffer destKey, ByteBuffer key, GeoReference<ByteBuffer> reference, GeoShape shape, ValkeyGeoCommands.GeoSearchStoreCommandArgs args)	Query the members of a geo set which are within the borders of the area specified by a given shape and store the result at destKey.
reactor.core.publisher.Flux<ReactiveValkeyConnection.NumericResponse<ReactiveGeoCommands.GeoSearchStoreCommand,Long>>	geoSearchStore(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoSearchStoreCommand> commands)	Store the members within given GeoShape from GeoReference applying given parameters in a new geo set.

Method Details

geoAdd

default reactor.core.publisher.Mono<Long> geoAdd(ByteBuffer key,
 org.springframework.data.geo.Point point,
 ByteBuffer member)

Add Point with given member to key.

Parameters:

key - must not be null.

point - must not be null.

member - must not be null.

Returns:

See Also:

• Valkey Documentation: GEOADD

geoAdd

default reactor.core.publisher.Mono<Long> geoAdd(ByteBuffer key,
 ValkeyGeoCommands.GeoLocation<ByteBuffer> location)

Add ValkeyGeoCommands.GeoLocation to key.

Parameters:

key - must not be null.

location - must not be null.

Returns:

See Also:

• Valkey Documentation: GEOADD

geoAdd

default reactor.core.publisher.Mono<Long> geoAdd(ByteBuffer key,
 Collection<ValkeyGeoCommands.GeoLocation<ByteBuffer>> locations)

Add ValkeyGeoCommands.GeoLocation to key.

Parameters:

key - must not be null.

locations - must not be null.

Returns:

See Also:

• Valkey Documentation: GEOADD

geoAdd

reactor.core.publisher.Flux<ReactiveValkeyConnection.NumericResponse<ReactiveGeoCommands.GeoAddCommand,Long>> geoAdd(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoAddCommand> commands)

Add ValkeyGeoCommands.GeoLocations to key.

Parameters:

commands - must not be null.

Returns:

See Also:

• Valkey Documentation: GEOADD

geoDist

default reactor.core.publisher.Mono<org.springframework.data.geo.Distance> geoDist(ByteBuffer key,
 ByteBuffer from,
 ByteBuffer to)

Get the Distance between from and to.

Parameters:

key - must not be null.

from - must not be null.

to - must not be null.

Returns:

See Also:

• Valkey Documentation: GEODIST

geoDist

default reactor.core.publisher.Mono<org.springframework.data.geo.Distance> geoDist(ByteBuffer key,
 ByteBuffer from,
 ByteBuffer to,
 org.springframework.data.geo.Metric metric)

Get the Distance between from and to.

Parameters:

key - must not be null.

from - must not be null.

to - must not be null.

metric - must not be null.

Returns:

See Also:

• Valkey Documentation: GEODIST

geoDist

reactor.core.publisher.Flux<ReactiveValkeyConnection.CommandResponse<ReactiveGeoCommands.GeoDistCommand,org.springframework.data.geo.Distance>> geoDist(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoDistCommand> commands)

Get the Distance between from and to.

Parameters:

commands - must not be null.

Returns:

See Also:

• Valkey Documentation: GEODIST

geoHash

default reactor.core.publisher.Mono<String> geoHash(ByteBuffer key,
 ByteBuffer member)

Get geohash representation of the position for the one member.

Parameters:

key - must not be null.

member - must not be null.

Returns:

See Also:

• Valkey Documentation: GEOHASH

geoHash

default reactor.core.publisher.Mono<List<String>> geoHash(ByteBuffer key,
 Collection<ByteBuffer> members)

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

Parameters:

key - must not be null.

members - must not be null.

Returns:

See Also:

• Valkey Documentation: GEOHASH

geoHash

reactor.core.publisher.Flux<ReactiveValkeyConnection.MultiValueResponse<ReactiveGeoCommands.GeoHashCommand,String>> geoHash(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoHashCommand> commands)

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

Parameters:

commands - must not be null.

Returns:

See Also:

• Valkey Documentation: GEOHASH

geoPos

default reactor.core.publisher.Mono<org.springframework.data.geo.Point> geoPos(ByteBuffer key,
 ByteBuffer member)

Get the Point representation of positions for the members.

Parameters:

key - must not be null.

member - must not be null.

Returns:

See Also:

• Valkey Documentation: GEOPOS

geoPos

default reactor.core.publisher.Mono<List<org.springframework.data.geo.Point>> geoPos(ByteBuffer key,
 Collection<ByteBuffer> members)

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

Parameters:

key - must not be null.

members - must not be null.

Returns:

See Also:

• Valkey Documentation: GEOPOS

geoPos

reactor.core.publisher.Flux<ReactiveValkeyConnection.MultiValueResponse<ReactiveGeoCommands.GeoPosCommand,org.springframework.data.geo.Point>> geoPos(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoPosCommand> commands)

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

Parameters:

commands - must not be null.

Returns:

See Also:

• Valkey Documentation: GEOPOS

geoRadius

default reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>> geoRadius(ByteBuffer key,
 org.springframework.data.geo.Circle circle)

Get the members within the boundaries of a given Circle.

Parameters:

key - must not be null.

circle - must not be null.

Returns:

See Also:

• Valkey Documentation: GEORADIUS

geoRadius

default reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>> geoRadius(ByteBuffer key,
 org.springframework.data.geo.Circle circle,
 ValkeyGeoCommands.GeoRadiusCommandArgs geoRadiusArgs)

Get the members within the boundaries of a given Circle applying given parameters.

Parameters:

key - must not be null.

circle - must not be null.

geoRadiusArgs - must not be null.

Returns:

See Also:

• Valkey Documentation: GEORADIUS

geoRadius

reactor.core.publisher.Flux<ReactiveValkeyConnection.CommandResponse<ReactiveGeoCommands.GeoRadiusCommand,reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>>>> geoRadius(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoRadiusCommand> commands)

Get the members within the boundaries of a given Circle applying given parameters.

Parameters:

commands -

Returns:

See Also:

• Valkey Documentation: GEORADIUS

geoRadiusByMember

default reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>> geoRadiusByMember(ByteBuffer key,
 ByteBuffer member,
 org.springframework.data.geo.Distance distance)

Get the members within given Distance from member applying given parameters.

Parameters:

key - must not be null.

member - must not be null.

Returns:

See Also:

• Valkey Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

default reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>> geoRadiusByMember(ByteBuffer key,
 ByteBuffer member,
 org.springframework.data.geo.Distance distance,
 ValkeyGeoCommands.GeoRadiusCommandArgs geoRadiusArgs)

Get the members within given Distance from member applying given parameters.

Parameters:

key - must not be null.

member - must not be null.

geoRadiusArgs - must not be null.

Returns:

See Also:

• Valkey Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

reactor.core.publisher.Flux<ReactiveValkeyConnection.CommandResponse<ReactiveGeoCommands.GeoRadiusByMemberCommand,reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>>>> geoRadiusByMember(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoRadiusByMemberCommand> commands)

Get the members within given Distance from member applying given parameters.

Parameters:

commands - must not be null.

Returns:

See Also:

• Valkey Documentation: GEORADIUSBYMEMBER

geoSearch

default reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>> geoSearch(ByteBuffer key,
 GeoReference<ByteBuffer> reference,
 GeoShape shape,
 ValkeyGeoCommands.GeoSearchCommandArgs args)

Return the members of a geo set which are within the borders of the area specified by a given shape. The query's center point is provided by GeoReference.

Parameters:

key - must not be null.

reference - must not be null.

shape - must not be null.

args - must not be null.

Returns:

Since:

2.6

See Also:

• Valkey Documentation: GEOSEARCH

geoSearch

reactor.core.publisher.Flux<ReactiveValkeyConnection.CommandResponse<ReactiveGeoCommands.GeoSearchCommand,reactor.core.publisher.Flux<org.springframework.data.geo.GeoResult<ValkeyGeoCommands.GeoLocation<ByteBuffer>>>>> geoSearch(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoSearchCommand> commands)

Get the members within given GeoShape from GeoReference applying given parameters.

Parameters:

commands - must not be null.

Returns:

Since:

2.6

See Also:

• Valkey Documentation: GEOSEARCH

geoSearchStore

default reactor.core.publisher.Mono<Long> geoSearchStore(ByteBuffer destKey,
 ByteBuffer key,
 GeoReference<ByteBuffer> reference,
 GeoShape shape,
 ValkeyGeoCommands.GeoSearchStoreCommandArgs args)

Query the members of a geo set which are within the borders of the area specified by a given shape and store the result at destKey. The query's center point is provided by GeoReference.

Parameters:

key - must not be null.

reference - must not be null.

shape - must not be null.

args - must not be null.

Returns:

Since:

2.6

See Also:

• Valkey Documentation: GEOSEARCH

geoSearchStore

reactor.core.publisher.Flux<ReactiveValkeyConnection.NumericResponse<ReactiveGeoCommands.GeoSearchStoreCommand,Long>> geoSearchStore(org.reactivestreams.Publisher<ReactiveGeoCommands.GeoSearchStoreCommand> commands)

Store the members within given GeoShape from GeoReference applying given parameters in a new geo set.

Parameters:

commands - must not be null.

Returns:

Since:

2.6

See Also:

• Valkey Documentation: GEOSEARCHSTORE