redis.clients.jedis.commands

Interface HashCommands

All Known Subinterfaces:

JedisCommands

All Known Implementing Classes:

Jedis, JedisCluster, MultiDbClient, RedisClient, RedisClusterClient, RedisSentinelClient, UnifiedJedis

public interface HashCommands

Method Summary

Modifier and Type	Method and Description
long	hdel(java.lang.String key, java.lang.String... field)
boolean	hexists(java.lang.String key, java.lang.String field)
java.util.List<java.lang.Long>	hexpire(java.lang.String key, long seconds, ExpiryOption condition, java.lang.String... fields) Set expiry for hash field using relative time to expire (seconds).
java.util.List<java.lang.Long>	hexpire(java.lang.String key, long seconds, java.lang.String... fields) Set expiry for hash field using relative time to expire (seconds).
java.util.List<java.lang.Long>	hexpireAt(java.lang.String key, long unixTimeSeconds, ExpiryOption condition, java.lang.String... fields) Set expiry for hash field using an absolute Unix timestamp (seconds).
java.util.List<java.lang.Long>	hexpireAt(java.lang.String key, long unixTimeSeconds, java.lang.String... fields) Set expiry for hash field using an absolute Unix timestamp (seconds).
java.util.List<java.lang.Long>	hexpireTime(java.lang.String key, java.lang.String... fields) Returns the expiration time of a hash field as a Unix timestamp, in seconds.
java.lang.String	hget(java.lang.String key, java.lang.String field)
java.util.Map<java.lang.String,java.lang.String>	hgetAll(java.lang.String key)
java.util.List<java.lang.String>	hgetdel(java.lang.String key, java.lang.String... fields) Retrieves the values associated with the specified fields in the hash stored at the given key and then deletes those fields from the hash.
java.util.List<java.lang.String>	hgetex(java.lang.String key, HGetExParams params, java.lang.String... fields) Retrieves the values associated with the specified fields in a hash stored at the given key and optionally sets their expiration.
java.lang.String	himportSet(java.lang.String key, HashImport fieldset, java.lang.String... values) Creates a single hash from values supplied positionally against a reusable HashImport field-set template, using the server-side session field-set mechanism (HIMPORT SET, Redis 8.10).
long	hincrBy(java.lang.String key, java.lang.String field, long value)
double	hincrByFloat(java.lang.String key, java.lang.String field, double value)
java.util.Set<java.lang.String>	hkeys(java.lang.String key)
long	hlen(java.lang.String key)
java.util.List<java.lang.String>	hmget(java.lang.String key, java.lang.String... fields)
java.lang.String	hmset(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> hash) Deprecated. Use hset(String, Map). Deprecated in Jedis 7.3.0. Mirrors Redis deprecation since 4.0.0.
java.util.List<java.lang.Long>	hpersist(java.lang.String key, java.lang.String... fields) Removes the expiration time for each specified field.
java.util.List<java.lang.Long>	hpexpire(java.lang.String key, long milliseconds, ExpiryOption condition, java.lang.String... fields) Set expiry for hash field using relative time to expire (milliseconds).
java.util.List<java.lang.Long>	hpexpire(java.lang.String key, long milliseconds, java.lang.String... fields) Set expiry for hash field using relative time to expire (milliseconds).
java.util.List<java.lang.Long>	hpexpireAt(java.lang.String key, long unixTimeMillis, ExpiryOption condition, java.lang.String... fields) Set expiry for hash field using an absolute Unix timestamp (milliseconds).
java.util.List<java.lang.Long>	hpexpireAt(java.lang.String key, long unixTimeMillis, java.lang.String... fields) Set expiry for hash field using an absolute Unix timestamp (milliseconds).
java.util.List<java.lang.Long>	hpexpireTime(java.lang.String key, java.lang.String... fields) Returns the expiration time of a hash field as a Unix timestamp, in milliseconds.
java.util.List<java.lang.Long>	hpttl(java.lang.String key, java.lang.String... fields) Returns the TTL in milliseconds of a hash field.
java.lang.String	hrandfield(java.lang.String key)
java.util.List<java.lang.String>	hrandfield(java.lang.String key, long count)
java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>>	hrandfieldWithValues(java.lang.String key, long count)
default ScanResult<java.util.Map.Entry<java.lang.String,java.lang.String>>	hscan(java.lang.String key, java.lang.String cursor)
ScanResult<java.util.Map.Entry<java.lang.String,java.lang.String>>	hscan(java.lang.String key, java.lang.String cursor, ScanParams params)
default ScanResult<java.lang.String>	hscanNoValues(java.lang.String key, java.lang.String cursor)
ScanResult<java.lang.String>	hscanNoValues(java.lang.String key, java.lang.String cursor, ScanParams params)
long	hset(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> hash)
long	hset(java.lang.String key, java.lang.String field, java.lang.String value)
long	hsetex(java.lang.String key, HSetExParams params, java.util.Map<java.lang.String,java.lang.String> hash) Sets the specified fields in the hash stored at key to the specified values with additional parameters, and optionally set their expiration.
long	hsetex(java.lang.String key, HSetExParams params, java.lang.String field, java.lang.String value) Sets the specified fields in the hash stored at key to the specified values with additional parameters, and optionally set their expiration.
long	hsetnx(java.lang.String key, java.lang.String field, java.lang.String value)
long	hstrlen(java.lang.String key, java.lang.String field)
java.util.List<java.lang.Long>	httl(java.lang.String key, java.lang.String... fields) Returns the TTL in seconds of a hash field.
java.util.List<java.lang.String>	hvals(java.lang.String key)

