org.springframework.data.redis.connection

Interface RedisHashCommands

All Known Subinterfaces:

DefaultedRedisClusterConnection, DefaultedRedisConnection, RedisClusterConnection, RedisCommands, RedisConnection, RedisConnectionUtils.RedisConnectionProxy, StringRedisConnection

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection

public interface RedisHashCommands

Hash-specific commands supported by Redis.

Author:

Costin Leau, Christoph Strobl, Mark Paluch

Method Summary

Modifier and Type	Method and Description
Long	hDel(byte[] key, byte[]... fields) Delete given hash fields.
Boolean	hExists(byte[] key, byte[] field) Determine if given hash field exists.
byte[]	hGet(byte[] key, byte[] field) Get value for given field from hash at key.
Map<byte[],byte[]>	hGetAll(byte[] key) Get entire hash stored at key.
Double	hIncrBy(byte[] key, byte[] field, double delta) Increment value of a hash field by the given delta.
Long	hIncrBy(byte[] key, byte[] field, long delta) Increment value of a hash field by the given delta.
Set<byte[]>	hKeys(byte[] key) Get key set (fields) of hash at key.
Long	hLen(byte[] key) Get size of hash at key.
List<byte[]>	hMGet(byte[] key, byte[]... fields) Get values for given fields from hash at key.
void	hMSet(byte[] key, Map<byte[],byte[]> hashes) Set multiple hash fields to multiple values using data provided in hashes
Cursor<Map.Entry<byte[],byte[]>>	hScan(byte[] key, ScanOptions options) Use a Cursor to iterate over entries in hash at key.
Boolean	hSet(byte[] key, byte[] field, byte[] value) Set the value of a hash field.
Boolean	hSetNX(byte[] key, byte[] field, byte[] value) Set the value of a hash field only if field does not exist.
Long	hStrLen(byte[] key, byte[] field) Returns the length of the value associated with field in the hash stored at key.
List<byte[]>	hVals(byte[] key) Get entry set (values) of hash at field.

Method Detail

hSet

@Nullable
Boolean hSet(byte[] key,
                       byte[] field,
                       byte[] value)

Set the value of a hash field.

Parameters:

key - must not be null.

field - must not be null.

value - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HSET

hSetNX

@Nullable
Boolean hSetNX(byte[] key,
                         byte[] field,
                         byte[] value)

Set the value of a hash field only if field does not exist.

Parameters:

key - must not be null.

field - must not be null.

value - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HSETNX

hGet

@Nullable
byte[] hGet(byte[] key,
                      byte[] field)

Get value for given field from hash at key.

Parameters:

key - must not be null.

field - must not be null.

Returns:

null when key or field do not exists or when used in pipeline / transaction.

See Also:

Redis Documentation: HGET

hMGet

@Nullable
List<byte[]> hMGet(byte[] key,
                             byte[]... fields)

Get values for given fields from hash at key.

Parameters:

key - must not be null.

fields - must not be empty.

Returns:

empty List if key or fields do not exists. null when used in pipeline / transaction.

See Also:

Redis Documentation: HMGET

hMSet

void hMSet(byte[] key,
           Map<byte[],byte[]> hashes)

Set multiple hash fields to multiple values using data provided in hashes

Parameters:

key - must not be null.

hashes - must not be null.

See Also:

Redis Documentation: HMSET

hIncrBy

@Nullable
Long hIncrBy(byte[] key,
                       byte[] field,
                       long delta)

Increment value of a hash field by the given delta.

Parameters:

key - must not be null.

field - must not be null.

delta -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HINCRBY

hIncrBy

@Nullable
Double hIncrBy(byte[] key,
                         byte[] field,
                         double delta)

Increment value of a hash field by the given delta.

Parameters:

key - must not be null.

field - must not be null.

delta -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HINCRBYFLOAT

hExists

@Nullable
Boolean hExists(byte[] key,
                          byte[] field)

Determine if given hash field exists.

Parameters:

key - must not be null.

field - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HEXISTS

hDel

@Nullable
Long hDel(byte[] key,
                    byte[]... fields)

Delete given hash fields.

Parameters:

key - must not be null.

fields - must not be empty.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HDEL

hLen

@Nullable
Long hLen(byte[] key)

Get size of hash at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HLEN

hKeys

@Nullable
Set<byte[]> hKeys(byte[] key)

Get key set (fields) of hash at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HKEYS?

hVals

@Nullable
List<byte[]> hVals(byte[] key)

Get entry set (values) of hash at field.

Parameters:

key - must not be null.

Returns:

empty List if key does not exist. null when used in pipeline / transaction.

See Also:

Redis Documentation: HVALS

hGetAll

@Nullable
Map<byte[],byte[]> hGetAll(byte[] key)

Get entire hash stored at key.

Parameters:

key - must not be null.

Returns:

empty Map if key does not exist or null when used in pipeline / transaction.

See Also:

Redis Documentation: HGETALL

hScan

Cursor<Map.Entry<byte[],byte[]>> hScan(byte[] key,
                                       ScanOptions options)

Use a Cursor to iterate over entries in hash at key.

Parameters:

key - must not be null.

options - must not be null.

Returns:

Since:

1.4

See Also:

Redis Documentation: HSCAN

hStrLen

@Nullable
Long hStrLen(byte[] key,
                       byte[] field)

Returns the length of the value associated with field in the hash stored at key. If the key or the field do not exist, 0 is returned.

Parameters:

key - must not be null.

field - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.1