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.
List<Long>	hexpire(K key, Duration seconds, ExpireArgs expireArgs, K... fields) Set the time to live for one or more fields, belonging to a certain key.
List<Long>	hexpire(K key, Duration seconds, K... fields) Set the time to live for one or more fields, belonging to a certain key.
List<Long>	hexpire(K key, long seconds, ExpireArgs expireArgs, K... fields) Set the time to live (in seconds) for one or more fields, belonging to a certain key.
List<Long>	hexpire(K key, long seconds, K... fields) Set the time to live (in seconds) for one or more fields, belonging to a certain key.
List<Long>	hexpireat(K key, Date timestamp, ExpireArgs expireArgs, K... fields) Set the time to live for one or more fields, belonging to a certain key as a UNIX timestamp.
List<Long>	hexpireat(K key, Date timestamp, K... fields) Set the time to live for one or more fields, belonging to a certain key as a UNIX timestamp.
List<Long>	hexpireat(K key, Instant timestamp, ExpireArgs expireArgs, K... fields) Set the time to live for one or more fields, belonging to a certain key as a UNIX timestamp.
List<Long>	hexpireat(K key, Instant timestamp, K... fields) Set the time to live for one or more fields, belonging to a certain key as a UNIX timestamp.
List<Long>	hexpireat(K key, long timestamp, ExpireArgs expireArgs, K... fields) Set the time to live for one or more fields, belonging to a certain key as a UNIX timestamp.
List<Long>	hexpireat(K key, long timestamp, K... fields) Set the time to live for one or more fields, belonging to a certain key as a UNIX timestamp.
List<Long>	hexpiretime(K key, K... fields) Get the time to live for one or more fields in as UNIX timestamp in seconds.
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.
List<Long>	hpersist(K key, K... fields) Remove the expiration from one or more fields.
List<Long>	hpexpire(K key, Duration milliseconds, ExpireArgs expireArgs, K... fields) Set the time to live for one or more fields in milliseconds.
List<Long>	hpexpire(K key, Duration milliseconds, K... fields) Set the time to live for one or more fields in milliseconds.
List<Long>	hpexpire(K key, long milliseconds, ExpireArgs expireArgs, K... fields) Set the time to live for one or more fields in milliseconds.
List<Long>	hpexpire(K key, long milliseconds, K... fields) Set the time to live for one or more fields in milliseconds.
List<Long>	hpexpireat(K key, Date timestamp, ExpireArgs expireArgs, K... fields) Set the time to live for one or more fields as a UNIX timestamp specified in milliseconds.
List<Long>	hpexpireat(K key, Date timestamp, K... fields) Set the time to live for one or more fields as a UNIX timestamp specified in milliseconds.
List<Long>	hpexpireat(K key, Instant timestamp, ExpireArgs expireArgs, K... fields) Set the time to live for one or more fields as a UNIX timestamp specified in milliseconds.
List<Long>	hpexpireat(K key, Instant timestamp, K... fields) Set the time to live for one or more fields as a UNIX timestamp specified in milliseconds.
List<Long>	hpexpireat(K key, long timestamp, ExpireArgs expireArgs, K... fields) Set the time to live for one or more fields as a UNIX timestamp specified in milliseconds.
List<Long>	hpexpireat(K key, long timestamp, K... fields) Set the time to live for one or more fields as a UNIX timestamp specified in milliseconds.
List<Long>	hpexpiretime(K key, K... fields) Get the time to live for one or more fields as UNIX timestamp in milliseconds.
List<Long>	hpttl(K key, K... fields) Get the time to live for one or more fields in milliseconds.
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.
KeyScanCursor<K>	hscanNovalues(K key) Incrementally iterate hash fields, without associated values.
StreamScanCursor	hscanNovalues(KeyStreamingChannel<K> channel, K key) Incrementally iterate hash fields, without associated values.
StreamScanCursor	hscanNovalues(KeyStreamingChannel<K> channel, K key, ScanArgs scanArgs) Incrementally iterate hash fields, without associated values.
StreamScanCursor	hscanNovalues(KeyStreamingChannel<K> channel, K key, ScanCursor scanCursor) Incrementally iterate hash fields, without associated values.
StreamScanCursor	hscanNovalues(KeyStreamingChannel<K> channel, K key, ScanCursor scanCursor, ScanArgs scanArgs) Incrementally iterate hash fields, without associated values.
KeyScanCursor<K>	hscanNovalues(K key, ScanArgs scanArgs) Incrementally iterate hash fields, without associated values.
KeyScanCursor<K>	hscanNovalues(K key, ScanCursor scanCursor) Incrementally iterate hash fields, without associated values.
KeyScanCursor<K>	hscanNovalues(K key, ScanCursor scanCursor, ScanArgs scanArgs) Incrementally iterate hash fields, without 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<Long>	httl(K key, K... fields) Get the time to live for one or more fields.
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: true if the hash contains field. false if the hash does not contain field, or key does not exist.

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 hash to apply.

