Package org.springframework.data.redis.connection

Interface ReactiveHashCommands

All Known Subinterfaces:

ReactiveClusterHashCommands

public interface ReactiveHashCommands

Redis Hash 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	ReactiveHashCommands.HDelCommand
static class	ReactiveHashCommands.HExistsCommand	HEXISTS ReactiveRedisConnection.Command.
static class	ReactiveHashCommands.HGetCommand	HGET ReactiveRedisConnection.Command.
static class	ReactiveHashCommands.HRandFieldCommand	HRANDFIELD ReactiveRedisConnection.Command.
static class	ReactiveHashCommands.HSetCommand	HSET ReactiveRedisConnection.Command.
static class	ReactiveHashCommands.HStrLenCommand

Method Summary

Modifier and Type	Method	Description
default reactor.core.publisher.Mono<Boolean>	hDel(ByteBuffer key, ByteBuffer field)	Delete given hash field.
default reactor.core.publisher.Mono<Long>	hDel(ByteBuffer key, Collection<ByteBuffer> fields)	Delete given hash fields.
reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveHashCommands.HDelCommand,Long>>	hDel(org.reactivestreams.Publisher<ReactiveHashCommands.HDelCommand> commands)	Delete given hash fields.
default reactor.core.publisher.Mono<Boolean>	hExists(ByteBuffer key, ByteBuffer field)	Determine if given hash field exists.
reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveHashCommands.HExistsCommand>>	hExists(org.reactivestreams.Publisher<ReactiveHashCommands.HExistsCommand> commands)	Determine if given hash field exists.
default reactor.core.publisher.Mono<ByteBuffer>	hGet(ByteBuffer key, ByteBuffer field)	Get value for given field from hash at key.
default reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>>	hGetAll(ByteBuffer key)	Get entire hash stored at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.CommandResponse<ReactiveRedisConnection.KeyCommand,reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>>>>	hGetAll(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> commands)	Get entire hash stored at key.
default reactor.core.publisher.Flux<ByteBuffer>	hKeys(ByteBuffer key)	Get key set (fields) of hash at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.CommandResponse<ReactiveRedisConnection.KeyCommand,reactor.core.publisher.Flux<ByteBuffer>>>	hKeys(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> commands)	Get key set (fields) of hash at key.
default reactor.core.publisher.Mono<Long>	hLen(ByteBuffer key)	Get size of hash at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>>	hLen(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> commands)	Get size of hash at key.
default reactor.core.publisher.Mono<List<ByteBuffer>>	hMGet(ByteBuffer key, Collection<ByteBuffer> fields)	Get values for given fields from hash at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.MultiValueResponse<ReactiveHashCommands.HGetCommand,ByteBuffer>>	hMGet(org.reactivestreams.Publisher<ReactiveHashCommands.HGetCommand> commands)	Get values for given fields from hash at key.
default reactor.core.publisher.Mono<Boolean>	hMSet(ByteBuffer key, Map<ByteBuffer,ByteBuffer> fieldValueMap)	Set multiple hash fields to multiple values using data provided in fieldValueMap.
default reactor.core.publisher.Mono<ByteBuffer>	hRandField(ByteBuffer key)	Return a random field from the hash stored at key.
default reactor.core.publisher.Flux<ByteBuffer>	hRandField(ByteBuffer key, long count)	Return a random field from the hash stored at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.CommandResponse<ReactiveHashCommands.HRandFieldCommand,reactor.core.publisher.Flux<ByteBuffer>>>	hRandField(org.reactivestreams.Publisher<ReactiveHashCommands.HRandFieldCommand> commands)	Get random fields of hash at key.
default reactor.core.publisher.Mono<Map.Entry<ByteBuffer,ByteBuffer>>	hRandFieldWithValues(ByteBuffer key)	Return a random field from the hash along with its value stored at key.
default reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>>	hRandFieldWithValues(ByteBuffer key, long count)	Return a random field from the hash along with its value stored at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.CommandResponse<ReactiveHashCommands.HRandFieldCommand,reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>>>>	hRandFieldWithValues(org.reactivestreams.Publisher<ReactiveHashCommands.HRandFieldCommand> commands)	Get random fields along their values of hash at key.
default reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>>	hScan(ByteBuffer key)	Use a Flux to iterate over entries in the hash at key.
default reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>>	hScan(ByteBuffer key, ScanOptions options)	Use a Flux to iterate over entries in the hash at key given ScanOptions.
reactor.core.publisher.Flux<ReactiveRedisConnection.CommandResponse<ReactiveRedisConnection.KeyCommand,reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>>>>	hScan(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyScanCommand> commands)	Use a Flux to iterate over entries in the hash at key.
default reactor.core.publisher.Mono<Boolean>	hSet(ByteBuffer key, ByteBuffer field, ByteBuffer value)	Set the value of a hash field.
reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveHashCommands.HSetCommand>>	hSet(org.reactivestreams.Publisher<ReactiveHashCommands.HSetCommand> commands)	Set the value of a hash field.
default reactor.core.publisher.Mono<Boolean>	hSetNX(ByteBuffer key, ByteBuffer field, ByteBuffer value)	Set the value of a hash field.
default reactor.core.publisher.Mono<Long>	hStrLen(ByteBuffer key, ByteBuffer field)	Get the length of the value associated with field.
reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveHashCommands.HStrLenCommand,Long>>	hStrLen(org.reactivestreams.Publisher<ReactiveHashCommands.HStrLenCommand> commands)	Get the length of the value associated with field.
default reactor.core.publisher.Flux<ByteBuffer>	hVals(ByteBuffer key)	Get entry set (values) of hash at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.CommandResponse<ReactiveRedisConnection.KeyCommand,reactor.core.publisher.Flux<ByteBuffer>>>	hVals(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> commands)	Get entry set (values) of hash at key.

