Package io.quarkus.redis.datasource.json

Interface TransactionalJsonCommands<K>

All Superinterfaces:

TransactionalRedisCommands

All Known Implementing Classes:

BlockingTransactionalJsonCommandsImpl

public interface TransactionalJsonCommands<K>
extends TransactionalRedisCommands

Method Summary

Modifier and Type	Method	Description
<T> void	jsonArrAppend(K key, String path, T... values)	Execute the command JSON.ARRAPPEND.
default <T> void	jsonArrIndex(K key, String path, T value)	Execute the command JSON.ARRINDEX.
<T> void	jsonArrIndex(K key, String path, T value, int start, int end)	Execute the command JSON.ARRINDEX.
<T> void	jsonArrInsert(K key, String path, int index, T... values)	Execute the command JSON.ARRINSERT.
void	jsonArrLen(K key, String path)	Execute the command JSON.ARRLEN.
default <T> void	jsonArrPop(K key, Class<T> clazz, String path)	Execute the command JSON.ARRPOP.
<T> void	jsonArrPop(K key, Class<T> clazz, String path, int index)	Execute the command JSON.ARRPOP.
void	jsonArrTrim(K key, String path, int start, int stop)	Execute the command JSON.ARRTRIM.
default void	jsonClear(K key)	Execute the command JSON.CLEAR.
void	jsonClear(K key, String path)	Execute the command JSON.CLEAR.
default void	jsonDel(K key)	Execute the command JSON.DEL.
void	jsonDel(K key, String path)	Execute the command JSON.DEL.
<T> void	jsonGet(K key, Class<T> clazz)	Execute the command JSON.GET.
void	jsonGet(K key, String path)	Execute the command JSON.GET.
void	jsonGet(K key, String... paths)	Execute the command JSON.GET.
void	jsonGetArray(K key)	Execute the command JSON.GET.
void	jsonGetObject(K key)	Execute the command JSON.GET.
void	jsonMget(String path, K... keys)	Execute the command JSON.MGET.
void	jsonNumincrby(K key, String path, double value)	Execute the command JSON.NUMINCRBY.
void	jsonObjKeys(K key, String path)	Execute the command JSON.OBJKEYS.
void	jsonObjLen(K key, String path)	Execute the command JSON.OBJLEN.
default void	jsonSet(K key, io.vertx.core.json.JsonArray json)	Execute the command JSON.SET.
default void	jsonSet(K key, io.vertx.core.json.JsonObject json)	Execute the command JSON.SET.
void	jsonSet(K key, String path, io.vertx.core.json.JsonArray json)	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	jsonSet(K key, String path, io.vertx.core.json.JsonObject json)	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	jsonSet(K key, String path, T value)	Execute the command JSON.SET.
<T> void	jsonSet(K key, String path, T value, JsonSetArgs args)	Execute the command JSON.SET.
default <T> void	jsonSet(K key, T value)	Execute the command JSON.SET.
void	jsonStrAppend(K key, String path, String value)	Execute the command JSON.STRAPPEND.
void	jsonStrLen(K key, String path)	Execute the command JSON.STRLEN.
void	jsonToggle(K key, String path)	Execute the command JSON.TOGGLE.
void	jsonType(K key, String path)	Execute the command JSON.TYPE.

Methods inherited from interface io.quarkus.redis.datasource.TransactionalRedisCommands

getDataSource

Method Detail

jsonSet

<T> void jsonSet(K key,
                 String path,
                 T value)

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 be null

path - the path, must not be null

value - the value, encoded to JSON

jsonSet

default <T> void jsonSet(K key,
                         T value)

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 be null

value - the value, encoded to JSON

jsonSet

void jsonSet(K key,
             String path,
             io.vertx.core.json.JsonObject json)

Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json

Parameters:

key - the key, must not be null

path - the path, must not be null

json - the JSON object to store, must not be null

jsonSet

default void jsonSet(K key,
                     io.vertx.core.json.JsonObject json)

Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json

This variant uses $ as path.

Parameters:

key - the key, must not be null

json - the JSON object to store, must not be null

jsonSet

default void jsonSet(K key,
                     io.vertx.core.json.JsonArray json)

Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json

Parameters:

key - the key, must not be null

json - the JSON array to store, must not be null

jsonSet

void jsonSet(K key,
             String path,
             io.vertx.core.json.JsonObject json,
             JsonSetArgs args)

Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json

Parameters:

key - the key, must not be null

path - the path, must not be null

json - the JSON object to store, must not be null

args - the extra arguments

jsonSet

void jsonSet(K key,
             String path,
             io.vertx.core.json.JsonArray json)

Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json

Parameters:

key - the key, must not be null

path - the path, must not be null

json - the JSON array to store, must not be null

jsonSet

void jsonSet(K key,
             String path,
             io.vertx.core.json.JsonArray json,
             JsonSetArgs args)

Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json

Parameters:

key - the key, must not be null

path - the path, must not be null

json - the JSON array to store, must not be null

args - the extra arguments

jsonSet

<T> void jsonSet(K key,
                 String path,
                 T value,
                 JsonSetArgs args)

