Package io.quarkus.redis.runtime.datasource

Class BlockingHashCommandsImpl<K,F,V>

java.lang.Object

io.quarkus.redis.runtime.datasource.AbstractRedisCommandGroup

io.quarkus.redis.runtime.datasource.BlockingHashCommandsImpl<K,F,V>

All Implemented Interfaces:

HashCommands<K,F,V>, RedisCommands

public class BlockingHashCommandsImpl<K,F,V>
extends AbstractRedisCommandGroup
implements HashCommands<K,F,V>

Field Summary

Fields inherited from class io.quarkus.redis.runtime.datasource.AbstractRedisCommandGroup

ds, timeout

Constructor Summary

Constructors

Constructor	Description
BlockingHashCommandsImpl(RedisDataSource ds, ReactiveHashCommands<K,F,V> reactive, Duration timeout)

Method Summary

Modifier and Type	Method	Description
int	hdel(K key, F... fields)	Execute the command HDEL.
boolean	hexists(K key, F field)	Execute the command HEXISTS.
V	hget(K key, F field)	Execute the command HGET.
Map<F,V>	hgetall(K key)	Execute the command HGETALL.
long	hincrby(K key, F field, long amount)	Execute the command HINCRBY.
double	hincrbyfloat(K key, F field, double amount)	Execute the command HINCRBYFLOAT.
List<F>	hkeys(K key)	Execute the command HKEYS.
long	hlen(K key)	Execute the command HLEN.
Map<F,V>	hmget(K key, F... fields)	Execute the command HMGET.
void	hmset(K key, Map<F,V> map)	Execute the command HMSET.
F	hrandfield(K key)	Execute the command HRANDFIELD.
List<F>	hrandfield(K key, long count)	Execute the command HRANDFIELD.
Map<F,V>	hrandfieldWithValues(K key, long count)	Execute the command HRANDFIELD.
HashScanCursor<F,V>	hscan(K key)	Execute the command HSCAN.
HashScanCursor<F,V>	hscan(K key, ScanArgs scanArgs)	Execute the command HSCAN.
boolean	hset(K key, F field, V value)	Execute the command HSET.
long	hset(K key, Map<F,V> map)	Execute the command HSET.
boolean	hsetnx(K key, F field, V value)	Execute the command HSETNX.
long	hstrlen(K key, F field)	Execute the command HSTRLEN.
List<V>	hvals(K key)	Execute the command HVALS.

Methods inherited from class io.quarkus.redis.runtime.datasource.AbstractRedisCommandGroup

getDataSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.quarkus.redis.datasource.RedisCommands

getDataSource

Constructor Detail

BlockingHashCommandsImpl

public BlockingHashCommandsImpl(RedisDataSource ds,
                                ReactiveHashCommands<K,F,V> reactive,
                                Duration timeout)

Method Detail

hdel

public int hdel(K key,
                F... fields)

Description copied from interface: HashCommands

Execute the command HDEL. Summary: Delete one or more hash fields Group: hash Requires Redis 2.0.0

Specified by:

hdel in interface HashCommands<K,F,V>

Parameters:

key - the key

Returns:

the number of fields that were removed from the hash, not including specified but non-existing fields.

hexists

public boolean hexists(K key,
                       F field)

Description copied from interface: HashCommands

Execute the command HEXISTS. Summary: Determine if a hash field exists Group: hash Requires Redis 2.0.0

Specified by:

hexists in interface HashCommands<K,F,V>

Parameters:

key - the key

field - the value

Returns:

true the hash contains field. false the hash does not contain field, or the key does not exist.

hget

public V hget(K key,
              F field)

Description copied from interface: HashCommands

Execute the command HGET. Summary: Get the value of a hash field Group: hash Requires Redis 2.0.0

Specified by:

hget in interface HashCommands<K,F,V>

Parameters:

key - the key

field - the value

Returns:

the value associated with field, or null when field is not present in the hash or the key does not exist.

hincrby

public long hincrby(K key,
                    F field,
                    long amount)

Description copied from interface: HashCommands

Execute the command HINCRBY. Summary: Increment the integer value of a hash field by the given number Group: hash Requires Redis 2.0.0

Specified by:

hincrby in interface HashCommands<K,F,V>

Parameters:

key - the key

field - the value

Returns:

the value at field after the increment operation.

hincrbyfloat

public double hincrbyfloat(K key,
                           F field,
                           double amount)

Description copied from interface: HashCommands

Execute the command HINCRBYFLOAT. Summary: Increment the float value of a hash field by the given amount Group: hash Requires Redis 2.6.0

Specified by:

hincrbyfloat in interface HashCommands<K,F,V>

Parameters:

key - the key

field - the value

Returns:

the value of field after the increment.

hgetall

public Map<F,V> hgetall(K key)

Description copied from interface: HashCommands

Execute the command HGETALL. Summary: Get all the fields and values in a hash Group: hash Requires Redis 2.0.0

Specified by:

hgetall in interface HashCommands<K,F,V>

Parameters:

key - the key

Returns:

the map fields -> values stored in the hash, or an empty map when key does not exist.

hkeys

public List<F> hkeys(K key)

Description copied from interface: HashCommands

Execute the command HKEYS. Summary: Get all the fields in a hash Group: hash Requires Redis 2.0.0

Specified by:

hkeys in interface HashCommands<K,F,V>