Returns:

String simple-string-reply.

hrandfield

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

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

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

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

MapScanCursor<K,V> hscan(K key)

Incrementally iterate hash fields and associated values.

Parameters:

key - the key.

Returns:

MapScanCursor<K, V> map scan cursor.

hscanNovalues

KeyScanCursor<K> hscanNovalues(K key)

Incrementally iterate hash fields, without associated values.

Parameters:

key - the key.

Returns:

KeyScanCursor<K> key scan cursor.

Since:

6.4

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.

hscanNovalues

KeyScanCursor<K> hscanNovalues(K key,
                               ScanArgs scanArgs)

Incrementally iterate hash fields, without associated values.

Parameters:

key - the key.

scanArgs - scan arguments.

Returns:

KeyScanCursor<K> key scan cursor.

Since:

6.4

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.

hscanNovalues

KeyScanCursor<K> hscanNovalues(K key,
                               ScanCursor scanCursor,
                               ScanArgs scanArgs)

Incrementally iterate hash fields, without associated values.

Parameters:

key - the key.

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

scanArgs - scan arguments.

Returns:

KeyScanCursor<K> key scan cursor.

Since:

6.4

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.

hscanNovalues

KeyScanCursor<K> hscanNovalues(K key,
                               ScanCursor scanCursor)

Incrementally iterate hash fields, without associated values.

Parameters:

key - the key.

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

Returns:

KeyScanCursor<K> key scan cursor.

Since:

6.4

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.

hscanNovalues

StreamScanCursor hscanNovalues(KeyStreamingChannel<K> channel,
                               K key)

Incrementally iterate hash fields, without associated values.

Parameters:

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

key - the key.

Returns:

StreamScanCursor scan cursor.

Since:

6.4

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.

hscanNovalues

StreamScanCursor hscanNovalues(KeyStreamingChannel<K> channel,
                               K key,
                               ScanArgs scanArgs)

Incrementally iterate hash fields, without associated values.

Parameters:

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

key - the key.

scanArgs - scan arguments.

Returns:

StreamScanCursor scan cursor.

Since:

6.4

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.

hscanNovalues

StreamScanCursor hscanNovalues(KeyStreamingChannel<K> channel,
                               K key,
                               ScanCursor scanCursor,
                               ScanArgs scanArgs)

Incrementally iterate hash fields, without associated values.

Parameters:

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

key - the key.

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

scanArgs - scan arguments.

Returns:

StreamScanCursor scan cursor.

Since:

6.4

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.

hscanNovalues

StreamScanCursor hscanNovalues(KeyStreamingChannel<K> channel,
                               K key,
                               ScanCursor scanCursor)

Incrementally iterate hash fields, without associated values.

Parameters:

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

key - the key.

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

Returns:

StreamScanCursor scan cursor.

Since:

6.4

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.

hexpire

List<Long> hexpire(K key,
                   long seconds,
                   K... fields)

Set the time to live (in seconds) for one or more fields, belonging to a certain key.

Parameters:

