Package io.lettuce.core.cluster.api.sync

Interface NodeSelectionHashCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

NodeSelectionCommands<K,V>

public interface NodeSelectionHashCommands<K,V>

Synchronous executed commands on a node selection for Hashes (Key-Value pairs).

Since:

4.0

Author:

Mark Paluch

Generated class:

by io.lettuce.apigenerator.CreateSyncNodeSelectionClusterApi

Method Summary

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

Method Detail

hdel

Executions<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

Executions<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: true if the hash contains field. false if the hash does not contain field, or key does not exist.

hget

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

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

Set multiple hash fields to multiple values.

Parameters:

key - the key.

map - the hash to apply.

Returns:

String simple-string-reply.

hrandfield

Executions<K> hrandfield(K key)

Return a random field from the hash stored at key.

Parameters:

key - the key.

Returns:

hash field name.

Since:

6.1

hrandfield

Executions<List<K>> hrandfield(K key,
                               long count)

Return count random fields from the hash stored at key.

Parameters:

key - the key.

count - the number of fields to return. If the provided count argument is positive, return an array of distinct fields.

Returns:

array-reply list of field names.

Since:

6.1

hrandfieldWithvalues

Executions<KeyValue<K,V>> hrandfieldWithvalues(K key)

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

Parameters:

key - the key.

Returns:

array-reply the key and value.

Since:

6.1

hrandfieldWithvalues

Executions<List<KeyValue<K,V>>> hrandfieldWithvalues(K key,
                                                           long count)

Return count random fields along their value from the hash stored at key.

Parameters:

key - the key.

count - the number of fields to return. If the provided count argument is positive, return an array of distinct fields.

Returns:

array-reply the keys and values.

Since:

6.1

hscan

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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.