io.lettuce.core.api.sync

Interface RedisHashCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

RedisAdvancedClusterCommands<K,V>, RedisClusterCommands<K,V>, RedisClusterPubSubCommands<K,V>, RedisCommands<K,V>, RedisPubSubCommands<K,V>

public interface RedisHashCommands<K,V>

Synchronous executed commands for Hashes (Key-Value pairs).

Since:

4.0

Author:

Mark Paluch

Generated class:

by io.lettuce.apigenerator.CreateSyncApi

Method Summary

Modifier and Type	Method and Description
Long	hdel(K key, K... fields) Delete one or more hash fields.
Boolean	hexists(K key, K field) Determine if a hash field exists.
V	hget(K key, K field) Get the value of a hash field.
Map<K,V>	hgetall(K key) Get all the fields and values in a hash.
Long	hgetall(KeyValueStreamingChannel<K,V> channel, K key) Stream over all the fields and values in a hash.
Long	hincrby(K key, K field, long amount) Increment the integer value of a hash field by the given number.
Double	hincrbyfloat(K key, K field, double amount) Increment the float value of a hash field by the given amount.
List<K>	hkeys(K key) Get all the fields in a hash.
Long	hkeys(KeyStreamingChannel<K> channel, K key) Stream over all the fields in a hash.
Long	hlen(K key) Get the number of fields in a hash.
Long	hmget(KeyValueStreamingChannel<K,V> channel, K key, K... fields) Stream over the values of all the given hash fields.
List<KeyValue<K,V>>	hmget(K key, K... fields) Get the values of all the given hash fields.
String	hmset(K key, Map<K,V> map) Set multiple hash fields to multiple values.
MapScanCursor<K,V>	hscan(K key) Incrementally iterate hash fields and associated values.
StreamScanCursor	hscan(KeyValueStreamingChannel<K,V> channel, K key) Incrementally iterate hash fields and associated values.
StreamScanCursor	hscan(KeyValueStreamingChannel<K,V> channel, K key, ScanArgs scanArgs) Incrementally iterate hash fields and associated values.
StreamScanCursor	hscan(KeyValueStreamingChannel<K,V> channel, K key, ScanCursor scanCursor) Incrementally iterate hash fields and associated values.
StreamScanCursor	hscan(KeyValueStreamingChannel<K,V> channel, K key, ScanCursor scanCursor, ScanArgs scanArgs) Incrementally iterate hash fields and associated values.
MapScanCursor<K,V>	hscan(K key, ScanArgs scanArgs) Incrementally iterate hash fields and associated values.
MapScanCursor<K,V>	hscan(K key, ScanCursor scanCursor) Incrementally iterate hash fields and associated values.
MapScanCursor<K,V>	hscan(K key, ScanCursor scanCursor, ScanArgs scanArgs) Incrementally iterate hash fields and associated values.
Boolean	hset(K key, K field, V value) Set the string value of a hash field.
Long	hset(K key, Map<K,V> map) Set multiple hash fields to multiple values.
Boolean	hsetnx(K key, K field, V value) Set the value of a hash field, only if the field does not exist.
Long	hstrlen(K key, K field) Get the string length of the field value in a hash.
List<V>	hvals(K key) Get all the values in a hash.
Long	hvals(ValueStreamingChannel<V> channel, K key) Stream over all the values in a hash.

Method Detail

hdel

Long hdel(K key,
          K... fields)

Delete one or more hash fields.

Parameters:

key - the key.

fields - the field type: key.

Returns:

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

hexists

Boolean hexists(K key,
                K field)

Determine if a hash field exists.

Parameters:

key - the key.

field - the field type: key.

Returns:

Boolean integer-reply specifically:

hget

V hget(K key,
       K field)

Get the value of a hash field.

Parameters:

key - the key.

field - the field type: key.

Returns:

V bulk-string-reply the value associated with field, or null when field is not present in the hash or key does not exist.

hincrby

Long hincrby(K key,
             K field,
             long amount)

Increment the integer value of a hash field by the given number.

Parameters:

key - the key.

field - the field type: key.

amount - the increment type: long.

Returns:

Long integer-reply the value at field after the increment operation.

hincrbyfloat

Double hincrbyfloat(K key,
                    K field,
                    double amount)

Increment the float value of a hash field by the given amount.

Parameters:

key - the key.

field - the field type: key.

amount - the increment type: double.

Returns:

Double bulk-string-reply the value of field after the increment.

hgetall

Map<K,V> hgetall(K key)

Get all the fields and values in a hash.

Parameters:

key - the key.

Returns:

Map<K,V> array-reply list of fields and their values stored in the hash, or an empty list when key does not exist.

hgetall

Long hgetall(KeyValueStreamingChannel<K,V> channel,
             K key)

Stream over all the fields and values in a hash.

Parameters:

channel - the channel.

key - the key.

Returns:

Long count of the keys.

hkeys

List<K> hkeys(K key)

Get all the fields in a hash.

Parameters:

key - the key.

Returns:

List<K> array-reply list of fields in the hash, or an empty list when key does not exist.

hkeys

Long hkeys(KeyStreamingChannel<K> channel,
           K key)

