Package org.redisson.api

Interface RBatch

All Known Implementing Classes:

RedissonBatch

public interface RBatch

Interface for using Redis pipeline feature.

All method invocations on objects got through this interface are batched to separate queue and could be executed later with execute() or executeAsync() methods.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
void	discard()	Discard batched commands and release allocated buffers used for parameters encoding.
>	discardAsync()	Discard batched commands and release allocated buffers used for parameters encoding.
BatchResult<?>	execute()	Executes all operations accumulated during async methods invocations.
RFuture<BatchResult<?>>	executeAsync()	Executes all operations accumulated during async methods invocations asynchronously.
RAtomicDoubleAsync	name)	Returns atomicDouble instance by name.
RAtomicLongAsync	name)	Returns atomicLong instance by name.
RBitSetAsync	name)	Returns bitSet instance by name.
<V> RBlockingDequeAsync<V>	name)	Returns blocking deque instance by name.
<V> RBlockingDequeAsync<V>	name, Codec codec)
<V> RBlockingQueueAsync<V>	name)	Returns blocking queue instance by name.
<V> RBlockingQueueAsync<V>	name, Codec codec)
<V> RBucketAsync<V>	name)	Returns object holder by name
<V> RBucketAsync<V>	name, Codec codec)
<V> RDequeAsync<V>	name)	Returns deque instance by name.
<V> RDequeAsync<V>	name, Codec codec)
<V> RGeoAsync<V>	name)	Returns geospatial items holder instance by name.
<V> RGeoAsync<V>	name, Codec codec)	Returns geospatial items holder instance by name using provided codec for geospatial members.
<V> RHyperLogLogAsync<V>	name)	Returns HyperLogLog object
<V> RHyperLogLogAsync<V>	name, Codec codec)
RKeysAsync	getKeys()	Returns keys operations.
RLexSortedSetAsync	name)	Returns String based Redis Sorted Set instance by name All elements are inserted with the same score during addition, in order to force lexicographical ordering
<V> RListAsync<V>	name)	Returns list instance by name.
<V> RListAsync<V>	name, Codec codec)
<K,V> RMultimapAsync<K,V>	name)	Returns List based MultiMap instance by name.
<K,V> RMultimapAsync<K,V>	name, Codec codec)	Returns List based MultiMap instance by name using provided codec for both map keys and values.
<K,V> RMultimapAsync<K,V>	name)	Returns List based Multimap instance by name.
<K,V> RMultimapAsync<K,V>	name, Codec codec)	Returns List based Multimap instance by name using provided codec for both map keys and values.
<K,V> RMapAsync<K,V>	name)	Returns map instance by name.
<K,V> RMapAsync<K,V>	name, Codec codec)
<K,V> RMapCacheAsync<K,V>	name)	Returns map-based cache instance by name.
<K,V> RMapCacheAsync<K,V>	name, Codec codec)	Returns map-based cache instance by name using provided codec for both cache keys and values.
<V> RQueueAsync<V>	name)	Returns queue instance by name.
<V> RQueueAsync<V>	name, Codec codec)
<V> RScoredSortedSetAsync<V>	name)	Returns Redis Sorted Set instance by name
<V> RScoredSortedSetAsync<V>	name, Codec codec)
RScriptAsync	getScript()	Returns script operations object
RScript	getScript(Codec codec)	Returns script operations object using provided codec.
<V> RSetAsync<V>	name)	Returns set instance by name.
<V> RSetAsync<V>	name, Codec codec)
<V> RSetCacheAsync<V>	name)	Returns set-based cache instance by name.
<V> RSetCacheAsync<V>	name, Codec codec)	Returns set-based cache instance by name using provided codec for values.
<K,V> RMultimapAsync<K,V>	name)	Returns Set based MultiMap instance by name.
<K,V> RMultimapAsync<K,V>	name, Codec codec)	Returns Set based MultiMap instance by name using provided codec for both map keys and values.
<K,V> RMultimapCacheAsync<K,V>	name)	Returns Set based Multimap instance by name.
<K,V> RMultimapCacheAsync<K,V>	name, Codec codec)	Returns Set based Multimap instance by name using provided codec for both map keys and values.
<K,V> RStreamAsync<K,V>	name)	Returns stream instance by name
<K,V> RStreamAsync<K,V>	name, Codec codec)	Returns stream instance by name using provided codec for entries.
RTopicAsync	name)	Returns topic instance by name.
RTopicAsync	name, Codec codec)

Method Detail

getStream

<K,V>  name)

Returns stream instance by name

Type Parameters:

K - type of key

V - type of value

Parameters:

name - of stream

Returns:

RStream object

getStream

<K,V>  name,
                                              Codec codec)

Returns stream instance by name using provided codec for entries.

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of stream

codec - - codec for entry

Returns:

RStream object

getGeo

<V>  name)

Returns geospatial items holder instance by name.

Type Parameters:

V - type of object

Parameters:

name - - name of object

Returns:

Geo object

getGeo

<V>  name,
                        Codec codec)

Returns geospatial items holder instance by name using provided codec for geospatial members.

Type Parameters:

V - type of value

Parameters:

name - - name of object

codec - - codec for value

Returns:

Geo object

getSetMultimap

<K,V>  name)

Returns Set based MultiMap instance by name.

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

Multimap object

getSetMultimap

<K,V>  name,
                                                     Codec codec)

Returns Set based MultiMap instance by name using provided codec for both map keys and values.

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - provided codec

Returns:

Multimap object

getSetMultimapCache

<K,V>  name)

Returns Set based Multimap instance by name. Supports key-entry eviction with a given TTL value.

If eviction is not required then it's better to use regular map getSetMultimap(String).

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

SetMultimapCache object

getSetMultimapCache

<K,V>  name,
                                                               Codec codec)

