Package io.quarkus.redis.runtime.datasource

Class BlockingTransactionalRedisDataSourceImpl

java.lang.Object

io.quarkus.redis.runtime.datasource.BlockingTransactionalRedisDataSourceImpl

All Implemented Interfaces:

TransactionalRedisDataSource

public class BlockingTransactionalRedisDataSourceImpl
extends Object
implements TransactionalRedisDataSource

Constructor Summary

Constructors

Constructor	Description
BlockingTransactionalRedisDataSourceImpl(ReactiveTransactionalRedisDataSource api, Duration timeout)

Method Summary

Modifier and Type	Method	Description
<K> TransactionalAutoSuggestCommands<K>	autosuggest(Class<K> redisKeyType)	Gets the object to emit commands from the auto-suggest group.
<K> TransactionalBitMapCommands<K>	bitmap(Class<K> redisKeyType)	Gets the object to execute commands manipulating bitmap data structures.
<K,V> TransactionalBloomCommands<K,V>	bloom(Class<K> redisKeyType, Class<V> valueType)	Gets the object to manipulate Bloom filters.
<K,V> TransactionalCountMinCommands<K,V>	countmin(Class<K> redisKeyType, Class<V> valueType)	Gets the object to manipulate Count-Min sketches.
<K,V> TransactionalCuckooCommands<K,V>	cuckoo(Class<K> redisKeyType, Class<V> valueType)	Gets the object to manipulate Cuckoo filters.
void	discard()	Discard the current transaction.
boolean	discarded()	Checks if the current transaction has been discarded by the user
void	execute(io.vertx.mutiny.redis.client.Command command, String... args)	Executes a command.
void	execute(io.vertx.redis.client.Command command, String... args)	Executes a command.
void	execute(String command, String... args)	Executes a command.
<K,V> TransactionalGeoCommands<K,V>	geo(Class<K> redisKeyType, Class<V> memberType)	Gets the object to execute commands manipulating geo items (a.k.a.
<K> TransactionalGraphCommands<K>	graph(Class<K> redisKeyType)	Gets the object to manipulate graphs.
<K,F,V> TransactionalHashCommands<K,F,V>	hash(Class<K> redisKeyType, Class<F> typeOfField, Class<V> typeOfValue)	Gets the object to execute commands manipulating hashes (a.k.a.
<K,V> TransactionalHyperLogLogCommands<K,V>	hyperloglog(Class<K> redisKeyType, Class<V> memberType)	Gets the object to execute commands manipulating hyperloglog data structures.
<K> TransactionalJsonCommands<K>	json(Class<K> redisKeyType)	Gets the object to manipulate JSON values.
<K> TransactionalKeyCommands<K>	key(Class<K> redisKeyType)	Gets the object to execute commands manipulating keys and expiration times.
<K,V> TransactionalListCommands<K,V>	list(Class<K> redisKeyType, Class<V> memberType)	Gets the object to execute commands manipulating lists.
<K> TransactionalSearchCommands	search(Class<K> redisKeyType)	Gets the object to emit commands from the search group.
<K,V> TransactionalSetCommands<K,V>	set(Class<K> redisKeyType, Class<V> memberType)	Gets the object to execute commands manipulating sets.
<K,V> TransactionalSortedSetCommands<K,V>	sortedSet(Class<K> redisKeyType, Class<V> valueType)	Gets the object to execute commands manipulating sorted sets.
<K,F,V> TransactionalStreamCommands<K,F,V>	stream(Class<K> redisKeyType, Class<F> typeOfField, Class<V> typeOfValue)	Gets the object to execute commands manipulating streams.
<K,V> TransactionalStringCommands<K,V>	string(Class<K> redisKeyType, Class<V> valueType)	Gets the object to execute commands manipulating stored strings.
<K> TransactionalTimeSeriesCommands<K>	timeseries(Class<K> redisKeyType)	Gets the object to emit commands from the time series group.
<K,V> TransactionalTopKCommands<K,V>	topk(Class<K> redisKeyType, Class<V> valueType)	Gets the object to manipulate Top-K list.
<K,V> TransactionalValueCommands<K,V>	value(Class<K> redisKeyType, Class<V> valueType)	Gets the object to execute commands manipulating stored strings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.quarkus.redis.datasource.transactions.TransactionalRedisDataSource

autosuggest, bitmap, bloom, countmin, cuckoo, geo, graph, hash, hyperloglog, json, key, list, search, set, sortedSet, stream, string, timeseries, topk, value

Constructor Detail

BlockingTransactionalRedisDataSourceImpl

public BlockingTransactionalRedisDataSourceImpl(ReactiveTransactionalRedisDataSource api,
                                                Duration timeout)

Method Detail

discard

public void discard()

Description copied from interface: TransactionalRedisDataSource

Discard the current transaction.

Specified by:

discard in interface TransactionalRedisDataSource

discarded

public boolean discarded()

Description copied from interface: TransactionalRedisDataSource

Checks if the current transaction has been discarded by the user

Specified by:

discarded in interface TransactionalRedisDataSource

Returns:

if the current transaction has been discarded by the user

hash

public <K,F,V> TransactionalHashCommands<K,F,V> hash(Class<K> redisKeyType,
                                                                             Class<F> typeOfField,
                                                                             Class<V> typeOfValue)

Description copied from interface: TransactionalRedisDataSource

Gets the object to execute commands manipulating hashes (a.k.a. Map<F, V>).

If you want to use a hash of <String -> Person> stored using String identifier, you would use: hash(String.class, String.class, Person.class). If you want to use a hash of <String -> Person> stored using UUID identifier, you would use: hash(UUID.class, String.class, Person.class).

Specified by:

hash in interface TransactionalRedisDataSource

Type Parameters:

K - the type of the redis key

F - the type of the fields (map's keys)

V - the type of the value

Parameters:

redisKeyType - the class of the keys

typeOfField - the class of the fields

typeOfValue - the class of the values

Returns:

the object to execute commands manipulating hashes (a.k.a. Map<K, V>).

geo

public <K,V> TransactionalGeoCommands<K,V> geo(Class<K> redisKeyType,
                                                           Class<V> memberType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to execute commands manipulating geo items (a.k.a. {longitude, latitude, member}).

V represents the type of the member, i.e. the localized thing.

Specified by:

geo in interface TransactionalRedisDataSource

Type Parameters:

K - the type of the redis key

V - the type of the member

Parameters:

redisKeyType - the class of the keys

memberType - the class of the members

Returns:

the object to execute geo commands.

key

public <K> TransactionalKeyCommands<K> key(Class<K> redisKeyType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to execute commands manipulating keys and expiration times.

Specified by:

key in interface TransactionalRedisDataSource

Type Parameters:

K - the type of the key

Parameters:

redisKeyType - the type of the keys

Returns:

the object to execute commands manipulating keys.

set

public <K,V> TransactionalSetCommands<K,V> set(Class<K> redisKeyType,
                                                           Class<V> memberType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to execute commands manipulating sets.

Specified by:

set in interface TransactionalRedisDataSource

Type Parameters:

K - the type of the key

V - the type of the member

Parameters:

redisKeyType - the type of the keys

memberType - the type of the member stored in each set

Returns:

the object to manipulate sets.

sortedSet

public <K,V> TransactionalSortedSetCommands<K,V> sortedSet(Class<K> redisKeyType,
                                                                       Class<V> valueType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to execute commands manipulating sorted sets.

Specified by:

sortedSet in interface TransactionalRedisDataSource

Type Parameters:

K - the type of the key

V - the type of the value

Parameters:

redisKeyType - the type of the keys

valueType - the type of the value sorted in the sorted sets

Returns:

the object to manipulate sorted sets.

string

public <K,V> TransactionalStringCommands<K,V> string(Class<K> redisKeyType,
                                                                 Class<V> valueType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to execute commands manipulating stored strings.

Specified by:

string in interface TransactionalRedisDataSource

Type Parameters:

K - the type of the key

V - the type of the value

Parameters:

redisKeyType - the type of the keys

valueType - the type of the value, often String, or the value are encoded/decoded using codecs.

Returns:

the object to manipulate stored strings.

value

public <K,V> TransactionalValueCommands<K,V> value(Class<K> redisKeyType,
                                                               Class<V> valueType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to execute commands manipulating stored strings.

NOTE: Instead of string, this group is named value to avoid the confusion with the Java String type. Indeed, Redis strings can be strings, numbers, byte arrays...

Specified by:

value in interface TransactionalRedisDataSource

Type Parameters:

K - the type of the key

V - the type of the value

Parameters:

redisKeyType - the type of the keys

valueType - the type of the value, often String, or the value are encoded/decoded using codecs.

Returns:

the object to manipulate stored strings.

list

public <K,V> TransactionalListCommands<K,V> list(Class<K> redisKeyType,
                                                             Class<V> memberType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to execute commands manipulating lists.

Specified by:

list in interface TransactionalRedisDataSource

Type Parameters:

K - the type of the key

V - the type of the member

Parameters:

redisKeyType - the type of the keys

memberType - the type of the member stored in each list

Returns:

the object to manipulate sets.

hyperloglog

public <K,V> TransactionalHyperLogLogCommands<K,V> hyperloglog(Class<K> redisKeyType,
                                                                           Class<V> memberType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to execute commands manipulating hyperloglog data structures.

Specified by:

hyperloglog in interface TransactionalRedisDataSource

Type Parameters:

K - the type of the key

V - the type of the member

Parameters:

redisKeyType - the type of the keys

memberType - the type of the member stored in the data structure

Returns:

the object to manipulate hyper log log data structures.

bitmap

public <K> TransactionalBitMapCommands<K> bitmap(Class<K> redisKeyType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to execute commands manipulating bitmap data structures.

Specified by:

bitmap in interface TransactionalRedisDataSource

Type Parameters:

K - the type of the key

Parameters:

redisKeyType - the type of the keys

Returns:

the object to manipulate bitmap data structures.

stream

public <K,F,V> TransactionalStreamCommands<K,F,V> stream(Class<K> redisKeyType,
                                                                                 Class<F> typeOfField,
                                                                                 Class<V> typeOfValue)

Description copied from interface: TransactionalRedisDataSource

Gets the object to execute commands manipulating streams.

Specified by:

stream in interface TransactionalRedisDataSource

Type Parameters:

K - the type of the redis key

F - the type of the fields (map's keys)

V - the type of the value

Parameters:

redisKeyType - the class of the keys

typeOfField - the class of the fields

typeOfValue - the class of the values

Returns:

the object to execute commands manipulating streams.

json

public <K> TransactionalJsonCommands<K> json(Class<K> redisKeyType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to manipulate JSON values. This group requires the RedisJSON module.

Specified by:

json in interface TransactionalRedisDataSource

Type Parameters:

K - the type of keys

Returns:

the object to manipulate JSON values.

bloom

public <K,V> TransactionalBloomCommands<K,V> bloom(Class<K> redisKeyType,
                                                               Class<V> valueType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to manipulate Bloom filters. This group requires the RedisBloom module.

Specified by:

bloom in interface TransactionalRedisDataSource

Type Parameters:

K - the type of key

V - the type of value

Parameters:

redisKeyType - the type of the key

valueType - the type of value to store in the filters

Returns:

the object to manipulate Bloom filters

cuckoo

public <K,V> TransactionalCuckooCommands<K,V> cuckoo(Class<K> redisKeyType,
                                                                 Class<V> valueType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to manipulate Cuckoo filters. This group requires the RedisBloom module (including the Cuckoo filter support).

Specified by:

cuckoo in interface TransactionalRedisDataSource

Type Parameters:

K - the type of keys

V - the type of the values added into the Cuckoo filter

Returns:

the object to manipulate Cuckoo values.

countmin

public <K,V> TransactionalCountMinCommands<K,V> countmin(Class<K> redisKeyType,
                                                                     Class<V> valueType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to manipulate Count-Min sketches. This group requires the RedisBloom module (including the count-min sketches support).

Specified by:

countmin in interface TransactionalRedisDataSource

Type Parameters:

K - the type of keys

V - the type of the values added into the count-min sketches

Returns:

the object to manipulate count-min sketches.

topk

public <K,V> TransactionalTopKCommands<K,V> topk(Class<K> redisKeyType,
                                                             Class<V> valueType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to manipulate Top-K list. This group requires the RedisBloom module (including the top-k list support).

Specified by:

topk in interface TransactionalRedisDataSource

Type Parameters:

K - the type of keys

V - the type of the values added into the top-k lists

Returns:

the object to manipulate top-k lists.

graph

public <K> TransactionalGraphCommands<K> graph(Class<K> redisKeyType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to manipulate graphs. This group requires the RedisGraph module.

Specified by:

graph in interface TransactionalRedisDataSource

Type Parameters:

K - the type of keys

Returns:

the object to manipulate graphs lists.

search

public <K> TransactionalSearchCommands search(Class<K> redisKeyType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to emit commands from the search group. This group requires the RedisSearch module.

Specified by:

search in interface TransactionalRedisDataSource

Type Parameters:

K - the type of keys

Returns:

the object to search documents

autosuggest

public <K> TransactionalAutoSuggestCommands<K> autosuggest(Class<K> redisKeyType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to emit commands from the auto-suggest group. This group requires the RedisSearch module.

Specified by:

autosuggest in interface TransactionalRedisDataSource

Type Parameters:

K - the type of keys

Returns:

the object to get suggestions

timeseries

public <K> TransactionalTimeSeriesCommands<K> timeseries(Class<K> redisKeyType)

Description copied from interface: TransactionalRedisDataSource

Gets the object to emit commands from the time series group. This group requires the Redis Time Series module.

Specified by:

timeseries in interface TransactionalRedisDataSource

Type Parameters:

K - the type of keys

Returns:

the object to manipulate time series

execute

public void execute(String command,
                    String... args)

Description copied from interface: TransactionalRedisDataSource

Executes a command. This method is used to execute commands not offered by the API.

Specified by:

execute in interface TransactionalRedisDataSource

Parameters:

command - the command name

args - the parameters, encoded as String.

execute

public void execute(io.vertx.mutiny.redis.client.Command command,
                    String... args)

Description copied from interface: TransactionalRedisDataSource

Executes a command. This method is used to execute commands not offered by the API.

Specified by:

execute in interface TransactionalRedisDataSource

Parameters:

command - the command

args - the parameters, encoded as String.

execute

public void execute(io.vertx.redis.client.Command command,
                    String... args)

Description copied from interface: TransactionalRedisDataSource

Executes a command. This method is used to execute commands not offered by the API.

Specified by:

execute in interface TransactionalRedisDataSource

Parameters:

command - the command

args - the parameters, encoded as String.