key - the key of the fields.

seconds - the seconds type: long.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is 0; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hexpire

List<Long> hexpire(K key,
                   long seconds,
                   ExpireArgs expireArgs,
                   K... fields)

Set the time to live (in seconds) for one or more fields, belonging to a certain key.

Parameters:

key - the key of the fields.

seconds - the seconds type: long.

expireArgs - the expiry arguments.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is 0; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hexpire

List<Long> hexpire(K key,
                   Duration seconds,
                   K... fields)

Set the time to live for one or more fields, belonging to a certain key.

Parameters:

key - the key.

seconds - the TTL Duration

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is 0; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hexpire

List<Long> hexpire(K key,
                   Duration seconds,
                   ExpireArgs expireArgs,
                   K... fields)

Set the time to live for one or more fields, belonging to a certain key.

Parameters:

key - the key.

seconds - the TTL Duration

expireArgs - the ExpireArgs.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is 0; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hexpireat

List<Long> hexpireat(K key,
                     long timestamp,
                     K... fields)

Set the time to live for one or more fields, belonging to a certain key as a UNIX timestamp.

Parameters:

key - the key.

timestamp - the timestamp type: posix time.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hexpireat

List<Long> hexpireat(K key,
                     long timestamp,
                     ExpireArgs expireArgs,
                     K... fields)

Set the time to live for one or more fields, belonging to a certain key as a UNIX timestamp.

Parameters:

key - the key.

timestamp - the timestamp type: posix time.

expireArgs - the expiry arguments.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hexpireat

List<Long> hexpireat(K key,
                     Date timestamp,
                     K... fields)

Set the time to live for one or more fields, belonging to a certain key as a UNIX timestamp.

Parameters:

key - the key.

timestamp - the timestamp type: posix time.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hexpireat

List<Long> hexpireat(K key,
                     Date timestamp,
                     ExpireArgs expireArgs,
                     K... fields)

Set the time to live for one or more fields, belonging to a certain key as a UNIX timestamp.

Parameters:

key - the key.

timestamp - the timestamp type: posix time.

expireArgs - the expiry arguments.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hexpireat

List<Long> hexpireat(K key,
                     Instant timestamp,
                     K... fields)

Set the time to live for one or more fields, belonging to a certain key as a UNIX timestamp.

Parameters:

key - the key.

timestamp - the timestamp type: posix time.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hexpireat

List<Long> hexpireat(K key,
                     Instant timestamp,
                     ExpireArgs expireArgs,
                     K... fields)

Set the time to live for one or more fields, belonging to a certain key as a UNIX timestamp.

Parameters:

key - the key.

timestamp - the timestamp type: posix time.

expireArgs - the expiry arguments.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hexpiretime

List<Long> hexpiretime(K key,
                       K... fields)

Get the time to live for one or more fields in as UNIX timestamp in seconds.

Parameters:

key - the key.

fields - one or more fields to get the TTL for.

Returns:

a list of Long values for each of the fields provided: expiration time as a UNIX timestamp in seconds; -1 indicating the field has no expiry time set; -2 indicating there is no such field

Since:

6.4

hpersist

List<Long> hpersist(K key,
                    K... fields)

Remove the expiration from one or more fields.

Parameters:

key - the key.

fields - one or more fields to remove the TTL for.

Returns:

a list of Long values for each of the fields provided: 1 indicating expiration time is removed; -1 field has no expiration time to be removed; -2 indicating there is no such field

Since:

6.4

hpexpire

List<Long> hpexpire(K key,
                    long milliseconds,
                    K... fields)

Set the time to live for one or more fields in milliseconds.

Parameters:

key - the key.

milliseconds - the milliseconds type: long.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is 0; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hpexpire

List<Long> hpexpire(K key,
                    long milliseconds,
                    ExpireArgs expireArgs,
                    K... fields)

Set the time to live for one or more fields in milliseconds.

Parameters:

key - the key.

milliseconds - the milliseconds type: long.

expireArgs - the expiry arguments.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is 0; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hpexpire

