redis.clients.jedis.commands

Interface HashBinaryCommands

All Known Subinterfaces:

JedisBinaryCommands

All Known Implementing Classes:

Jedis, JedisCluster, JedisPooled, JedisSentineled, MultiDbClient, UnifiedJedis

public interface HashBinaryCommands

Method Summary

Modifier and Type	Method and Description
long	hdel(byte[] key, byte[]... field)
boolean	hexists(byte[] key, byte[] field)
java.util.List<java.lang.Long>	hexpire(byte[] key, long seconds, byte[]... fields) Set expiry for hash field using relative time to expire (seconds).
java.util.List<java.lang.Long>	hexpire(byte[] key, long seconds, ExpiryOption condition, byte[]... fields) Set expiry for hash field using relative time to expire (seconds).
java.util.List<java.lang.Long>	hexpireAt(byte[] key, long unixTimeSeconds, byte[]... fields) Set expiry for hash field using an absolute Unix timestamp (seconds).
java.util.List<java.lang.Long>	hexpireAt(byte[] key, long unixTimeSeconds, ExpiryOption condition, byte[]... fields) Set expiry for hash field using an absolute Unix timestamp (seconds).
java.util.List<java.lang.Long>	hexpireTime(byte[] key, byte[]... fields) Returns the expiration time of a hash field as a Unix timestamp, in seconds.
byte[]	hget(byte[] key, byte[] field)
java.util.Map<byte[],byte[]>	hgetAll(byte[] key)
java.util.List<byte[]>	hgetdel(byte[] key, byte[]... 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<byte[]>	hgetex(byte[] key, HGetExParams params, byte[]... fields) Retrieves the values associated with the specified fields in a hash stored at the given key and optionally sets their expiration.
long	hincrBy(byte[] key, byte[] field, long value)
double	hincrByFloat(byte[] key, byte[] field, double value)
java.util.Set<byte[]>	hkeys(byte[] key)
long	hlen(byte[] key)
java.util.List<byte[]>	hmget(byte[] key, byte[]... fields)
java.lang.String	hmset(byte[] key, java.util.Map<byte[],byte[]> hash)
java.util.List<java.lang.Long>	hpersist(byte[] key, byte[]... fields) Removes the expiration time for each specified field.
java.util.List<java.lang.Long>	hpexpire(byte[] key, long milliseconds, byte[]... fields) Set expiry for hash field using relative time to expire (milliseconds).
java.util.List<java.lang.Long>	hpexpire(byte[] key, long milliseconds, ExpiryOption condition, byte[]... fields) Set expiry for hash field using relative time to expire (milliseconds).
java.util.List<java.lang.Long>	hpexpireAt(byte[] key, long unixTimeMillis, byte[]... fields) Set expiry for hash field using an absolute Unix timestamp (milliseconds).
java.util.List<java.lang.Long>	hpexpireAt(byte[] key, long unixTimeMillis, ExpiryOption condition, byte[]... fields) Set expiry for hash field using an absolute Unix timestamp (milliseconds).
java.util.List<java.lang.Long>	hpexpireTime(byte[] key, byte[]... fields) Returns the expiration time of a hash field as a Unix timestamp, in milliseconds.
java.util.List<java.lang.Long>	hpttl(byte[] key, byte[]... fields) Returns the TTL in milliseconds of a hash field.
byte[]	hrandfield(byte[] key)
java.util.List<byte[]>	hrandfield(byte[] key, long count)
java.util.List<java.util.Map.Entry<byte[],byte[]>>	hrandfieldWithValues(byte[] key, long count)
default ScanResult<java.util.Map.Entry<byte[],byte[]>>	hscan(byte[] key, byte[] cursor)
ScanResult<java.util.Map.Entry<byte[],byte[]>>	hscan(byte[] key, byte[] cursor, ScanParams params)
default ScanResult<byte[]>	hscanNoValues(byte[] key, byte[] cursor)
ScanResult<byte[]>	hscanNoValues(byte[] key, byte[] cursor, ScanParams params)
long	hset(byte[] key, byte[] field, byte[] value)
long	hset(byte[] key, java.util.Map<byte[],byte[]> hash)
long	hsetex(byte[] key, HSetExParams params, byte[] field, byte[] value) Sets the specified fields in the hash stored at key to the specified values with additional parameters, and optionally set their expiration.
long	hsetex(byte[] key, HSetExParams params, java.util.Map<byte[],byte[]> hash) Sets the specified fields in the hash stored at key to the specified values with additional parameters, and optionally set their expiration.
long	hsetnx(byte[] key, byte[] field, byte[] value)
long	hstrlen(byte[] key, byte[] field)
java.util.List<java.lang.Long>	httl(byte[] key, byte[]... fields) Returns the TTL in seconds of a hash field.
java.util.List<byte[]>	hvals(byte[] key)

Method Detail

hset

long hset(byte[] key,
          byte[] field,
          byte[] value)

hset

long hset(byte[] key,
          java.util.Map<byte[],byte[]> hash)

hsetex

long hsetex(byte[] key,
            HSetExParams params,
            byte[] field,
            byte[] 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(byte[] key,
            HSetExParams params,
            java.util.Map<byte[],byte[]> 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

byte[] hget(byte[] key,
            byte[] field)

hgetex

java.util.List<byte[]> hgetex(byte[] key,
                              HGetExParams params,
                              byte[]... 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<byte[]> hgetdel(byte[] key,
                               byte[]... 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(byte[] key,
            byte[] field,
            byte[] value)

hmset

java.lang.String hmset(byte[] key,
                       java.util.Map<byte[],byte[]> hash)

hmget

java.util.List<byte[]> hmget(byte[] key,
                             byte[]... fields)

hincrBy

long hincrBy(byte[] key,
             byte[] field,
             long value)

hincrByFloat

double hincrByFloat(byte[] key,
                    byte[] field,
                    double value)

hexists

boolean hexists(byte[] key,
                byte[] field)

hdel

long hdel(byte[] key,
          byte[]... field)

hlen

long hlen(byte[] key)

hkeys

java.util.Set<byte[]> hkeys(byte[] key)

hvals

java.util.List<byte[]> hvals(byte[] key)

hgetAll

java.util.Map<byte[],byte[]> hgetAll(byte[] key)

hrandfield

byte[] hrandfield(byte[] key)

hrandfield

java.util.List<byte[]> hrandfield(byte[] key,
                                  long count)

hrandfieldWithValues

java.util.List<java.util.Map.Entry<byte[],byte[]>> hrandfieldWithValues(byte[] key,
                                                                        long count)

hscan

default ScanResult<java.util.Map.Entry<byte[],byte[]>> hscan(byte[] key,
                                                             byte[] cursor)

hscan

ScanResult<java.util.Map.Entry<byte[],byte[]>> hscan(byte[] key,
                                                     byte[] cursor,
                                                     ScanParams params)

hscanNoValues

default ScanResult<byte[]> hscanNoValues(byte[] key,
                                         byte[] cursor)

hscanNoValues

ScanResult<byte[]> hscanNoValues(byte[] key,
                                 byte[] cursor,
                                 ScanParams params)

hstrlen

long hstrlen(byte[] key,
             byte[] field)

hexpire

java.util.List<java.lang.Long> hexpire(byte[] key,
                                       long seconds,
                                       byte[]... 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(byte[] key,
                                       long seconds,
                                       ExpiryOption condition,
                                       byte[]... 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(byte[] key,
                                        long milliseconds,
                                        byte[]... 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(byte[] key,
                                        long milliseconds,
                                        ExpiryOption condition,
                                        byte[]... 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(byte[] key,
                                         long unixTimeSeconds,
                                         byte[]... 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(byte[] key,
                                         long unixTimeSeconds,
                                         ExpiryOption condition,
                                         byte[]... 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(byte[] key,
                                          long unixTimeMillis,
                                          byte[]... 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(byte[] key,
                                          long unixTimeMillis,
                                          ExpiryOption condition,
                                          byte[]... 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(byte[] key,
                                           byte[]... 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(byte[] key,
                                            byte[]... 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(byte[] key,
                                    byte[]... 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(byte[] key,
                                     byte[]... 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(byte[] key,
                                        byte[]... 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.