Method Detail

hset

long hset(java.lang.String key,
          java.lang.String field,
          java.lang.String value)

hset

long hset(java.lang.String key,
          java.util.Map<java.lang.String,java.lang.String> hash)

hsetex

long hsetex(java.lang.String key,
            HSetExParams params,
            java.lang.String field,
            java.lang.String value)

Sets the specified fields in the hash stored at key to the specified values with additional parameters, and optionally set their expiration. Use `HSetExParams` object to specify expiration parameters. This command can overwrite any existing fields in the hash. If key does not exist, a new key holding a hash is created.

Parameters:

key - the key of the hash

params - the parameters for the HSETEX command

field - the field in the hash

value - the value to set

Returns:

0 if no fields were set, 1 if all the fields were set

See Also:

HSetExParams

hsetex

long hsetex(java.lang.String key,
            HSetExParams params,
            java.util.Map<java.lang.String,java.lang.String> hash)

Sets the specified fields in the hash stored at key to the specified values with additional parameters, and optionally set their expiration. Use `HSetExParams` object to specify expiration parameters. This command can overwrite any existing fields in the hash. If key does not exist, a new key holding a hash is created.

Parameters:

key - the key of the hash

params - the parameters for the HSETEX command

hash - the map containing field-value pairs to set in the hash

Returns:

0 if no fields were set, 1 if all the fields were set

See Also:

HSetExParams

hget

java.lang.String hget(java.lang.String key,
                      java.lang.String field)

hgetex

java.util.List<java.lang.String> hgetex(java.lang.String key,
                                        HGetExParams params,
                                        java.lang.String... fields)

Retrieves the values associated with the specified fields in a hash stored at the given key and optionally sets their expiration. Use `HGetExParams` object to specify expiration parameters.

Parameters:

key - the key of the hash

params - additional parameters for the HGETEX command

fields - the fields whose values are to be retrieved

Returns:

a list of the value associated with each field or nil if the field doesn’t exist.

See Also:

HGetExParams

hgetdel

java.util.List<java.lang.String> hgetdel(java.lang.String key,
                                         java.lang.String... fields)

Retrieves the values associated with the specified fields in the hash stored at the given key and then deletes those fields from the hash.

Parameters:

key - the key of the hash

fields - the fields whose values are to be retrieved and then deleted

Returns:

a list of values associated with the specified fields before they were deleted

hsetnx

long hsetnx(java.lang.String key,
            java.lang.String field,
            java.lang.String value)

