Package io.quarkus.redis.datasource.json
Interface JsonCommands<K>
- Type Parameters:
K
- the type of the key
- All Superinterfaces:
RedisCommands
- All Known Implementing Classes:
BlockingJsonCommandsImpl
Allows executing commands from the
json
group (requires the Redis stack).
See the json command list for further information about these commands.
Redis JSON lets you store, update, and retrieve JSON values in a Redis database, similar to any other Redis data type.
Ths API is based on the JsonObject
and JsonArray
types.
Some methods also allows direct mapping from and to objects. In the case of deserialization, the
Class
must be passed.
-
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.default OptionalInt
jsonArrLen
(K key) Execute the command JSON.ARRLEN.jsonArrLen
(K key, String path) Execute the command JSON.ARRLEN.default <T> T
jsonArrPop
(K key, Class<T> clazz) Execute the command JSON.ARRPOP.default <T> List<T>
jsonArrPop
(K key, Class<T> clazz, String path) Execute the command JSON.ARRPOP.<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.default int
Execute the command JSON.CLEAR.int
Execute the command JSON.CLEAR.default int
Execute the command JSON.DEL.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) Execute the command JSON.OBJKEYS.jsonObjKeys
(K key, String path) Execute the command JSON.OBJKEYS.default OptionalInt
jsonObjLen
(K key) Execute the command JSON.OBJLEN.jsonObjLen
(K key, String path) Execute the command JSON.OBJLEN.default void
Execute the command JSON.SET.default void
Execute the command JSON.SET.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.default <T> void
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 interface io.quarkus.redis.datasource.RedisCommands
getDataSource
-
Method Details
-
jsonSet
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- 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
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- Type Parameters:
T
- the type for the value- Parameters:
key
- the key, must not benull
value
- the value, encoded to JSON
-
jsonSet
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- Parameters:
key
- the key, must not benull
path
- the path, must not benull
json
- the JSON object to store, must not benull
-
jsonSet
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: jsonThis variant uses
$
as path.- Parameters:
key
- the key, must not benull
json
- the JSON object to store, must not benull
-
jsonSet
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- 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
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- Parameters:
key
- the key, must not benull
path
- the path, must not benull
json
- the JSON array to store, must not benull
-
jsonSet
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- Parameters:
key
- the key, must not benull
json
- the JSON array to store, must not benull
-
jsonSet
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- 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
Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json- 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
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>
.- 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
Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: jsonThis method uses the root path (
$
). UnlikejsonGet(Object, Class)
, it returns aJsonObject
.- Parameters:
key
- the key, must not benull
- Returns:
- the stored JSON object,
null
if it does not exist
-
jsonGetArray
Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: jsonThis method uses the root path (
$
). UnlikejsonGet(Object, Class)
, it returns aJsonArray
.- Parameters:
key
- the key, must not benull
- Returns:
- the stored JSON array,
null
if it does not exist
-
jsonGet
Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: json- 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
Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: json- Parameters:
key
- the key, must not benull
paths
- the paths, must not benull
. If no path are passed, this is equivalent tojsonGetObject(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 tojsonGetObject(Object)
. If multiple paths are passed, the produced JSON object contains the result for each pass as a JSON array.
-
jsonArrAppend
Execute the command JSON.ARRAPPEND. Summary: Append the json values into the array at path after the last element in it. Group: json- 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
Execute the command JSON.ARRINDEX. Summary: Searches for the first occurrence of a scalar JSON value in an array. Group: json- 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
Execute the command JSON.ARRINDEX. Summary: Searches for the first occurrence of a scalar JSON value in an array. Group: json- 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
Execute the command JSON.ARRINSERT. Summary: Inserts the json values into the array at path before the index (shifts to the right). Group: json- 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
Execute the command JSON.ARRLEN. Summary: Reports the length of the JSON Array at path in key. Group: json- 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.
-
jsonArrLen
Execute the command JSON.ARRLEN. Summary: Reports the length of the JSON Array at path in key. Group: json- Parameters:
key
- the key, must not benull
- Returns:
- an optional containing the array's length, empty if the matching JSON value is not an array.
-
jsonArrPop
Execute the command JSON.ARRPOP. Summary: Removes and returns an element from the index in the array. Group: json- 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
.
-
jsonArrPop
Execute the command JSON.ARRPOP. Summary: Removes and returns an element from the index in the array. Group: json- Parameters:
key
- the key, must not benull
clazz
- the type of the popped objectpath
- path the path, defaults to root if not provided.- 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
.
-
jsonArrPop
Execute the command JSON.ARRPOP. Summary: Removes and returns an element from the index in the array. Group: jsonThis variant popped from the root object (must be a JSON array), and returns a single item.
- Parameters:
key
- the key, must not benull
clazz
- the type of the popped object- Returns:
- an instance of T.
-
jsonArrTrim
Execute the command JSON.ARRTRIM. Summary: Trims an array so that it contains only the specified inclusive range of elements. Group: json- 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
Execute the command JSON.CLEAR. Summary: Clears container values (Arrays/Objects), and sets numeric values to 0. Group: json- 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
-
jsonClear
Execute the command JSON.CLEAR. Summary: Clears container values (Arrays/Objects), and sets numeric values to 0. Group: json- Parameters:
key
- the key, must not benull
- Returns:
- the number of value cleared
-
jsonDel
Execute the command JSON.DEL. Summary: Deletes a value. Group: json- 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
-
jsonDel
Execute the command JSON.DEL. Summary: Deletes a value. Group: json- Parameters:
key
- the key, must not benull
- Returns:
- the number of path deleted (0 or more)
-
jsonMget
Execute the command JSON.MGET. Summary: Returns the values at path from multiple key arguments. Returnsnull
for nonexistent keys and nonexistent paths. Group: json- Parameters:
path
- path the pathkeys
- the keys, must not benull
, must not containnull
- Returns:
- a list of JsonArray containing each retrieved value
-
jsonNumincrby
Execute the command JSON.NUMINCRBY. Summary: Increments the number value stored at path by number. Group: json- 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
Execute the command JSON.OBJKEYS. Summary: Returns the keys in the object that's referenced by path. Group: json- 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.
-
jsonObjKeys
Execute the command JSON.OBJKEYS. Summary: Returns the keys in the object that's referenced by path. Group: json- Parameters:
key
- the key, must not benull
- Returns:
- a list containing the list of keys, or
null
if the stored value is not a JSON object.
-
jsonObjLen
Execute the command JSON.OBJLEN. Summary: Reports the number of keys in the JSON Object at path in key. Group: json- 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
-
jsonObjLen
Execute the command JSON.OBJLEN. Summary: Reports the number of keys in the JSON Object at path in key. Group: json- Parameters:
key
- the key, must not benull
- Returns:
- the length of the JSON object,
null
if the matching JSON value is not an object
-
jsonStrAppend
Execute the command JSON.STRAPPEND. Summary: Appends the json-string values to the string at path. Group: json- 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
Execute the command JSON.STRLEN. Summary: Reports the length of the JSON String at path in key. Group: json- 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
Execute the command JSON.TOGGLE. Summary: Toggle a boolean value stored at path. Group: json- 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
Execute the command JSON.TYPE. Summary: Reports the type of JSON value at path. Group: json- 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.
-