Method Details

hSet

default reactor.core.publisher.Mono<Boolean> hSet(ByteBuffer key,
 ByteBuffer field,
 ByteBuffer value)

Set the value of a hash field.

Parameters:

key - must not be null.

field - must not be null.

value - must not be null.

Returns:

See Also:

• Redis Documentation: HSET

hSetNX

default reactor.core.publisher.Mono<Boolean> hSetNX(ByteBuffer key,
 ByteBuffer field,
 ByteBuffer value)

Set the value of a hash field.

Parameters:

key - must not be null.

field - must not be null.

value - must not be null.

Returns:

See Also:

• Redis Documentation: HSETNX

hMSet

default reactor.core.publisher.Mono<Boolean> hMSet(ByteBuffer key,
 Map<ByteBuffer,ByteBuffer> fieldValueMap)

Set multiple hash fields to multiple values using data provided in fieldValueMap.

Parameters:

key - must not be null.

fieldValueMap - must not be null.

Returns:

See Also:

• Redis Documentation: HMSET

hSet

reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveHashCommands.HSetCommand>> hSet(org.reactivestreams.Publisher<ReactiveHashCommands.HSetCommand> commands)

Set the value of a hash field.

Parameters:

commands - must not be null.

Returns:

See Also:

• Redis Documentation: HSET

hGet

default reactor.core.publisher.Mono<ByteBuffer> hGet(ByteBuffer key,
 ByteBuffer field)

Get value for given field from hash at key.

Parameters:

key - must not be null.

field - must not be null.

Returns:

See Also:

• Redis Documentation: HGET

hMGet

default reactor.core.publisher.Mono<List<ByteBuffer>> hMGet(ByteBuffer key,
 Collection<ByteBuffer> fields)

Get values for given fields from hash at key. Values are in the order of the requested keys. Absent field values are represented using null in the resulting List.

Parameters:

key - must not be null.

fields - must not be null.

Returns:

See Also:

• Redis Documentation: HMGET

hMGet

reactor.core.publisher.Flux<ReactiveRedisConnection.MultiValueResponse<ReactiveHashCommands.HGetCommand,ByteBuffer>> hMGet(org.reactivestreams.Publisher<ReactiveHashCommands.HGetCommand> commands)