Parameters:

key - the key

Returns:

list of fields in the hash, or an empty list when key does not exist.

hlen

public long hlen(K key)

Description copied from interface: HashCommands

Execute the command HLEN. Summary: Get the number of fields in a hash Group: hash Requires Redis 2.0.0

Specified by:

hlen in interface HashCommands<K,F,V>

Parameters:

key - the key

Returns:

number of fields in the hash, or 0 when key does not exist.

hmget

public Map<F,V> hmget(K key,
                            F... fields)

Description copied from interface: HashCommands

Execute the command HMGET. Summary: Get the values of all the given hash fields Group: hash Requires Redis 2.0.0

Specified by:

hmget in interface HashCommands<K,F,V>

Parameters:

key - the key

fields - the fields

Returns:

list of values associated with the given fields, in the same order as they are requested. If a requested field does not exist, the returned map contains a null value for that field.

hmset

public void hmset(K key,
                  Map<F,V> map)

Description copied from interface: HashCommands

Execute the command HMSET. Summary: Set multiple hash fields to multiple values Group: hash Requires Redis 2.0.0

Specified by:

hmset in interface HashCommands<K,F,V>

Parameters:

key - the key

map - the key/value map to set

hrandfield

public F hrandfield(K key)

Description copied from interface: HashCommands

Execute the command HRANDFIELD. Summary: Get one or multiple random fields from a hash Group: hash Requires Redis 6.2.0

Specified by:

hrandfield in interface HashCommands<K,F,V>

Parameters:

key - the key

Returns:

a random key from the hash, null if the key does not exist

hrandfield

public List<F> hrandfield(K key,
                          long count)

Description copied from interface: HashCommands

Execute the command HRANDFIELD. Summary: Get one or multiple random fields from a hash Group: hash Requires Redis 6.2.0

Specified by:

hrandfield in interface HashCommands<K,F,V>

Parameters:

key - the key

count - the number of random key to retrieve. If count is positive, the selected keys are distinct. If count is negative, the produced list can contain duplicated keys.

Returns:

the list of keys, empty if the key does not exist

hrandfieldWithValues

public Map<F,V> hrandfieldWithValues(K key,
                                           long count)

Description copied from interface: HashCommands

Execute the command HRANDFIELD. Summary: Get one or multiple random fields and their associated values from a hash Group: hash Requires Redis 6.2.0

Specified by:

hrandfieldWithValues in interface HashCommands<K,F,V>

Parameters:

key - the key

count - the number of random key to retrieve. If count is positive, the selected keys are distinct. If count is negative, the produced list can contain duplicated keys. These duplicates are not included in the produced Map.

Returns:

the map containing the random keys and the associated values, empty if the key does not exist

hscan

public HashScanCursor<F,V> hscan(K key)

Description copied from interface: HashCommands

Execute the command HSCAN. Summary: Incrementally iterate hash fields and associated values Group: hash Requires Redis 2.8.0

Specified by:

hscan in interface HashCommands<K,F,V>

Parameters:

key - the key

Returns:

the cursor.

hscan

public HashScanCursor<F,V> hscan(K key,
                                       ScanArgs scanArgs)

Description copied from interface: HashCommands

Execute the command HSCAN. Summary: Incrementally iterate hash fields and associated values Group: hash Requires Redis 2.8.0

Specified by:

hscan in interface HashCommands<K,F,V>

Parameters:

key - the key

scanArgs - the additional argument

Returns:

the cursor

hset

public boolean hset(K key,
                    F field,
                    V value)

Description copied from interface: HashCommands

Execute the command HSET. Summary: Set the string value of a hash field Group: hash Requires Redis 2.0.0

Specified by:

hset in interface HashCommands<K,F,V>

Parameters:

key - the key

field - the field

value - the value

Returns:

true if the value was set

hset

public long hset(K key,
                 Map<F,V> map)

Description copied from interface: HashCommands

Execute the command HSET. Summary: Set the string value of a hash field Group: hash Requires Redis 2.0.0

Specified by:

hset in interface HashCommands<K,F,V>

Parameters:

key - the key

map - the set of key -> value to add to the hash

Returns:

the number of fields that were added.

hsetnx

public boolean hsetnx(K key,
                      F field,
                      V value)

Description copied from interface: HashCommands

Execute the command HSETNX. Summary: Set the value of a hash field, only if the field does not exist Group: hash Requires Redis 2.0.0

Specified by:

hsetnx in interface HashCommands<K,F,V>

Parameters:

key - the key

field - the value

value - the value

Returns:

true field is a new field in the hash and value was set. false field already exists in the hash and no operation was performed.

hstrlen

public long hstrlen(K key,
                    F field)

Description copied from interface: HashCommands

Execute the command HSTRLEN. Summary: Get the length of the value of a hash field Group: hash Requires Redis 3.2.0

Specified by:

hstrlen in interface HashCommands<K,F,V>

Parameters:

key - the key

field - the value

Returns:

the string length of the value associated with field, or zero when field is not present in the hash or key does not exist at all.

hvals

public List<V> hvals(K key)

Description copied from interface: HashCommands

Execute the command HVALS. Summary: Get all the values in a hash Group: hash Requires Redis 2.0.0

Specified by:

hvals in interface HashCommands<K,F,V>

Parameters:

key - the key

Returns:

list of values in the hash, or an empty list when key does not exist.