java.lang.Object
- io.toro.martini.redis.RedisBaseMethods
- - io.toro.martini.redis.RedisHashMethods

public class RedisHashMethods
extends io.toro.martini.redis.RedisBaseMethods

Methods for Hashes (Key-Value pairs).

Constructor Summary

Constructors
Constructor Description

RedisHashMethods(io.toro.martini.database.DataSourceManager dataSourceManager)

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Long`	`hdel(String connectionName, Object key, GloopExecutionContext context, Object... fields)`	Delete one or more hash fields.
`static Future<Long>`	`hdelAsync(String connectionName, Object key, GloopExecutionContext context, Object... fields)`	Asynchronously delete one or more hash fields.
`static Boolean`	`hexists(String connectionName, Object key, Object field, GloopExecutionContext context)`	Determine if a hash field exists.
`static Future<Boolean>`	`hexistsAsync(String connectionName, Object key, Object field, GloopExecutionContext context)`	Asynchronously determine if a hash field exists.
`static Object`	`hget(String connectionName, Object key, Object field, GloopExecutionContext context)`	Get the value of a hash field.
`static Long`	`hgetall(String connectionName, KeyValueStreamingChannel<Object,Object> channel, Object key, GloopExecutionContext context)`	Stream over all the fields and values in a hash.
`static GloopModel`	`hgetall(String connectionName, Object key, GloopExecutionContext context)`	Get all the fields and values in a hash.
`static Future<Long>`	`hgetallAsync(String connectionName, KeyValueStreamingChannel<Object,Object> channel, Object key, GloopExecutionContext context)`	Asynchronously stream over all the fields and values in a hash.
`static Future<Map<Object,Object>>`	`hgetallAsync(String connectionName, Object key, GloopExecutionContext context)`	Asynchronously get all the fields and values in a hash.
`static Future<Object>`	`hgetAsync(String connectionName, Object key, Object field, GloopExecutionContext context)`	Asynchronously get the value of a hash field.
`static Long`	`hincrby(String connectionName, Object key, Object field, long amount, GloopExecutionContext context)`	Increment the integer value of a hash field by the given number.
`static Future<Long>`	`hincrbyAsync(String connectionName, Object key, Object field, long amount, GloopExecutionContext context)`	Asynchronously increment the integer value of a hash field by the given number.
`static Double`	`hincrbyfloat(String connectionName, Object key, Object field, double amount, GloopExecutionContext context)`	Increment the float value of a hash field by the given amount.
`static Future<Double>`	`hincrbyfloatAsync(String connectionName, Object key, Object field, double amount, GloopExecutionContext context)`	Asynchronously increment the float value of a hash field by the given amount.
`static Long`	`hkeys(String connectionName, KeyStreamingChannel<Object> channel, Object key, GloopExecutionContext context)`	Stream over all the fields in a hash.
`static List<Object>`	`hkeys(String connectionName, Object key, GloopExecutionContext context)`	Get all the fields in a hash.
`static Future<Long>`	`hkeysAsync(String connectionName, KeyStreamingChannel<Object> channel, Object key, GloopExecutionContext context)`	Asynchronously stream over all the fields in a hash.
`static Future<List<Object>>`	`hkeysAsync(String connectionName, Object key, GloopExecutionContext context)`	Asynchronously get all the fields in a hash.
`static Long`	`hlen(String connectionName, Object key, GloopExecutionContext context)`	Get the number of fields in a hash.
`static Future<Long>`	`hlenAsync(String connectionName, Object key, GloopExecutionContext context)`	Asynchronously get the number of fields in a hash.
`static Long`	`hmget(String connectionName, KeyValueStreamingChannel<Object,Object> channel, Object key, GloopExecutionContext context, Object... fields)`	Stream over the values of all the given hash fields.
`static GloopModel`	`hmget(String connectionName, Object key, GloopExecutionContext context, Object... fields)`	Get the values of all the given hash fields.
`static Future<Long>`	`hmgetAsync(String connectionName, KeyValueStreamingChannel<Object,Object> channel, Object key, GloopExecutionContext context, Object... fields)`	Asynchronously stream over the values of all the given hash fields.
`static Future<List<KeyValue<Object,Object>>>`	`hmgetAsync(String connectionName, Object key, GloopExecutionContext context, Object... fields)`	Asynchronously get the values of all the given hash fields.
`static String`	`hmset(String connectionName, Object key, GloopModel redisMap, GloopExecutionContext context)`	Set multiple hash fields to multiple values.
`static Future<String>`	`hmsetAsync(String connectionName, Object key, GloopModel redisMap, GloopExecutionContext context)`	Asynchronously set multiple hash fields to multiple values.
`static StreamScanCursor`	`hscan(String connectionName, KeyValueStreamingChannel<Object,Object> channel, Object key, ScanCursor scanCursor, GloopExecutionContext context)`	Incrementally iterate hash fields and associated values.
`static StreamScanCursor`	`hscan(String connectionName, KeyValueStreamingChannel<Object,Object> channel, Object key, ScanCursor scanCursor, GloopModel scanArgs, GloopExecutionContext context)`	Incrementally iterate hash fields and associated values.
`static StreamScanCursor`	`hscan(String connectionName, KeyValueStreamingChannel<Object,Object> channel, Object key, GloopExecutionContext context)`	Incrementally iterate hash fields and associated values.
`static StreamScanCursor`	`hscan(String connectionName, KeyValueStreamingChannel<Object,Object> channel, Object key, GloopModel scanArgs, GloopExecutionContext context)`	Incrementally iterate hash fields and associated values.
`static MapScanCursor<Object,Object>`	`hscan(String connectionName, Object key, ScanCursor scanCursor, GloopExecutionContext context)`	Incrementally iterate hash fields and associated values.
`static MapScanCursor<Object,Object>`	`hscan(String connectionName, Object key, ScanCursor scanCursor, GloopModel scanArgs, GloopExecutionContext context)`	Incrementally iterate hash fields and associated values.
`static MapScanCursor<Object,Object>`	`hscan(String connectionName, Object key, GloopExecutionContext context)`	Incrementally iterate hash fields and associated values.
`static MapScanCursor<Object,Object>`	`hscan(String connectionName, Object key, GloopModel scanArgs, GloopExecutionContext context)`	Incrementally iterate hash fields and associated values.
`static Future<StreamScanCursor>`	`hscanAsync(String connectionName, KeyValueStreamingChannel<Object,Object> channel, Object key, ScanCursor scanCursor, GloopExecutionContext context)`	Asynchronously incrementally iterate hash fields and associated values.
`static Future<StreamScanCursor>`	`hscanAsync(String connectionName, KeyValueStreamingChannel<Object,Object> channel, Object key, ScanCursor scanCursor, GloopModel scanArgs, GloopExecutionContext context)`	Asynchronously incrementally iterate hash fields and associated values.
`static Future<StreamScanCursor>`	`hscanAsync(String connectionName, KeyValueStreamingChannel<Object,Object> channel, Object key, GloopExecutionContext context)`	Asynchronously incrementally iterate hash fields and associated values.
`static Future<StreamScanCursor>`	`hscanAsync(String connectionName, KeyValueStreamingChannel<Object,Object> channel, Object key, GloopModel scanArgs, GloopExecutionContext context)`	Asynchronously incrementally iterate hash fields and associated values.
`static Future<MapScanCursor<Object,Object>>`	`hscanAsync(String connectionName, Object key, ScanCursor scanCursor, GloopExecutionContext context)`	Asynchronously incrementally iterate hash fields and associated values.
`static Future<MapScanCursor<Object,Object>>`	`hscanAsync(String connectionName, Object key, ScanCursor scanCursor, GloopModel scanArgs, GloopExecutionContext context)`	Asynchronously incrementally iterate hash fields and associated values.
`static Future<MapScanCursor<Object,Object>>`	`hscanAsync(String connectionName, Object key, GloopExecutionContext context)`	Asynchronously incrementally iterate hash fields and associated values.
`static Future<MapScanCursor<Object,Object>>`	`hscanAsync(String connectionName, Object key, GloopModel scanArgs, GloopExecutionContext context)`	Asynchronously incrementally iterate hash fields and associated values.
`static Boolean`	`hset(String connectionName, Object key, Object field, Object value, GloopExecutionContext context)`	Set the string value of a hash field.
`static Future<Boolean>`	`hsetAsync(String connectionName, Object key, Object field, Object value, GloopExecutionContext context)`	Asynchronously set the string value of a hash field.
`static Boolean`	`hsetnx(String connectionName, Object key, Object field, Object value, GloopExecutionContext context)`	Set the value of a hash field, only if the field does not exist.
`static Future<Boolean>`	`hsetnxAsync(String connectionName, Object key, Object field, Object value, GloopExecutionContext context)`	Asynchronously set the value of a hash field, only if the field does not exist.
`static Long`	`hstrlen(String connectionName, Object key, Object field, GloopExecutionContext context)`	Get the string length of the field value in a hash.
`static Future<Long>`	`hstrlenAsync(String connectionName, Object key, Object field, GloopExecutionContext context)`	Asynchronously get the string length of the field value in a hash.
`static Long`	`hvals(String connectionName, ValueStreamingChannel<Object> channel, Object key, GloopExecutionContext context)`	Stream over all the values in a hash.
`static List<Object>`	`hvals(String connectionName, Object key, GloopExecutionContext context)`	Get all the values in a hash.
`static Future<Long>`	`hvalsAsync(String connectionName, ValueStreamingChannel<Object> channel, Object key, GloopExecutionContext context)`	Asynchronously stream over all the values in a hash.
`static Future<List<Object>>`	`hvalsAsync(String connectionName, Object key, GloopExecutionContext context)`	Asynchronously get all the values in a hash.

Methods inherited from class io.toro.martini.redis.RedisBaseMethods
getDataSourceManager, getRedisConnection, getRedisConnection

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RedisHashMethods

@Autowired
RedisHashMethods(io.toro.martini.database.DataSourceManager dataSourceManager)

Method Detail

hdel

@GloopParameter(name="redisHdelOutput")
public static Long hdel(@GloopParameter(allowNull=false)
                        String connectionName,
                        @GloopParameter(allowNull=false)
                        Object key,
                        GloopExecutionContext context,
                        @GloopParameter(allowNull=false)
                        Object... fields)

Delete one or more hash fields.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; 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.

hdelAsync

@GloopParameter(name="redisFutureHdelOutput")
public static Future<Long> hdelAsync(@GloopParameter(allowNull=false)
                                     String connectionName,
                                     @GloopParameter(allowNull=false)
                                     Object key,
                                     GloopExecutionContext context,
                                     @GloopParameter(allowNull=false)
                                     Object... fields)

Asynchronously delete one or more hash fields.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; 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

@GloopParameter(name="redisHexistsOutput")
public static Boolean hexists(@GloopParameter(allowNull=false)
                              String connectionName,
                              @GloopParameter(allowNull=false)
                              Object key,
                              @GloopParameter(allowNull=false)
                              Object field,
                              GloopExecutionContext context)

Determine if a hash field exists.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; 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.

hexistsAsync

@GloopParameter(name="redisFutureHexistsOutput")
public static Future<Boolean> hexistsAsync(@GloopParameter(allowNull=false)
                                           String connectionName,
                                           @GloopParameter(allowNull=false)
                                           Object key,
                                           @GloopParameter(allowNull=false)
                                           Object field,
                                           GloopExecutionContext context)

Asynchronously determine if a hash field exists.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; 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

@GloopParameter(name="redisHgetOutput")
public static Object hget(@GloopParameter(allowNull=false)
                          String connectionName,
                          @GloopParameter(allowNull=false)
                          Object key,
                          @GloopParameter(allowNull=false)
                          Object field,
                          GloopExecutionContext context)

Get the value of a hash field.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; 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.

hgetAsync

@GloopParameter(name="redisFutureHgetOutput")
public static Future<Object> hgetAsync(@GloopParameter(allowNull=false)
                                       String connectionName,
                                       @GloopParameter(allowNull=false)
                                       Object key,
                                       @GloopParameter(allowNull=false)
                                       Object field,
                                       GloopExecutionContext context)

Asynchronously get the value of a hash field.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; 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

@GloopParameter(name="redisHincrbyOutput")
public static Long hincrby(@GloopParameter(allowNull=false)
                           String connectionName,
                           @GloopParameter(allowNull=false)
                           Object key,
                           @GloopParameter(allowNull=false)
                           Object field,
                           @GloopParameter(allowNull=false)
                           long amount,
                           GloopExecutionContext context)

Increment the integer value of a hash field by the given number.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; 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.

hincrbyAsync

@GloopParameter(name="redisFutureHincrbyOutput")
public static Future<Long> hincrbyAsync(@GloopParameter(allowNull=false)
                                        String connectionName,
                                        @GloopParameter(allowNull=false)
                                        Object key,
                                        @GloopParameter(allowNull=false)
                                        Object field,
                                        @GloopParameter(allowNull=false)
                                        long amount,
                                        GloopExecutionContext context)

Asynchronously increment the integer value of a hash field by the given number.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; 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

@GloopParameter(name="redisHincrbyfloatOutput")
public static Double hincrbyfloat(@GloopParameter(allowNull=false)
                                  String connectionName,
                                  @GloopParameter(allowNull=false)
                                  Object key,
                                  @GloopParameter(allowNull=false)
                                  Object field,
                                  @GloopParameter(allowNull=false)
                                  double amount,
                                  GloopExecutionContext context)

Increment the float value of a hash field by the given amount.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; 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.

hincrbyfloatAsync

@GloopParameter(name="redisFutureHincrbyfloatOutput")
public static Future<Double> hincrbyfloatAsync(@GloopParameter(allowNull=false)
                                               String connectionName,
                                               @GloopParameter(allowNull=false)
                                               Object key,
                                               @GloopParameter(allowNull=false)
                                               Object field,
                                               @GloopParameter(allowNull=false)
                                               double amount,
                                               GloopExecutionContext context)

Asynchronously increment the float value of a hash field by the given amount.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; 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

@GloopObjectParameter("output{\nredisMap[]{\n  name:object\n  value:object\n}\n}")
public static GloopModel hgetall(@GloopParameter(allowNull=false)
                                 String connectionName,
                                 @GloopParameter(allowNull=false)
                                 Object key,
                                 GloopExecutionContext context)

Get all the fields and values in a hash.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; 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

@GloopParameter(name="redisHgetallOutput")
public static Long hgetall(@GloopParameter(allowNull=false)
                           String connectionName,
                           @GloopParameter(allowNull=false)
                           KeyValueStreamingChannel<Object,Object> channel,
                           @GloopParameter(allowNull=false)
                           Object key,
                           GloopExecutionContext context)

Stream over all the fields and values in a hash.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; channel - the channel; key - the key
Returns:: Long count of the keys.

hgetallAsync

@GloopParameter(name="redisFutureHgetallOutput")
public static Future<Long> hgetallAsync(@GloopParameter(allowNull=false)
                                        String connectionName,
                                        @GloopParameter(allowNull=false)
                                        KeyValueStreamingChannel<Object,Object> channel,
                                        @GloopParameter(allowNull=false)
                                        Object key,
                                        GloopExecutionContext context)

Asynchronously stream over all the fields and values in a hash.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; channel - the channel; key - the key
Returns:: long count of the keys.

hgetallAsync

@GloopParameter(name="redisFutureHgetallOutput")
public static Future<Map<Object,Object>> hgetallAsync(@GloopParameter(allowNull=false)
                                                            String connectionName,
                                                            @GloopParameter(allowNull=false)
                                                            Object key,
                                                            GloopExecutionContext context)

Asynchronously get all the fields and values in a hash.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; 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.

hkeys

@GloopParameter(name="redisHkeysOutput")
public static List<Object> hkeys(@GloopParameter(allowNull=false)
                                 String connectionName,
                                 @GloopParameter(allowNull=false)
                                 Object key,
                                 GloopExecutionContext context)

Get all the fields in a hash.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; key - the key
Returns:: List<K> array-reply list of fields in the hash, or an empty list when key does not exist.

hkeys

@GloopParameter(name="redisHkeysOutput")
public static Long hkeys(@GloopParameter(allowNull=false)
                         String connectionName,
                         @GloopParameter(allowNull=false)
                         KeyStreamingChannel<Object> channel,
                         @GloopParameter(allowNull=false)
                         Object key,
                         GloopExecutionContext context)

Stream over all the fields in a hash.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; channel - the channel; key - the key
Returns:: Long count of the keys.

hkeysAsync

@GloopParameter(name="redisFutureHkeysOutput")
public static Future<Long> hkeysAsync(@GloopParameter(allowNull=false)
                                      String connectionName,
                                      @GloopParameter(allowNull=false)
                                      KeyStreamingChannel<Object> channel,
                                      @GloopParameter(allowNull=false)
                                      Object key,
                                      GloopExecutionContext context)

Asynchronously stream over all the fields in a hash.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; channel - the channel; key - the key
Returns:: long count of the keys.

hkeysAsync

@GloopParameter(name="redisFutureHkeysOutput")
public static Future<List<Object>> hkeysAsync(@GloopParameter(allowNull=false)
                                              String connectionName,
                                              @GloopParameter(allowNull=false)
                                              Object key,
                                              GloopExecutionContext context)

Asynchronously get all the fields in a hash.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; key - the key
Returns:: list<K> array-reply list of fields in the hash, or an empty list when key does not exist.

hlen

@GloopParameter(name="redisHlenOutput")
public static Long hlen(@GloopParameter(allowNull=false)
                        String connectionName,
                        @GloopParameter(allowNull=false)
                        Object key,
                        GloopExecutionContext context)

Get the number of fields in a hash.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; key - the key
Returns:: Long integer-reply number of fields in the hash, or 0 when key does not exist.

hlenAsync

@GloopParameter(name="redisFutureHlenOutput")
public static Future<Long> hlenAsync(@GloopParameter(allowNull=false)
                                     String connectionName,
                                     @GloopParameter(allowNull=false)
                                     Object key,
                                     GloopExecutionContext context)

Asynchronously get the number of fields in a hash.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; key - the key
Returns:: long integer-reply number of fields in the hash, or 0 when key does not exist.

hmget

@GloopObjectParameter("output{\n  redisKeyValues[]{\n    key:object\n    value:object\n  }\n}")
public static GloopModel hmget(@GloopParameter(allowNull=false)
                               String connectionName,
                               @GloopParameter(allowNull=false)
                               Object key,
                               GloopExecutionContext context,
                               @GloopParameter(allowNull=false)
                               Object... fields)

Get the values of all the given hash fields.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; 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

@GloopParameter(name="redisHmgetOutput")
public static Long hmget(@GloopParameter(allowNull=false)
                         String connectionName,
                         @GloopParameter(allowNull=false)
                         KeyValueStreamingChannel<Object,Object> channel,
                         @GloopParameter(allowNull=false)
                         Object key,
                         GloopExecutionContext context,
                         @GloopParameter(allowNull=false)
                         Object... fields)

Stream over the values of all the given hash fields.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; channel - the channel; key - the key; fields - the fields
Returns:: Long count of the keys

hmgetAsync

@GloopParameter(name="redisFutureHmgetOutput")
public static Future<List<KeyValue<Object,Object>>> hmgetAsync(@GloopParameter(allowNull=false)
                                                                     String connectionName,
                                                                     @GloopParameter(allowNull=false)
                                                                     Object key,
                                                                     GloopExecutionContext context,
                                                                     @GloopParameter(allowNull=false)
                                                                     Object... fields)

Asynchronously get the values of all the given hash fields.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; key - the key; fields - the field type: key
Returns:: list<V> array-reply list of values associated with the given fields, in the same

hmgetAsync

@GloopParameter(name="redisFutureHmgetOutput")
public static Future<Long> hmgetAsync(@GloopParameter(allowNull=false)
                                      String connectionName,
                                      @GloopParameter(allowNull=false)
                                      KeyValueStreamingChannel<Object,Object> channel,
                                      @GloopParameter(allowNull=false)
                                      Object key,
                                      GloopExecutionContext context,
                                      @GloopParameter(allowNull=false)
                                      Object... fields)

Asynchronously stream over the values of all the given hash fields.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; channel - the channel; key - the key; fields - the fields
Returns:: long count of the keys

hmset

@GloopParameter(name="redisHmsetOutput")
public static String hmset(@GloopParameter(allowNull=false)
                           String connectionName,
                           @GloopParameter(allowNull=false)
                           Object key,
                           @GloopObjectParameter("redisMap[]{\n  name:object\n  value:object\n}\n")
                           GloopModel redisMap,
                           GloopExecutionContext context)

Set multiple hash fields to multiple values.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; key - the key; redisMap - the key/value pairs
Returns:: String simple-string-reply

hmsetAsync

@GloopParameter(name="redisFutureHmsetOutput")
public static Future<String> hmsetAsync(@GloopParameter(allowNull=false)
                                        String connectionName,
                                        @GloopParameter(allowNull=false)
                                        Object key,
                                        @GloopObjectParameter("redisMap[]{\n  name:object\n  value:object\n}\n")
                                        GloopModel redisMap,
                                        GloopExecutionContext context)

Asynchronously set multiple hash fields to multiple values.

Parameters:: connectionName - The Martini Runtime Redis connection pool name; key - the key; redisMap - the key/value pairs
Returns:: string simple-string-reply