Get values for given fields from hash at key. Values are in the order of the requested keys. Absent field values are represented using null in the resulting List.

Parameters:

commands - must not be null.

Returns:

See Also:

• Redis Documentation: HMGET

hExists

default reactor.core.publisher.Mono<Boolean> hExists(ByteBuffer key,
 ByteBuffer field)

Determine if given hash field exists.

Parameters:

key - must not be null.

field - must not be null.

Returns:

See Also:

• Redis Documentation: HEXISTS

hExists

reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveHashCommands.HExistsCommand>> hExists(org.reactivestreams.Publisher<ReactiveHashCommands.HExistsCommand> commands)

Determine if given hash field exists.

Parameters:

commands -

Returns:

See Also:

• Redis Documentation: HEXISTS

hDel

default reactor.core.publisher.Mono<Boolean> hDel(ByteBuffer key,
 ByteBuffer field)

Delete given hash field.

Parameters:

key - must not be null.

field - must not be null.

Returns:

See Also:

• Redis Documentation: HDEL

hDel

default reactor.core.publisher.Mono<Long> hDel(ByteBuffer key,
 Collection<ByteBuffer> fields)

Delete given hash fields.

Parameters:

key - must not be null.

fields - must not be null.

Returns:

See Also:

• Redis Documentation: HDEL

hDel

reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveHashCommands.HDelCommand,Long>> hDel(org.reactivestreams.Publisher<ReactiveHashCommands.HDelCommand> commands)

Delete given hash fields.

Parameters:

commands - must not be null.

Returns:

See Also:

• Redis Documentation: HDEL

hLen

default reactor.core.publisher.Mono<Long> hLen(ByteBuffer key)

Get size of hash at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: HLEN

hLen

reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>> hLen(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> commands)

Get size of hash at key.

Parameters:

commands - must not be null.

Returns:

See Also:

• Redis Documentation: HLEN

hRandField

default reactor.core.publisher.Mono<ByteBuffer> hRandField(ByteBuffer key)

Return a random field from the hash stored at key.

Parameters:

key - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: HRANDFIELD

hRandFieldWithValues

default reactor.core.publisher.Mono<Map.Entry<ByteBuffer,ByteBuffer>> hRandFieldWithValues(ByteBuffer key)

Return a random field from the hash along with its value stored at key.

Parameters:

key - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: HRANDFIELD

hRandField

default reactor.core.publisher.Flux<ByteBuffer> hRandField(ByteBuffer key,
 long count)

Return a random field from the hash stored at key. If the provided count argument is positive, return a list of distinct fields, capped either at count or the hash size. If count is negative, the behavior changes and the command is allowed to return the same field multiple times. In this case, the number of returned fields is the absolute value of the specified count.

Parameters:

key - must not be null.

count - number of fields to return.

Returns:

Since:

2.6

See Also:

• Redis Documentation: HRANDFIELD

hRandFieldWithValues

default reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>> hRandFieldWithValues(ByteBuffer key,
 long count)

Return a random field from the hash along with its value stored at key. If the provided count argument is positive, return a list of distinct fields, capped either at count or the hash size. If count is negative, the behavior changes and the command is allowed to return the same field multiple times. In this case, the number of returned fields is the absolute value of the specified count.

Parameters:

key - must not be null.

count - number of fields to return.

Returns:

null if key does not exist or when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: HRANDFIELD

hRandField

reactor.core.publisher.Flux<ReactiveRedisConnection.CommandResponse<ReactiveHashCommands.HRandFieldCommand,reactor.core.publisher.Flux<ByteBuffer>>> hRandField(org.reactivestreams.Publisher<ReactiveHashCommands.HRandFieldCommand> commands)

Get random fields of hash at key.

Parameters:

commands - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: HRANDFIELD

hRandFieldWithValues