Stream over all the fields in a hash.

Parameters:

channel - the channel.

key - the key.

Returns:

Long count of the keys.

hlen

Long hlen(K key)

Get the number of fields in a hash.

Parameters:

key - the key.

Returns:

Long integer-reply number of fields in the hash, or 0 when key does not exist.

hmget

List<KeyValue<K,V>> hmget(K key,
                          K... fields)

Get the values of all the given hash fields.

Parameters:

key - the key.

fields - the field type: key.

Returns:

List<V> array-reply list of values associated with the given fields, in the same.

hmget

Long hmget(KeyValueStreamingChannel<K,V> channel,
           K key,
           K... fields)

Stream over the values of all the given hash fields.

Parameters:

channel - the channel.

key - the key.

fields - the fields.

Returns:

Long count of the keys.

hmset

String hmset(K key,
             Map<K,V> map)

Set multiple hash fields to multiple values.

Parameters:

key - the key.

map - the null.

Returns:

String simple-string-reply.

hscan

MapScanCursor<K,V> hscan(K key)

Incrementally iterate hash fields and associated values.

Parameters:

key - the key.

Returns:

MapScanCursor<K, V> map scan cursor.

hscan

MapScanCursor<K,V> hscan(K key,
                         ScanArgs scanArgs)

Incrementally iterate hash fields and associated values.

Parameters:

key - the key.

scanArgs - scan arguments.

Returns:

MapScanCursor<K, V> map scan cursor.

hscan

MapScanCursor<K,V> hscan(K key,
                         ScanCursor scanCursor,
                         ScanArgs scanArgs)

Incrementally iterate hash fields and associated values.

Parameters:

key - the key.

scanCursor - cursor to resume from a previous scan, must not be null.

scanArgs - scan arguments.

Returns:

MapScanCursor<K, V> map scan cursor.

hscan

MapScanCursor<K,V> hscan(K key,
                         ScanCursor scanCursor)

Incrementally iterate hash fields and associated values.

Parameters:

key - the key.

scanCursor - cursor to resume from a previous scan, must not be null.

Returns:

MapScanCursor<K, V> map scan cursor.

hscan

StreamScanCursor hscan(KeyValueStreamingChannel<K,V> channel,
                       K key)

Incrementally iterate hash fields and associated values.

Parameters:

channel - streaming channel that receives a call for every key-value pair.

key - the key.

Returns:

StreamScanCursor scan cursor.

hscan

StreamScanCursor hscan(KeyValueStreamingChannel<K,V> channel,
                       K key,
                       ScanArgs scanArgs)

Incrementally iterate hash fields and associated values.

Parameters:

channel - streaming channel that receives a call for every key-value pair.

key - the key.

scanArgs - scan arguments.

Returns:

StreamScanCursor scan cursor.

hscan

StreamScanCursor hscan(KeyValueStreamingChannel<K,V> channel,
                       K key,
                       ScanCursor scanCursor,
                       ScanArgs scanArgs)

Incrementally iterate hash fields and associated values.

Parameters:

channel - streaming channel that receives a call for every key-value pair.

key - the key.

scanCursor - cursor to resume from a previous scan, must not be null.

scanArgs - scan arguments.

Returns:

StreamScanCursor scan cursor.

hscan

StreamScanCursor hscan(KeyValueStreamingChannel<K,V> channel,
                       K key,
                       ScanCursor scanCursor)

Incrementally iterate hash fields and associated values.

Parameters:

channel - streaming channel that receives a call for every key-value pair.

key - the key.

scanCursor - cursor to resume from a previous scan, must not be null.

Returns:

StreamScanCursor scan cursor.

hset

Boolean hset(K key,
             K field,
             V value)

Set the string value of a hash field.

Parameters:

key - the key.

field - the field type: key.

value - the value.

Returns:

Boolean integer-reply specifically: true if field is a new field in the hash and value was set. false if field already exists in the hash and the value was updated.

hset

Long hset(K key,
          Map<K,V> map)

Set multiple hash fields to multiple values.

Parameters:

key - the key of the hash.

map - the field/value pairs to update.

Returns:

Long integer-reply: the number of fields that were added.

Since:

5.3

hsetnx

Boolean hsetnx(K key,
               K field,
               V value)

Set the value of a hash field, only if the field does not exist.

Parameters:

key - the key.

field - the field type: key.

value - the value.

Returns:

Boolean integer-reply specifically: 1 if field is a new field in the hash and value was set. 0 if field already exists in the hash and no operation was performed.

hstrlen

Long hstrlen(K key,
             K field)

Get the string length of the field value in a hash.

Parameters:

key - the key.

field - the field type: key.

Returns:

Long integer-reply the string length of the field value, or 0 when field is not present in the hash or key does not exist at all.

hvals

List<V> hvals(K key)

Get all the values in a hash.

Parameters:

key - the key.

Returns:

List<V> array-reply list of values in the hash, or an empty list when key does not exist.

hvals

Long hvals(ValueStreamingChannel<V> channel,
           K key)

Stream over all the values in a hash.

Parameters:

channel - streaming channel that receives a call for every value.

key - the key.

Returns:

Long count of the keys.