Returns Set based Multimap instance by name using provided codec for both map keys and values. Supports key-entry eviction with a given TTL value.

If eviction is not required then it's better to use regular map getSetMultimap(String, Codec).

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - provided codec

Returns:

SetMultimapCache object

getSetCache

<V>  name)

Returns set-based cache instance by name. Uses map (value_hash, value) under the hood for minimal memory consumption. Supports value eviction with a given TTL value.

If eviction is not required then it's better to use regular map getSet(String, Codec).

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

SetCache object

getSetCache

<V>  name,
                                  Codec codec)

Returns set-based cache instance by name using provided codec for values. Uses map (value_hash, value) under the hood for minimal memory consumption. Supports value eviction with a given TTL value.

If eviction is not required then it's better to use regular map getSet(String, Codec).

Type Parameters:

V - type of value

Parameters:

name - - name of object

codec - - codec for values

Returns:

SetCache object

getMapCache

<K,V>  name,
                                                  Codec codec)

Returns map-based cache instance by name using provided codec for both cache keys and values. Supports entry eviction with a given TTL value.

If eviction is not required then it's better to use regular map getMap(String, Codec).

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - codec for keys and values

Returns:

MapCache object

getMapCache

<K,V>  name)

Returns map-based cache instance by name. Supports entry eviction with a given TTL value.

If eviction is not required then it's better to use regular map getMap(String).

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

MapCache object

getBucket

<V>  name)

Returns object holder by name

Type Parameters:

V - type of object

Parameters:

name - - name of object

Returns:

Bucket object

getBucket

<V>  name,
                              Codec codec)

getHyperLogLog

<V>  name)

Returns HyperLogLog object

Type Parameters:

V - type of object

Parameters:

name - - name of object

Returns:

HyperLogLog object

getHyperLogLog

<V>  name,
                                        Codec codec)

getList

<V>  name)

Returns list instance by name.

Type Parameters:

V - type of object

Parameters:

name - - name of object

Returns:

List object

getList

<V>  name,
                          Codec codec)

getListMultimap

<K,V>  name)

Returns List based MultiMap instance by name.

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

ListMultimap object

getListMultimap

<K,V>  name,
                                                      Codec codec)

Returns List based MultiMap instance by name using provided codec for both map keys and values.

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - codec for keys and values

Returns:

ListMultimap object

getListMultimapCache

<K,V>  name)

Returns List based Multimap instance by name. Supports key-entry eviction with a given TTL value.

If eviction is not required then it's better to use regular map getSetMultimap(String).

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

ListMultimapCache object

getListMultimapCache

<K,V>  name,
                                                           Codec codec)

Returns List based Multimap instance by name using provided codec for both map keys and values. Supports key-entry eviction with a given TTL value.

If eviction is not required then it's better to use regular map getSetMultimap(String, Codec).

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - codec for keys and values

Returns:

ListMultimapCache object

getMap

<K,V>  name)

Returns map instance by name.

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

Map object

getMap

<K,V>  name,
                                        Codec codec)

getSet

<V>  name)

Returns set instance by name.

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

Set object

getSet

<V>  name,
                        Codec codec)

getTopic

 name)

Returns topic instance by name.

Parameters:

name - - name of object

Returns:

Topic object

getTopic

 name,
                     Codec codec)

getQueue

<V>  name)

Returns queue instance by name.

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

Queue object

getQueue

<V>  name,
                            Codec codec)

getBlockingQueue

<V>  name)

Returns blocking queue instance by name.

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

BlockingQueue object

getBlockingQueue

<V>  name,
                                            Codec codec)

getDeque

<V>  name)

Returns deque instance by name.

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

Deque object

getDeque

<V>  name,
                            Codec codec)

getBlockingDeque

<V>  name)

Returns blocking deque instance by name.

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

BlockingDeque object

getBlockingDeque

<V>  name,
                                            Codec codec)

getAtomicLong

 name)

Returns atomicLong instance by name.

Parameters:

name - - name of object

Returns:

AtomicLong object

getAtomicDouble

 name)

Returns atomicDouble instance by name.

Parameters:

name - - name of object

Returns:

AtomicDouble object

getScoredSortedSet

<V>  name)

Returns Redis Sorted Set instance by name

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

ScoredSortedSet object

getScoredSortedSet

<V>  name,
                                                Codec codec)

getLexSortedSet

 name)

Returns String based Redis Sorted Set instance by name All elements are inserted with the same score during addition, in order to force lexicographical ordering

Parameters:

name - - name of object

Returns:

LexSortedSet object

getBitSet

 name)

Returns bitSet instance by name.

Parameters:

name - - name of object

Returns:

BitSet object

getScript

RScriptAsync getScript()

Returns script operations object

Returns:

Script object

getScript

RScript getScript(Codec codec)

Returns script operations object using provided codec.

Parameters:

codec - - codec for params and result

Returns:

Script object

getKeys

RKeysAsync getKeys()

Returns keys operations. Each of Redis/Redisson object associated with own key

Returns:

Keys object

execute

BatchResult<?> execute()
                throws RedisException

Executes all operations accumulated during async methods invocations.

If cluster configuration used then operations are grouped by slot ids and may be executed on different servers. Thus command execution order could be changed

Returns:

List with result object for each command

Throws:

RedisException - in case of any error

executeAsync

RFuture<BatchResult<?>> executeAsync()

Executes all operations accumulated during async methods invocations asynchronously.

In cluster configurations operations grouped by slot ids so may be executed on different servers. Thus command execution order could be changed

Returns:

List with result object for each command

discard

void discard()

Discard batched commands and release allocated buffers used for parameters encoding.

discardAsync

> discardAsync()

Discard batched commands and release allocated buffers used for parameters encoding.

Returns:

void