io.quarkus.redis.datasource.hash.ReactiveHashCommands Maven / Gradle / Ivy
Show all versions of quarkus-redis-client Show documentation
package io.quarkus.redis.datasource.hash;
import java.util.List;
import java.util.Map;
import io.quarkus.redis.datasource.ReactiveRedisCommands;
import io.quarkus.redis.datasource.ScanArgs;
import io.smallrye.mutiny.Uni;
/**
* Allows executing commands from the {@code hash} group.
* See the hash command list for further information about these commands.
*
* A {@code hash} is a like a {@code Map<F, V>}.
* This group is parameterized by the type of the key {@code Map<K>}. This is the type of the key in which the hash is
* stored.
* {@code <F>} is the type of the key in the map (field). The stored value are of type {@code Map<V>}
*
* @param the type of the key
* @param the type of the field
* @param the type of the value
*/
public interface ReactiveHashCommands extends ReactiveRedisCommands {
/**
* Execute the command HDEL.
* Summary: Delete one or more hash fields
* Group: hash
* Requires Redis 2.0.0
*
* @param key the key
* @return the number of fields that were removed from the hash, not including specified but
* non-existing fields.
**/
Uni hdel(K key, F... fields);
/**
* Execute the command HEXISTS.
* Summary: Determine if a hash field exists
* Group: hash
* Requires Redis 2.0.0
*
* @param key the key
* @param field the value
* @return {@code true} the hash contains field. {@code false} the hash does not contain field, or the key
* does not exist.
**/
Uni hexists(K key, F field);
/**
* Execute the command HGET.
* Summary: Get the value of a hash field
* Group: hash
* Requires Redis 2.0.0
*
* @param key the key
* @param field the value
* @return the value associated with {@code field}, or {@code null} when {@code field} is not present in
* the hash or the key does not exist.
**/
Uni hget(K key, F field);
/**
* Execute the command HINCRBY.
* Summary: Increment the integer value of a hash field by the given number
* Group: hash
* Requires Redis 2.0.0
*
* @param key the key
* @param field the value
* @return the value at field after the increment operation.
**/
Uni hincrby(K key, F field, long amount);
/**
* Execute the command HINCRBYFLOAT.
* Summary: Increment the float value of a hash field by the given amount
* Group: hash
* Requires Redis 2.6.0
*
* @param key the key
* @param field the value
* @return the value of field after the increment.
**/
Uni hincrbyfloat(K key, F field, double amount);
/**
* Execute the command HGETALL.
* Summary: Get all the fields and values in a hash
* Group: hash
* Requires Redis 2.0.0
*
* @param key the key
* @return the map fields -> values stored in the hash, or an empty map when {@code key} does not exist.
**/
Uni> hgetall(K key);
/**
* Execute the command HKEYS.
* Summary: Get all the fields in a hash
* Group: hash
* Requires Redis 2.0.0
*
* @param key the key
* @return list of fields in the hash, or an empty list when key does not exist.
**/
Uni> hkeys(K key);
/**
* Execute the command HLEN.
* Summary: Get the number of fields in a hash
* Group: hash
* Requires Redis 2.0.0
*
* @param key the key
* @return number of fields in the hash, or 0 when key does not exist.
**/
Uni hlen(K key);
/**
* Execute the command HMGET.
* Summary: Get the values of all the given hash fields
* Group: hash
* Requires Redis 2.0.0
*
* @param key the key
* @param fields the fields
* @return 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 {@code null} value for that field.
**/
Uni> hmget(K key, F... fields);
/**
* Execute the command HMSET.
* Summary: Set multiple hash fields to multiple values
* Group: hash
* Requires Redis 2.0.0
*
* @param key the key
* @param map the key/value map to set
* @return a Uni completed with {@code null} when the operation completes
* @deprecated Use {@link #hset(Object, Map)} with multiple field-value pairs.
**/
@Deprecated
Uni hmset(K key, Map map);
/**
* Execute the command HRANDFIELD.
* Summary: Get one or multiple random fields from a hash
* Group: hash
* Requires Redis 6.2.0
*
* @param key the key
* @return a random key from the hash, {@code null} if the key does not exist
**/
Uni hrandfield(K key);
/**
* Execute the command HRANDFIELD.
* Summary: Get one or multiple random fields from a hash
* Group: hash
* Requires Redis 6.2.0
*
* @param key the key
* @param count the number of random key to retrieve. If {@code count} is positive, the selected keys are distinct.
* If {@code count} is negative, the produced list can contain duplicated keys.
* @return the list of keys, empty if the key does not exist
**/
Uni> hrandfield(K key, long count);
/**
* Execute the command HRANDFIELD.
* Summary: Get one or multiple random fields and the associated values from a hash
* Group: hash
* Requires Redis 6.2.0
*
* @param key the key
* @param count the number of random key to retrieve. If {@code count} is positive, the selected keys are distinct.
* If {@code count} is negative, the produced list can contain duplicated keys. These duplicates are
* not included in the produced {@code Map}.
* @return the map containing the random keys and the associated values, {@code empty} if the key does not exist
**/
Uni> hrandfieldWithValues(K key, long count);
/**
* Execute the command HSCAN.
* Summary: Incrementally iterate hash fields and associated values
* Group: hash
* Requires Redis 2.8.0
*
* @param key the key
* @return the cursor.
**/
ReactiveHashScanCursor hscan(K key);
/**
* Execute the command HSCAN.
* Summary: Incrementally iterate hash fields and associated values
* Group: hash
* Requires Redis 2.8.0
*
* @param key the key
* @param scanArgs the additional argument
* @return the cursor
**/
ReactiveHashScanCursor hscan(K key, ScanArgs scanArgs);
/**
* Execute the command HSET.
* Summary: Set the string value of a hash field
* Group: hash
* Requires Redis 2.0.0
*
* @param key the key
* @param field the field
* @param value the value
* @return {@code true} if the value was set
**/
Uni hset(K key, F field, V value);
/**
* Execute the command HSET.
* Summary: Set the string value of a hash field
* Group: hash
* Requires Redis 2.0.0
*
* @param key the key
* @param map the set of key -> value to add to the hash
* @return the number of fields that were added.
**/
Uni hset(K key, Map map);
/**
* 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
*
* @param key the key
* @param field the value
* @param value the value
* @return {@code true} field is a new field in the hash and value was set. {@code false} field already exists in
* the hash and no operation was performed.
**/
Uni hsetnx(K key, F field, V value);
/**
* Execute the command HSTRLEN.
* Summary: Get the length of the value of a hash field
* Group: hash
* Requires Redis 3.2.0
*
* @param key the key
* @param field the value
* @return the string length of the value associated with {@code field}, or zero when {@code field} is not present
* in the hash or key does not exist at all.
**/
Uni hstrlen(K key, F field);
/**
* Execute the command HVALS.
* Summary: Get all the values in a hash
* Group: hash
* Requires Redis 2.0.0
*
* @param key the key
* @return list of values in the hash, or an empty list when key does not exist.
**/
Uni> hvals(K key);
}