io.quarkus.redis.datasource.json.ReactiveTransactionalJsonCommands Maven / Gradle / Ivy
Show all versions of quarkus-redis-client Show documentation
package io.quarkus.redis.datasource.json;
import io.quarkus.redis.datasource.ReactiveTransactionalRedisCommands;
import io.smallrye.mutiny.Uni;
import io.vertx.core.json.JsonArray;
import io.vertx.core.json.JsonObject;
public interface ReactiveTransactionalJsonCommands extends ReactiveTransactionalRedisCommands {
/**
* Execute the command JSON.SET.
* Summary: Sets the JSON value at path in key.
* Group: json
*
* @param key the key, must not be {@code null}
* @param path the path, must not be {@code null}
* @param value the value, encoded to JSON
* @param the type for the value
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonSet(K key, String path, T value);
/**
* Execute the command JSON.SET.
* Summary: Sets the JSON value at path in key.
* Group: json
*
* @param key the key, must not be {@code null}
* @param value the value, encoded to JSON
* @param the type for the value
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
**/
default Uni jsonSet(K key, T value) {
return jsonSet(key, "$", value);
}
/**
* Execute the command JSON.SET.
* Summary: Sets the JSON value at path in key.
* Group: json
*
* @param key the key, must not be {@code null}
* @param path the path, must not be {@code null}
* @param json the JSON object to store, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonSet(K key, String path, JsonObject json);
/**
* Execute the command JSON.SET.
* Summary: Sets the JSON value at path in key.
* Group: json
*
* @param key the key, must not be {@code null}
* @param path the path, must not be {@code null}
* @param json the JSON object to store, must not be {@code null}
* @param args the extra arguments
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonSet(K key, String path, JsonObject json, JsonSetArgs args);
/**
* Execute the command JSON.SET.
* Summary: Sets the JSON value at path in key.
* Group: json
*
* This variant uses {@code $} as path.
*
* @param key the key, must not be {@code null}
* @param json the JSON object to store, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
**/
default Uni jsonSet(K key, JsonObject json) {
return jsonSet(key, "$", json);
}
/**
* Execute the command JSON.SET.
* Summary: Sets the JSON value at path in key.
* Group: json
*
* @param key the key, must not be {@code null}
* @param path the path, must not be {@code null}
* @param json the JSON array to store, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonSet(K key, String path, JsonArray json);
/**
* Execute the command JSON.SET.
* Summary: Sets the JSON value at path in key.
* Group: json
*
* @param key the key, must not be {@code null}
* @param json the JSON array to store, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
**/
default Uni jsonSet(K key, JsonArray json) {
return jsonSet(key, "$", json);
}
/**
* Execute the command JSON.SET.
* Summary: Sets the JSON value at path in key.
* Group: json
*
* @param key the key, must not be {@code null}
* @param path the path, must not be {@code null}
* @param json the JSON array to store, must not be {@code null}
* @param args the extra arguments
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonSet(K key, String path, JsonArray json, JsonSetArgs args);
/**
* Execute the command JSON.SET.
* Summary: Sets the JSON value at path in key.
* Group: json
*
* @param key the key, must not be {@code null}
* @param path the path, must not be {@code null}
* @param value the value to store, encoded to JSON.
* @param args the extra arguments
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonSet(K key, String path, T value, JsonSetArgs args);
/**
* Execute the command JSON.GET.
* Summary: Returns the value at path in JSON serialized form.
* Group: json
*
* This method uses the root path ({@code $}).
* It maps the retrieve JSON document to an object of type {@code }.
*
* @param key the key, must not be {@code null}
* @param clazz the type of object to recreate from the JSON content
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonGet(K key, Class clazz);
/**
* Execute the command JSON.GET.
* Summary: Returns the value at path in JSON serialized form.
* Group: json
*
* This method uses the root path ({@code $}).
* Unlike {@link #jsonGet(Object, Class)}, it returns a {@link JsonObject}.
*
* @param key the key, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni 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 ({@code $}).
* Unlike {@link #jsonGet(Object, Class)}, it returns a {@link JsonArray}.
*
* @param key the key, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonGetArray(K key);
/**
* Execute the command JSON.GET.
* Summary: Returns the value at path in JSON serialized form.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path the path, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonGet(K key, String path);
/**
* Execute the command JSON.GET.
* Summary: Returns the value at path in JSON serialized form.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param paths the paths, must not be {@code null}. If no path are passed, this is equivalent to
* {@link #jsonGetObject(Object)},
* if multiple paths are passed, the produced JSON object contains the result (as a json array) for each path.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonGet(K key, String... paths);
/**
* Execute the command JSON.ARRAPPEND.
* Summary: Append the json values into the array at path after the last element in it.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path the path, must not be {@code null}
* @param values the values to append, encoded to JSON
* @param the type of value
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonArrAppend(K key, String path, T... values);
/**
* Execute the command JSON.ARRINDEX.
* Summary: Searches for the first occurrence of a scalar JSON value in an array.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path the path, must not be {@code null}
* @param value the value to be searched, encoded to JSON
* @param start the start index
* @param end the end index
* @param the type of value
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni 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
*
*
* @param key the key, must not be {@code null}
* @param path the path, must not be {@code null}
* @param value the value to be searched, encoded to JSON
* @param the type of value
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
default Uni jsonArrIndex(K key, String path, T value) {
return jsonArrIndex(key, path, value, 0, 0);
}
/**
* Execute the command JSON.ARRINSERT.
* Summary: Inserts the json values into the array at path before the index (shifts to the right).
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path the path, must not be {@code null}
* @param 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.
* @param values the values to insert, encoded to JSON
* @param the type of value
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonArrInsert(K key, String path, int index, T... values);
/**
* Execute the command JSON.ARRLEN.
* Summary: Reports the length of the JSON Array at path in key.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path the path, {@code null} means {@code $}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonArrLen(K key, String path);
/**
* Execute the command JSON.ARRPOP.
* Summary: Removes and returns an element from the index in the array.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param clazz the type of the popped object
* @param path path the path, defaults to root if not provided.
* @param 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.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonArrPop(K key, Class clazz, String path, int index);
/**
* Execute the command JSON.ARRPOP.
* Summary: Removes and returns an element from the index in the array.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param clazz the type of the popped object
* @param path path the path, defaults to root if not provided.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
**/
default Uni jsonArrPop(K key, Class clazz, String path) {
return jsonArrPop(key, clazz, path, -1);
}
/**
* Execute the command JSON.ARRTRIM.
* Summary: Trims an array so that it contains only the specified inclusive range of elements.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path path the path, must not be {@code null}
* @param start the start index
* @param stop the stop index
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonArrTrim(K key, String path, int start, int stop);
/**
* Execute the command JSON.CLEAR.
* Summary: Clears container values (Arrays/Objects), and sets numeric values to 0.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path path the path, path defaults to {@code $} if not provided. Non-existing paths are ignored.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonClear(K key, String path);
/**
* Execute the command JSON.CLEAR.
* Summary: Clears container values (Arrays/Objects), and sets numeric values to 0.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
default Uni jsonClear(K key) {
return jsonClear(key, null);
}
/**
* Execute the command JSON.DEL.
* Summary: Deletes a value.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path path the path, path defaults to {@code $} if not provided. Non-existing paths are ignored.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonDel(K key, String path);
/**
* Execute the command JSON.DEL.
* Summary: Deletes a value.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
default Uni jsonDel(K key) {
return jsonDel(key, null);
}
/**
* Execute the command JSON.MGET.
* Summary: Returns the values at path from multiple key arguments. Returns {@code null} for nonexistent keys
* and nonexistent paths.
* Group: json
*
*
* @param path path the path
* @param keys the keys, must not be {@code null}, must not contain {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonMget(String path, K... keys);
/**
* Execute the command JSON.NUMINCRBY.
* Summary: Increments the number value stored at path by number.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path path the path, path defaults to {@code $} if not provided. Non-existing paths are ignored.
* @param value the value to add
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonNumincrby(K key, String path, double value);
/**
* Execute the command JSON.OBJKEYS.
* Summary: Returns the keys in the object that's referenced by path.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path path the path, path defaults to {@code $} if not provided.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonObjKeys(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
*
*
* @param key the key, must not be {@code null}
* @param path path the path, path defaults to {@code $} if not provided.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonObjLen(K key, String path);
/**
* Execute the command JSON.STRAPPEND.
* Summary: Appends the json-string values to the string at path.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path path the path, path defaults to {@code $} if not provided.
* @param value the string to append, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonStrAppend(K key, String path, String value);
/**
* Execute the command JSON.STRLEN.
* Summary: Reports the length of the JSON String at path in key.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path path the path, path defaults to {@code $} if not provided.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonStrLen(K key, String path);
/**
* Execute the command JSON.TOGGLE.
* Summary: Toggle a boolean value stored at path.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path path the path, must not be {@code null}
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonToggle(K key, String path);
/**
* Execute the command JSON.TYPE.
* Summary: Reports the type of JSON value at path.
* Group: json
*
*
* @param key the key, must not be {@code null}
* @param path path the path, path defaults to {@code $} if not provided.
* @return A {@code Uni} emitting {@code null} when the command has been enqueued successfully in the transaction, a failure
* otherwise. In the case of failure, the transaction is discarded.
*/
Uni jsonType(K key, String path);
}