K
- Key type.V
- Value type.public interface RedisHashCommands<K,V>
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.
|
K |
hrandfield(K key)
Return a random field from the hash stored at
key . |
List<K> |
hrandfield(K key,
long count)
Return
count random fields from the hash stored at key . |
KeyValue<K,V> |
hrandfieldWithvalues(K key)
Return a random field along its value from the hash stored at
key . |
List<KeyValue<K,V>> |
hrandfieldWithvalues(K key,
long count)
Return
count random fields along their value from the hash stored at key . |
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.
|
Long hdel(K key, K... fields)
key
- the key.fields
- the field type: key.Boolean hexists(K key, K field)
key
- the key.field
- the field type: key.true
if the hash contains field
. false
if the hash does not contain field
, or
key
does not exist.V hget(K key, K field)
key
- the key.field
- the field type: key.field
, or null
when field
is not present in
the hash or key
does not exist.Long hincrby(K key, K field, long amount)
key
- the key.field
- the field type: key.amount
- the increment type: long.field
after the increment operation.Double hincrbyfloat(K key, K field, double amount)
key
- the key.field
- the field type: key.amount
- the increment type: double.field
after the increment.Map<K,V> hgetall(K key)
key
- the key.key
does not exist.Long hgetall(KeyValueStreamingChannel<K,V> channel, K key)
channel
- the channel.key
- the key.List<K> hkeys(K key)
key
- the key.key
does not exist.Long hkeys(KeyStreamingChannel<K> channel, K key)
channel
- the channel.key
- the key.Long hlen(K key)
key
- the key.0
when key
does not exist.List<KeyValue<K,V>> hmget(K key, K... fields)
key
- the key.fields
- the field type: key.Long hmget(KeyValueStreamingChannel<K,V> channel, K key, K... fields)
channel
- the channel.key
- the key.fields
- the fields.String hmset(K key, Map<K,V> map)
key
- the key.map
- the hash to apply.K hrandfield(K key)
key
.key
- the key.List<K> hrandfield(K key, long count)
count
random fields from the hash stored at key
.key
- the key.count
- the number of fields to return. If the provided count argument is positive, return an array of distinct
fields.KeyValue<K,V> hrandfieldWithvalues(K key)
key
.key
- the key.count
- the number of fields to return. If the provided count argument is positive, return an array of distinct
fields.List<KeyValue<K,V>> hrandfieldWithvalues(K key, long count)
count
random fields along their value from the hash stored at key
.key
- the key.count
- the number of fields to return. If the provided count argument is positive, return an array of distinct
fields.MapScanCursor<K,V> hscan(K key)
key
- the key.MapScanCursor<K,V> hscan(K key, ScanArgs scanArgs)
key
- the key.scanArgs
- scan arguments.MapScanCursor<K,V> hscan(K key, ScanCursor scanCursor, ScanArgs scanArgs)
key
- the key.scanCursor
- cursor to resume from a previous scan, must not be null
.scanArgs
- scan arguments.MapScanCursor<K,V> hscan(K key, ScanCursor scanCursor)
key
- the key.scanCursor
- cursor to resume from a previous scan, must not be null
.StreamScanCursor hscan(KeyValueStreamingChannel<K,V> channel, K key)
channel
- streaming channel that receives a call for every key-value pair.key
- the key.StreamScanCursor hscan(KeyValueStreamingChannel<K,V> channel, K key, ScanArgs scanArgs)
channel
- streaming channel that receives a call for every key-value pair.key
- the key.scanArgs
- scan arguments.StreamScanCursor hscan(KeyValueStreamingChannel<K,V> channel, K key, ScanCursor scanCursor, ScanArgs scanArgs)
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.StreamScanCursor hscan(KeyValueStreamingChannel<K,V> channel, K key, ScanCursor scanCursor)
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
.Boolean hset(K key, K field, V value)
key
- the key.field
- the field type: key.value
- the value.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.Long hset(K key, Map<K,V> map)
key
- the key of the hash.map
- the field/value pairs to update.Boolean hsetnx(K key, K field, V value)
key
- the key.field
- the field type: key.value
- the value.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.Long hstrlen(K key, K field)
key
- the key.field
- the field type: key.field
value, or 0
when field
is not present
in the hash or key
does not exist at all.List<V> hvals(K key)
key
- the key.key
does not exist.Long hvals(ValueStreamingChannel<V> channel, K key)
channel
- streaming channel that receives a call for every value.key
- the key.Copyright © 2022 lettuce.io. All rights reserved.