List<Long> hpexpire(K key,
                    Duration milliseconds,
                    K... fields)

Set the time to live for one or more fields in milliseconds.

Parameters:

key - the key.

milliseconds - the milliseconds.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is 0; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hpexpire

List<Long> hpexpire(K key,
                    Duration milliseconds,
                    ExpireArgs expireArgs,
                    K... fields)

Set the time to live for one or more fields in milliseconds.

Parameters:

key - the key.

milliseconds - the milliseconds.

expireArgs - the expiry arguments.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is 0; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hpexpireat

List<Long> hpexpireat(K key,
                      long timestamp,
                      K... fields)

Set the time to live for one or more fields as a UNIX timestamp specified in milliseconds.

Parameters:

key - the key.

timestamp - the milliseconds-timestamp type: posix time.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hpexpireat

List<Long> hpexpireat(K key,
                      long timestamp,
                      ExpireArgs expireArgs,
                      K... fields)

Set the time to live for one or more fields as a UNIX timestamp specified in milliseconds.

Parameters:

key - the key.

timestamp - the milliseconds-timestamp type: posix time.

expireArgs - the expiry arguments.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hpexpireat

List<Long> hpexpireat(K key,
                      Date timestamp,
                      K... fields)

Set the time to live for one or more fields as a UNIX timestamp specified in milliseconds.

Parameters:

key - the key.

timestamp - the milliseconds-timestamp type: posix time.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hpexpireat

List<Long> hpexpireat(K key,
                      Date timestamp,
                      ExpireArgs expireArgs,
                      K... fields)

Set the time to live for one or more fields as a UNIX timestamp specified in milliseconds.

Parameters:

key - the key.

timestamp - the milliseconds-timestamp type: posix time.

expireArgs - the expiry arguments.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hpexpireat

List<Long> hpexpireat(K key,
                      Instant timestamp,
                      K... fields)

Set the time to live for one or more fields as a UNIX timestamp specified in milliseconds.

Parameters:

key - the key.

timestamp - the milliseconds-timestamp type: posix time.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hpexpireat

List<Long> hpexpireat(K key,
                      Instant timestamp,
                      ExpireArgs expireArgs,
                      K... fields)

Set the time to live for one or more fields as a UNIX timestamp specified in milliseconds.

Parameters:

key - the key.

timestamp - the milliseconds-timestamp type: posix time.

expireArgs - the expiry arguments.

fields - one or more fields to set the TTL for.

Returns:

a list of Long values for each of the fields provided: 2 indicating the specific field is deleted already due to expiration, or provided expiry interval is in the past; 1 indicating expiration time is set/updated; 0 indicating the expiration time is not set (a provided NX | XX | GT | LT condition is not met); -2 indicating there is no such field

Since:

6.4

hpexpiretime

List<Long> hpexpiretime(K key,
                        K... fields)

Get the time to live for one or more fields as UNIX timestamp in milliseconds.

Parameters:

key - the key.

fields - one or more fields to get the TTL for.

Returns:

a list of Long values for each of the fields provided: expiration time as a UNIX timestamp in milliseconds; -1 indicating the field has no expiry time set; -2 indicating there is no such field

Since:

6.4

httl

List<Long> httl(K key,
                K... fields)

Get the time to live for one or more fields.

Parameters:

key - the key.

fields - one or more fields to get the TTL for.

Returns:

a list of Long values for each of the fields provided: the time to live in seconds; or a negative value in order to signal an error. The command returns -1 if the key exists but has no associated expiration time. The command returns -2 if the key does not exist.

Since:

6.4

hpttl

List<Long> hpttl(K key,
                 K... fields)

Get the time to live for one or more fields in milliseconds.

Parameters:

key - the key.

fields - one or more fields to get the TTL for.

Returns:

a list of Long values for each of the fields provided: the time to live in milliseconds; or a negative value in order to signal an error. The command returns -1 if the key exists but has no associated expiration time. The command returns -2 if the key does not exist.

Since:

6.4