Execute the command JSON.SET. Summary: Sets the JSON value at path in key. Group: json

Parameters:

key - the key, must not be null

path - the path, must not be null

value - the value to store, encoded to JSON.

args - the extra arguments

jsonGet

<T> void jsonGet(K key,
                 Class<T> clazz)

Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: json

This method uses the root path ($). It maps the retrieve JSON document to an object of type <T>.

Parameters:

key - the key, must not be null

clazz - the type of object to recreate from the JSON content

jsonGetObject

void jsonGetObject(K key)

Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: json

This method uses the root path ($). Unlike jsonGet(Object, Class), it returns a JsonObject.

Parameters:

key - the key, must not be null

jsonGetArray

void jsonGetArray(K key)

Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: json

This method uses the root path ($). Unlike jsonGet(Object, Class), it returns a JsonArray.

Parameters:

key - the key, must not be null

jsonGet

void jsonGet(K key,
             String path)

Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: json

Parameters:

key - the key, must not be null

path - the path, must not be null

jsonGet

void jsonGet(K key,
             String... paths)

Execute the command JSON.GET. Summary: Returns the value at path in JSON serialized form. Group: json

Parameters:

key - the key, must not be null

paths - the paths, must not be null. If no path are passed, this is equivalent to jsonGetObject(Object), if multiple paths are passed, the produced JSON object contains the result (as a json array) for each path.

jsonArrAppend

<T> void jsonArrAppend(K key,
                       String path,
                       T... values)

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 be null

path - the path, must not be null

values - the values to append, encoded to JSON

jsonArrIndex

<T> void jsonArrIndex(K key,
                      String path,
                      T value,
                      int start,
                      int end)

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 be null

path - the path, must not be null

value - the value to be searched, encoded to JSON

start - the start index

end - the end index

jsonArrIndex

default <T> void jsonArrIndex(K key,
                              String path,
                              T value)

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 be null

path - the path, must not be null

value - the value to be searched, encoded to JSON

jsonArrInsert

<T> void jsonArrInsert(K key,
                       String path,
                       int index,
                       T... values)

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 be null

path - the path, must not be null

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

jsonArrLen

void jsonArrLen(K key,
                String path)

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 be null

path - the path, null means $

jsonArrPop

<T> void jsonArrPop(K key,
                    Class<T> clazz,
                    String path,
                    int index)

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 be null

clazz - the type of the popped object

path - 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.

jsonArrPop

default <T> void jsonArrPop(K key,
                            Class<T> clazz,
                            String path)

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 be null

clazz - the type of the popped object

path - path the path, defaults to root if not provided.

jsonArrTrim

void jsonArrTrim(K key,
                 String path,
                 int start,
                 int stop)

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 be null

path - path the path, must not be null

start - the start index

stop - the stop index

jsonClear

void jsonClear(K key,
               String path)

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 be null

path - path the path, path defaults to $ if not provided. Non-existing paths are ignored.

jsonClear

default void jsonClear(K key)

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 be null

jsonDel

void jsonDel(K key,
             String path)

Execute the command JSON.DEL. Summary: Deletes a value. Group: json

Parameters:

key - the key, must not be null

path - path the path, path defaults to $ if not provided. Non-existing paths are ignored.

jsonDel

default void jsonDel(K key)

Execute the command JSON.DEL. Summary: Deletes a value. Group: json

Parameters:

key - the key, must not be null

jsonMget

void jsonMget(String path,
              K... keys)

Execute the command JSON.MGET. Summary: Returns the values at path from multiple key arguments. Returns null for nonexistent keys and nonexistent paths. Group: json

Parameters:

path - path the path

keys - the keys, must not be null, must not contain null

jsonNumincrby

void jsonNumincrby(K key,
                   String path,
                   double value)

Execute the command JSON.NUMINCRBY. Summary: Increments the number value stored at path by number. Group: json

Parameters:

key - the key, must not be null

path - path the path, path defaults to $ if not provided. Non-existing paths are ignored.

value - the value to add

jsonObjKeys

void jsonObjKeys(K key,
                 String path)

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 be null

path - path the path, path defaults to $ if not provided.

jsonObjLen

void jsonObjLen(K key,
                String path)

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 be null

path - path the path, path defaults to $ if not provided.

jsonStrAppend

void jsonStrAppend(K key,
                   String path,
                   String value)

Execute the command JSON.STRAPPEND. Summary: Appends the json-string values to the string at path. Group: json

Parameters:

key - the key, must not be null

path - path the path, path defaults to $ if not provided.

value - the string to append, must not be null

jsonStrLen

void jsonStrLen(K key,
                String path)

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 be null

path - path the path, path defaults to $ if not provided.

jsonToggle

void jsonToggle(K key,
                String path)

Execute the command JSON.TOGGLE. Summary: Toggle a boolean value stored at path. Group: json

Parameters:

key - the key, must not be null

path - path the path, must not be null

jsonType

void jsonType(K key,
              String path)

Execute the command JSON.TYPE. Summary: Reports the type of JSON value at path. Group: json

Parameters:

key - the key, must not be null

path - path the path, path defaults to $ if not provided.