Class BlockingJsonCommandsImpl<K>
java.lang.Object
io.quarkus.redis.runtime.datasource.AbstractRedisCommandGroup
io.quarkus.redis.runtime.datasource.BlockingJsonCommandsImpl<K>
- All Implemented Interfaces:
JsonCommands<K>
,RedisCommands
public class BlockingJsonCommandsImpl<K>
extends AbstractRedisCommandGroup
implements JsonCommands<K>
-
Field Summary
Fields inherited from class io.quarkus.redis.runtime.datasource.AbstractRedisCommandGroup
ds, timeout
-
Constructor Summary
ConstructorDescriptionBlockingJsonCommandsImpl
(RedisDataSource ds, ReactiveJsonCommands<K> reactive, Duration timeout) -
Method Summary
Modifier and TypeMethodDescriptionjsonArrAppend
(K key, String path, T... values) Execute the command JSON.ARRAPPEND.jsonArrIndex
(K key, String path, T value) Execute the command JSON.ARRINDEX.jsonArrIndex
(K key, String path, T value, int start, int end) Execute the command JSON.ARRINDEX.jsonArrInsert
(K key, String path, int index, T... values) Execute the command JSON.ARRINSERT.jsonArrLen
(K key, String path) Execute the command JSON.ARRLEN.<T> List<T>
jsonArrPop
(K key, Class<T> clazz, String path, int index) Execute the command JSON.ARRPOP.jsonArrTrim
(K key, String path, int start, int stop) Execute the command JSON.ARRTRIM.int
Execute the command JSON.CLEAR.int
Execute the command JSON.DEL.<T> T
Execute the command JSON.GET.io.vertx.core.json.JsonArray
Execute the command JSON.GET.io.vertx.core.json.JsonObject
Execute the command JSON.GET.io.vertx.core.json.JsonArray
jsonGetArray
(K key) Execute the command JSON.GET.io.vertx.core.json.JsonObject
jsonGetObject
(K key) Execute the command JSON.GET.List<io.vertx.core.json.JsonArray>
Execute the command JSON.MGET.void
jsonNumincrby
(K key, String path, double value) Execute the command JSON.NUMINCRBY.jsonObjKeys
(K key, String path) Execute the command JSON.OBJKEYS.jsonObjLen
(K key, String path) Execute the command JSON.OBJLEN.void
Execute the command JSON.SET.void
jsonSet
(K key, String path, io.vertx.core.json.JsonArray json, JsonSetArgs args) Execute the command JSON.SET.void
Execute the command JSON.SET.void
jsonSet
(K key, String path, io.vertx.core.json.JsonObject json, JsonSetArgs args) Execute the command JSON.SET.<T> void
Execute the command JSON.SET.<T> void
jsonSet
(K key, String path, T value, JsonSetArgs args) Execute the command JSON.SET.jsonStrAppend
(K key, String path, String value) Execute the command JSON.STRAPPEND.jsonStrLen
(K key, String path) Execute the command JSON.STRLEN.jsonToggle
(K key, String path) Execute the command JSON.TOGGLE.Execute the command JSON.TYPE.Methods inherited from class io.quarkus.redis.runtime.datasource.AbstractRedisCommandGroup
getDataSource
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.json.JsonCommands
jsonArrLen, jsonArrPop, jsonArrPop, jsonClear, jsonDel, jsonObjKeys, jsonObjLen, jsonSet, jsonSet, jsonSet
Methods inherited from interface io.quarkus.redis.datasource.RedisCommands
getDataSource
-
Constructor Details
-
BlockingJsonCommandsImpl
public BlockingJsonCommandsImpl(RedisDataSource ds, ReactiveJsonCommands<K> reactive, Duration timeout)
-
-
Method Details
-
jsonSet
Description copied from interface:JsonCommands
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- Specified by:
jsonSet
in interfaceJsonCommands<K>
- Type Parameters:
T
- the type for the value- Parameters:
key
- the key, must not benull
path
- the path, must not benull
value
- the value, encoded to JSON
-
jsonSet
Description copied from interface:JsonCommands
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- Specified by:
jsonSet
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- the path, must not benull
json
- the JSON object to store, must not benull
-
jsonSet
Description copied from interface:JsonCommands
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- Specified by:
jsonSet
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- the path, must not benull
json
- the JSON object to store, must not benull
args
- the extra arguments
-
jsonSet
Description copied from interface:JsonCommands
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- Specified by:
jsonSet
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- the path, must not benull
json
- the JSON array to store, must not benull
-
jsonSet
Description copied from interface:JsonCommands
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- Specified by:
jsonSet
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- the path, must not benull
json
- the JSON array to store, must not benull
args
- the extra arguments
-
jsonSet
Description copied from interface:JsonCommands
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- Specified by:
jsonSet
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- the path, must not benull
value
- the value to store, encoded to JSON.args
- the extra arguments
-
jsonGet
Description copied from interface:JsonCommands
Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: jsonThis method uses the root path (
$
). It map the retrieve JSON document to an object of type<T>
.- Specified by:
jsonGet
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
clazz
- the type of object to recreate from the JSON content- Returns:
- the object,
null
if it does not exist
-
jsonGetObject
Description copied from interface:JsonCommands
Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: jsonThis method uses the root path (
$
). UnlikeJsonCommands.jsonGet(Object, Class)
, it returns aJsonObject
.- Specified by:
jsonGetObject
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
- Returns:
- the stored JSON object,
null
if it does not exist
-
jsonGetArray
Description copied from interface:JsonCommands
Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: jsonThis method uses the root path (
$
). UnlikeJsonCommands.jsonGet(Object, Class)
, it returns aJsonArray
.- Specified by:
jsonGetArray
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
- Returns:
- the stored JSON array,
null
if it does not exist
-
jsonGet
Description copied from interface:JsonCommands
Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: json- Specified by:
jsonGet
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- the path, must not benull
- Returns:
- the JSON array containing the different results,
null
if it does not exist.
-
jsonGet
Description copied from interface:JsonCommands
Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: json- Specified by:
jsonGet
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
paths
- the paths, must not benull
. If no path are passed, this is equivalent toJsonCommands.jsonGetObject(Object)
, if multiple paths are passed, the produced JSON object contains the result (as a json array) for each path.- Returns:
- the stored JSON object,
null
if it does not exist. If no path are passed, this is equivalent toJsonCommands.jsonGetObject(Object)
. If multiple paths are passed, the produced JSON object contains the result for each pass as a JSON array.
-
jsonArrAppend
Description copied from interface:JsonCommands
Execute the command JSON.ARRAPPEND. Summary: Append the json values into the array at path after the last element in it. Group: json- Specified by:
jsonArrAppend
in interfaceJsonCommands<K>
- Type Parameters:
T
- the type of value- Parameters:
key
- the key, must not benull
path
- the path, must not benull
values
- the values to append, encoded to JSON- Returns:
- a list with the new sizes of each modified array (in order) or
null
(instead of the size) if the point object was not an array.
-
jsonArrIndex
Description copied from interface:JsonCommands
Execute the command JSON.ARRINDEX. Summary: Searches for the first occurrence of a scalar JSON value in an array. Group: json- Specified by:
jsonArrIndex
in interfaceJsonCommands<K>
- Type Parameters:
T
- the type of value- Parameters:
key
- the key, must not benull
path
- the path, must not benull
value
- the value to be searched, encoded to JSONstart
- the start indexend
- the end index- Returns:
- a list with the first position in the array of each JSON value that matches the path,
-1
if not found in the array, ornull
if the matching JSON value is not an array.
-
jsonArrIndex
Description copied from interface:JsonCommands
Execute the command JSON.ARRINDEX. Summary: Searches for the first occurrence of a scalar JSON value in an array. Group: json- Specified by:
jsonArrIndex
in interfaceJsonCommands<K>
- Type Parameters:
T
- the type of value- Parameters:
key
- the key, must not benull
path
- the path, must not benull
value
- the value to be searched, encoded to JSON- Returns:
- a list with the first position in the array of each JSON value that matches the path,
-1
if not found in the array, ornull
if the matching JSON value is not an array.
-
jsonArrInsert
Description copied from interface:JsonCommands
Execute the command JSON.ARRINSERT. Summary: Inserts the json values into the array at path before the index (shifts to the right). Group: json- Specified by:
jsonArrInsert
in interfaceJsonCommands<K>
- Type Parameters:
T
- the type of value- Parameters:
key
- the key, must not benull
path
- the path, must not benull
index
- the index. The index must be in the array's range. Inserting at index 0 prepends to the array. Negative index values start from the end of the array.values
- the values to insert, encoded to JSON- Returns:
- a list of integer containing for each path, the array's new size or
null
if the matching JSON value is not an array.
-
jsonArrLen
Description copied from interface:JsonCommands
Execute the command JSON.ARRLEN. Summary: Reports the length of the JSON Array at path in key. Group: json- Specified by:
jsonArrLen
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- the path,null
means$
- Returns:
- a list of integer containing for each path, the array's length, or @{code null} if the matching JSON value is not an array.
-
jsonArrPop
Description copied from interface:JsonCommands
Execute the command JSON.ARRPOP. Summary: Removes and returns an element from the index in the array. Group: json- Specified by:
jsonArrPop
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
clazz
- the type of the popped objectpath
- path the path, defaults to root if not provided.index
- is the position in the array to start popping from (defaults to -1, meaning the last element). Out-of-range indexes round to their respective array ends.- Returns:
- a list of T including for each path, an instance of T rebuilt from the JSON value, or
null
if the matching JSON value is not an array. Popping an empty array producesnull
.
-
jsonArrTrim
Description copied from interface:JsonCommands
Execute the command JSON.ARRTRIM. Summary: Trims an array so that it contains only the specified inclusive range of elements. Group: json- Specified by:
jsonArrTrim
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- path the path, must not benull
start
- the start indexstop
- the stop index- Returns:
- a list of integer containing, for each path, the array's new size, or
null
if the matching JSON value is not an array.
-
jsonClear
Description copied from interface:JsonCommands
Execute the command JSON.CLEAR. Summary: Clears container values (Arrays/Objects), and sets numeric values to 0. Group: json- Specified by:
jsonClear
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- path the path, path defaults to$
if not provided. Non-existing paths are ignored.- Returns:
- the number of value cleared
-
jsonDel
Description copied from interface:JsonCommands
Execute the command JSON.DEL. Summary: Deletes a value. Group: json- Specified by:
jsonDel
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- path the path, path defaults to$
if not provided. Non-existing paths are ignored.- Returns:
- the number of path deleted
-
jsonMget
Description copied from interface:JsonCommands
Execute the command JSON.MGET. Summary: Returns the values at path from multiple key arguments. Returnsnull
for nonexistent keys and nonexistent paths. Group: json- Specified by:
jsonMget
in interfaceJsonCommands<K>
- Parameters:
path
- path the pathkeys
- the keys, must not benull
, must not containnull
- Returns:
- a list of JsonArray containing each retrieved value
-
jsonNumincrby
Description copied from interface:JsonCommands
Execute the command JSON.NUMINCRBY. Summary: Increments the number value stored at path by number. Group: json- Specified by:
jsonNumincrby
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- path the path, path defaults to$
if not provided. Non-existing paths are ignored.value
- the value to add
-
jsonObjKeys
Description copied from interface:JsonCommands
Execute the command JSON.OBJKEYS. Summary: Returns the keys in the object that's referenced by path. Group: json- Specified by:
jsonObjKeys
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- path the path, path defaults to$
if not provided.- Returns:
- a list containing, for each matching path, the list of keys, or
null
if the matching JSON value is not an object.
-
jsonObjLen
Description copied from interface:JsonCommands
Execute the command JSON.OBJLEN. Summary: Reports the number of keys in the JSON Object at path in key. Group: json- Specified by:
jsonObjLen
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- path the path, path defaults to$
if not provided.- Returns:
- a list containing, for each path, the length of the object,
null
if the matching JSON value is not an object
-
jsonStrAppend
Description copied from interface:JsonCommands
Execute the command JSON.STRAPPEND. Summary: Appends the json-string values to the string at path. Group: json- Specified by:
jsonStrAppend
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- path the path, path defaults to$
if not provided.value
- the string to append, must not benull
- Returns:
- a list containing, for each path, the new string length,
null
if the matching JSON value is not a string.
-
jsonStrLen
Description copied from interface:JsonCommands
Execute the command JSON.STRLEN. Summary: Reports the length of the JSON String at path in key. Group: json- Specified by:
jsonStrLen
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- path the path, path defaults to$
if not provided.- Returns:
- a list containing, for each path, the length of the string,
null
if the matching JSON value is not a string. Returnsnull
if the key or path do not exist.
-
jsonToggle
Description copied from interface:JsonCommands
Execute the command JSON.TOGGLE. Summary: Toggle a boolean value stored at path. Group: json- Specified by:
jsonToggle
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- path the path, must not benull
- Returns:
- a list containing, for each path, the new boolean value,
null
if the matching JSON value is not a boolean.
-
jsonType
Description copied from interface:JsonCommands
Execute the command JSON.TYPE. Summary: Reports the type of JSON value at path. Group: json- Specified by:
jsonType
in interfaceJsonCommands<K>
- Parameters:
key
- the key, must not benull
path
- path the path, path defaults to$
if not provided.- Returns:
- a list containing, for each path, the json type as String (string, integer, number, boolean, object, array), empty if no match.
-