org.openingo.spring.boot.extension.data.redis.commands

Interface IHashCommands<K,V>

All Known Subinterfaces:

IRedisCommands<K,V>

All Known Implementing Classes:

DistributedLockStore, IdempotentStore, RedisIdEngine, RedisStringKeyTemplateX, RedisTemplateX

public interface IHashCommands<K,V>

IHashCommands

Author:

Qicz

Method Summary

Modifier and Type	Method and Description
Long	hDel(K key, Object... hashKeys) Delete given hash hashKeys.
Boolean	hExists(K key, Object hashKey) Determine if given hash hashKey exists.
<T> T	hGet(K key, Object hashKey) Get value for given hashKey from hash at key.
<HK,HV> Map<HK,HV>	hGetAll(K key) Get entire hash stored at key.
<HK> Set<HK>	hKeys(K key) Get key set (fields) of hash at key.
Long	hLen(K key) Get size of hash at key.
<T> List<T>	hMget(K key, Collection<Object> hashKeys) Get values for given hashKeys from hash at key.
void	hmset(K key, Map<Object,Object> m) Set multiple hash fields to multiple values using data provided in m.
void	hSet(K key, Object hashKey, Object value) Set the value of a hash hashKey.
<HV> List<HV>	hVals(K key) Get entry set (values) of hash at key.

Method Detail

hSet

void hSet(K key,
          Object hashKey,
          Object value)

Set the value of a hash hashKey.

Parameters:

key - must not be null.

hashKey - must not be null.

value -

See Also:

Redis Documentation: HSET

hmset

void hmset(K key,
           Map<Object,Object> m)

Set multiple hash fields to multiple values using data provided in m.

Parameters:

key - must not be null.

m - must not be null.

See Also:

Redis Documentation: HMSET

hGet

@Nullable
<T> T hGet(K key,
                     Object hashKey)

Get value for given hashKey from hash at key.

Parameters:

key - must not be null.

hashKey - must not be null.

Returns:

null when key or hashKey does not exist or used in pipeline / transaction.

See Also:

Redis Documentation: HGET

hMget

<T> List<T> hMget(K key,
                  Collection<Object> hashKeys)

Get values for given hashKeys from hash at key.

Parameters:

key - must not be null.

hashKeys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HMGET

hDel

Long hDel(K key,
          Object... hashKeys)

Delete given hash hashKeys.

Parameters:

key - must not be null.

hashKeys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HDEL

hExists

Boolean hExists(K key,
                Object hashKey)

Determine if given hash hashKey exists.

Parameters:

key - must not be null.

hashKey - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HEXISTS

hGetAll

<HK,HV> Map<HK,HV> hGetAll(K key)

Get entire hash stored at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HGETALL

hVals

<HV> List<HV> hVals(K key)

Get entry set (values) of hash at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: HVALS

hKeys

<HK> Set<HK> hKeys(K 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

hLen

@Nullable
Long hLen(K 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