hmset

@Deprecated
java.lang.String hmset(java.lang.String key,
                                   java.util.Map<java.lang.String,java.lang.String> hash)

Deprecated. Use hset(String, Map). Deprecated in Jedis 7.3.0. Mirrors Redis deprecation since 4.0.0.

hmget

java.util.List<java.lang.String> hmget(java.lang.String key,
                                       java.lang.String... fields)

hincrBy

long hincrBy(java.lang.String key,
             java.lang.String field,
             long value)

hincrByFloat

double hincrByFloat(java.lang.String key,
                    java.lang.String field,
                    double value)

hexists

boolean hexists(java.lang.String key,
                java.lang.String field)

hdel

long hdel(java.lang.String key,
          java.lang.String... field)

hlen

long hlen(java.lang.String key)

hkeys

java.util.Set<java.lang.String> hkeys(java.lang.String key)

hvals

java.util.List<java.lang.String> hvals(java.lang.String key)

hgetAll

java.util.Map<java.lang.String,java.lang.String> hgetAll(java.lang.String key)

hrandfield

java.lang.String hrandfield(java.lang.String key)

hrandfield

java.util.List<java.lang.String> hrandfield(java.lang.String key,
                                            long count)

hrandfieldWithValues

java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> hrandfieldWithValues(java.lang.String key,
                                                                                            long count)

hscan

default ScanResult<java.util.Map.Entry<java.lang.String,java.lang.String>> hscan(java.lang.String key,
                                                                                 java.lang.String cursor)

hscan

ScanResult<java.util.Map.Entry<java.lang.String,java.lang.String>> hscan(java.lang.String key,
                                                                         java.lang.String cursor,
                                                                         ScanParams params)

hscanNoValues

default ScanResult<java.lang.String> hscanNoValues(java.lang.String key,
                                                   java.lang.String cursor)

hscanNoValues

ScanResult<java.lang.String> hscanNoValues(java.lang.String key,
                                           java.lang.String cursor,
                                           ScanParams params)

hstrlen

long hstrlen(java.lang.String key,
             java.lang.String field)

hexpire

java.util.List<java.lang.Long> hexpire(java.lang.String key,
                                       long seconds,
                                       java.lang.String... fields)

Set expiry for hash field using relative time to expire (seconds).

Parameters:

key - hash

seconds - time to expire

fields -

Returns:

integer-reply: 1 if the timeout was set, 0 otherwise

hexpire

java.util.List<java.lang.Long> hexpire(java.lang.String key,
                                       long seconds,
                                       ExpiryOption condition,
                                       java.lang.String... fields)

Set expiry for hash field using relative time to expire (seconds).

Parameters:

key - hash

seconds - time to expire

condition - can be NX, XX, GT or LT

fields -

Returns:

integer-reply: 1 if the timeout was set, 0 otherwise

hpexpire

java.util.List<java.lang.Long> hpexpire(java.lang.String key,
                                        long milliseconds,
                                        java.lang.String... fields)

Set expiry for hash field using relative time to expire (milliseconds).

Parameters:

key - hash

milliseconds - time to expire

fields -

Returns:

integer-reply: 1 if the timeout was set, 0 otherwise

hpexpire

java.util.List<java.lang.Long> hpexpire(java.lang.String key,
                                        long milliseconds,
                                        ExpiryOption condition,
                                        java.lang.String... fields)

Set expiry for hash field using relative time to expire (milliseconds).

Parameters:

key - hash

milliseconds - time to expire

condition - can be NX, XX, GT or LT

fields -

Returns:

integer-reply: 1 if the timeout was set, 0 otherwise

hexpireAt

java.util.List<java.lang.Long> hexpireAt(java.lang.String key,
                                         long unixTimeSeconds,
                                         java.lang.String... fields)

Set expiry for hash field using an absolute Unix timestamp (seconds).

Parameters:

key - hash

unixTimeSeconds - time to expire

fields -

Returns:

integer-reply: 1 if the timeout was set, 0 otherwise

hexpireAt