reactor.core.publisher.Flux<ReactiveRedisConnection.CommandResponse<ReactiveHashCommands.HRandFieldCommand,reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>>>> hRandFieldWithValues(org.reactivestreams.Publisher<ReactiveHashCommands.HRandFieldCommand> commands)

Get random fields along their values of hash at key.

Parameters:

commands - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: HRANDFIELD

hKeys

default reactor.core.publisher.Flux<ByteBuffer> hKeys(ByteBuffer key)

Get key set (fields) of hash at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: HKEYS

hKeys

reactor.core.publisher.Flux<ReactiveRedisConnection.CommandResponse<ReactiveRedisConnection.KeyCommand,reactor.core.publisher.Flux<ByteBuffer>>> hKeys(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> commands)

Get key set (fields) of hash at key.

Parameters:

commands - must not be null.

Returns:

See Also:

• Redis Documentation: HKEYS

hVals

default reactor.core.publisher.Flux<ByteBuffer> hVals(ByteBuffer key)

Get entry set (values) of hash at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: HVALS

hVals

reactor.core.publisher.Flux<ReactiveRedisConnection.CommandResponse<ReactiveRedisConnection.KeyCommand,reactor.core.publisher.Flux<ByteBuffer>>> hVals(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> commands)

Get entry set (values) of hash at key.

Parameters:

commands - must not be null.

Returns:

See Also:

• Redis Documentation: HVALS

hGetAll

default reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>> hGetAll(ByteBuffer key)

Get entire hash stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: HGETALL

hGetAll

reactor.core.publisher.Flux<ReactiveRedisConnection.CommandResponse<ReactiveRedisConnection.KeyCommand,reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>>>> hGetAll(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> commands)

Get entire hash stored at key.

Parameters:

commands - must not be null.

Returns:

See Also:

• Redis Documentation: HGETALL

hScan

default reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>> hScan(ByteBuffer key)

Use a Flux to iterate over entries in the hash at key. The resulting Flux acts as a cursor and issues HSCAN commands itself as long as the subscriber signals demand.

Parameters:

key - must not be null.

Returns:

the Flux emitting entries one by one.

Throws:

IllegalArgumentException - in case the given key is null.

Since:

2.1

See Also:

• Redis Documentation: HSCAN

hScan

default reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>> hScan(ByteBuffer key,
 ScanOptions options)

Use a Flux to iterate over entries in the hash at key given ScanOptions. The resulting Flux acts as a cursor and issues HSCAN commands itself as long as the subscriber signals demand.

Parameters:

key - must not be null.

options - must not be null. Use ScanOptions.NONE instead.

Returns:

the Flux emitting the raw entries one by one.

Throws:

IllegalArgumentException - in case one of the required arguments is null.

Since:

2.1

See Also:

• Redis Documentation: HSCAN

hScan

reactor.core.publisher.Flux<ReactiveRedisConnection.CommandResponse<ReactiveRedisConnection.KeyCommand,reactor.core.publisher.Flux<Map.Entry<ByteBuffer,ByteBuffer>>>> hScan(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyScanCommand> commands)

Use a Flux to iterate over entries in the hash at key. The resulting Flux acts as a cursor and issues HSCAN commands itself as long as the subscriber signals demand.

Parameters:

commands - must not be null.

Returns:

the Flux emitting ReactiveRedisConnection.CommandResponse one by one.

Since:

2.1

See Also:

• Redis Documentation: HSCAN

hStrLen

default reactor.core.publisher.Mono<Long> hStrLen(ByteBuffer key,
 ByteBuffer field)

Get the length of the value associated with field. If either the key or the field do not exist, 0 is emitted.

Parameters:

key - must not be null.

field - must not be null.

Returns:

never null.

Since:

2.1

hStrLen

reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveHashCommands.HStrLenCommand,Long>> hStrLen(org.reactivestreams.Publisher<ReactiveHashCommands.HStrLenCommand> commands)

Get the length of the value associated with field. If either the key or the field do not exist, 0 is emitted.

Parameters:

commands - must not be null.

Returns:

never null.

Since:

2.1