Package io.quarkus.redis.datasource.json

Interface ReactiveTransactionalJsonCommands<K>

    • Method Detail

      • jsonSet

        <T> io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonSet

        io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonSet

        io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonSet

        io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonSet

        io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonSet

        <T> io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonGet

        <T> io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonGetObject

        io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonGetArray

        io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonGet

        io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonGet

        io.smallrye.mutiny.Uni<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.
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonArrAppend

        <T> io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonArrIndex

        <T> io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonArrIndex

        default <T> io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonArrInsert

        <T> io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonArrLen

        io.smallrye.mutiny.Uni<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 $
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonArrPop

        <T> io.smallrye.mutiny.Uni<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.
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonArrTrim

        io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonClear

        io.smallrye.mutiny.Uni<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.
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonClear

        default io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonDel

        io.smallrye.mutiny.Uni<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.
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonDel

        default io.smallrye.mutiny.Uni<Void> jsonDel​(K key)
        Execute the command JSON.DEL. Summary: Deletes a value. Group: json

        Parameters:
        key - the key, must not be null
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonMget

        io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonNumincrby

        io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonObjKeys

        io.smallrye.mutiny.Uni<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.
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonObjLen

        io.smallrye.mutiny.Uni<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.
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonStrAppend

        io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonStrLen

        io.smallrye.mutiny.Uni<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.
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonToggle

        io.smallrye.mutiny.Uni<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
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

      • jsonType

        io.smallrye.mutiny.Uni<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.
        Returns:
        A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.