java.util.List<java.lang.Long> hexpireAt(java.lang.String key,
                                         long unixTimeSeconds,
                                         ExpiryOption condition,
                                         java.lang.String... fields)

Set expiry for hash field using an absolute Unix timestamp (seconds).

Parameters:

key - hash

unixTimeSeconds - time to expire

condition - can be NX, XX, GT or LT

fields -

Returns:

integer-reply: 1 if the timeout was set, 0 otherwise

hpexpireAt

java.util.List<java.lang.Long> hpexpireAt(java.lang.String key,
                                          long unixTimeMillis,
                                          java.lang.String... fields)

Set expiry for hash field using an absolute Unix timestamp (milliseconds).

Parameters:

key - hash

unixTimeMillis - time to expire

fields -

Returns:

integer-reply: 1 if the timeout was set, 0 otherwise

hpexpireAt

java.util.List<java.lang.Long> hpexpireAt(java.lang.String key,
                                          long unixTimeMillis,
                                          ExpiryOption condition,
                                          java.lang.String... fields)

Set expiry for hash field using an absolute Unix timestamp (milliseconds).

Parameters:

key - hash

unixTimeMillis - time to expire

condition - can be NX, XX, GT or LT

fields -

Returns:

integer-reply: 1 if the timeout was set, 0 otherwise

hexpireTime

java.util.List<java.lang.Long> hexpireTime(java.lang.String key,
                                           java.lang.String... fields)

Returns the expiration time of a hash field as a Unix timestamp, in seconds.

Parameters:

key - hash

fields -

Returns:

Expiration Unix timestamp in seconds; or -1 if the field exists but has no associated expire or -2 if the field does not exist.

hpexpireTime

java.util.List<java.lang.Long> hpexpireTime(java.lang.String key,
                                            java.lang.String... fields)

Returns the expiration time of a hash field as a Unix timestamp, in milliseconds.

Parameters:

key - hash

fields -

Returns:

Expiration Unix timestamp in milliseconds; or -1 if the field exists but has no associated expire or -2 if the field does not exist.

httl

java.util.List<java.lang.Long> httl(java.lang.String key,
                                    java.lang.String... fields)

Returns the TTL in seconds of a hash field.

Parameters:

key - hash

fields -

Returns:

TTL in seconds; or -1 if the field exists but has no associated expire or -2 if the field does not exist.

hpttl

java.util.List<java.lang.Long> hpttl(java.lang.String key,
                                     java.lang.String... fields)

Returns the TTL in milliseconds of a hash field.

Parameters:

key - hash

fields -

Returns:

TTL in milliseconds; or -1 if the field exists but has no associated expire or -2 if the field does not exist.

hpersist

java.util.List<java.lang.Long> hpersist(java.lang.String key,
                                        java.lang.String... fields)

Removes the expiration time for each specified field.

Parameters:

key - hash

fields -

Returns:

integer-reply: 1 if the expiration time was removed, or -1 if the field exists but has no associated expire or -2 if the field does not exist.

himportSet

@Experimental
java.lang.String himportSet(java.lang.String key,
                                          HashImport fieldset,
                                          java.lang.String... values)

Creates a single hash from values supplied positionally against a reusable HashImport field-set template, using the server-side session field-set mechanism (HIMPORT SET, Redis 8.10). The HIMPORT PREPARE for fieldset is injected automatically the first time it is seen on each underlying connection.

The key produced is an ordinary hash. A server error (for example, a key already holding a non-hash value) is thrown as usual. Cluster-aware: the key routes to its slot, re-preparing per node as needed. Not supported inside a transaction (the connection-local PREPARE cannot be staged in MULTI/EXEC).

Parameters:

key - the key of the hash to create; any existing hash at this key is replaced

fieldset - the field-set template describing the ordered field names shared by imported hashes

values - the field values for this hash, matched positionally against the template's fields (same count)

Returns:

OK

Throws:

java.lang.IllegalArgumentException - if the number of values differs from the template's field count

java.lang.IllegalStateException - if the template has been closed

Since:

8.0

See Also:

HashImport