io.lettuce.core.cluster.api.sync

Interface NodeSelectionJsonCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

public interface NodeSelectionJsonCommands<K,V>

Synchronous executed commands on a node selection for JSON documents

Since:

6.5

Author:

Tihomir Mateev

See Also:

Redis JSON

Generated class:

by io.lettuce.apigenerator.CreateSyncNodeSelectionClusterApi

Method Summary

Modifier and Type	Method and Description
Executions<List<Long>>	jsonArrappend(K key, JsonPath jsonPath, JsonValue... values) Append the JSON values into the array at a given JsonPath after the last element in a said array.
Executions<List<Long>>	jsonArrappend(K key, JsonValue... values) Append the JSON values into the array at the JsonPath.ROOT_PATH after the last element in a said array.
Executions<List<Long>>	jsonArrindex(K key, JsonPath jsonPath, JsonValue value) Search for the first occurrence of a JsonValue in an array at a given JsonPath and return its index.
Executions<List<Long>>	jsonArrindex(K key, JsonPath jsonPath, JsonValue value, JsonRangeArgs range) Search for the first occurrence of a JsonValue in an array at a given JsonPath and return its index.
Executions<List<Long>>	jsonArrinsert(K key, JsonPath jsonPath, int index, JsonValue... values) Insert the JsonValues into the array at a given JsonPath before the provided index, shifting the existing elements to the right
Executions<List<Long>>	jsonArrlen(K key) Report the length of the JSON array at a the JsonPath.ROOT_PATH
Executions<List<Long>>	jsonArrlen(K key, JsonPath jsonPath) Report the length of the JSON array at a given JsonPath
Executions<List<JsonValue>>	jsonArrpop(K key) Remove and return JsonValue at index -1 (last element) in the array at the JsonPath.ROOT_PATH
Executions<List<JsonValue>>	jsonArrpop(K key, JsonPath jsonPath) Remove and return JsonValue at index -1 (last element) in the array at a given JsonPath
Executions<List<JsonValue>>	jsonArrpop(K key, JsonPath jsonPath, int index) Remove and return JsonValue at a given index in the array at a given JsonPath
Executions<List<Long>>	jsonArrtrim(K key, JsonPath jsonPath, JsonRangeArgs range) Trim an array at a given JsonPath so that it contains only the specified inclusive range of elements.
Executions<Long>	jsonClear(K key) Clear container values (arrays/objects) and set numeric values to 0 at the JsonPath.ROOT_PATH
Executions<Long>	jsonClear(K key, JsonPath jsonPath) Clear container values (arrays/objects) and set numeric values to 0
Executions<Long>	jsonDel(K key) Deletes a value inside the JSON document at the JsonPath.ROOT_PATH
Executions<Long>	jsonDel(K key, JsonPath jsonPath) Deletes a value inside the JSON document at a given JsonPath
Executions<List<JsonValue>>	jsonGet(K key, JsonGetArgs options, JsonPath... jsonPaths) Return the value at the specified path in JSON serialized form.
Executions<List<JsonValue>>	jsonGet(K key, JsonPath... jsonPaths) Return the value at the specified path in JSON serialized form.
Executions<String>	jsonMerge(K key, JsonPath jsonPath, JsonValue value) Merge a given JsonValue with the value matching JsonPath.
Executions<List<JsonValue>>	jsonMGet(JsonPath jsonPath, K... keys) Return the values at the specified path from multiple key arguments.
Executions<String>	jsonMSet(List<JsonMsetArgs<K,V>> arguments) Set or update one or more JSON values according to the specified JsonMsetArgs JSON.MSET is atomic, hence, all given additions or updates are either applied or not.
Executions<List<Number>>	jsonNumincrby(K key, JsonPath jsonPath, Number number) Increment the number value stored at the specified JsonPath in the JSON document by the provided increment.
Executions<List<V>>	jsonObjkeys(K key) Return the keys in the JSON document that are referenced by the JsonPath.ROOT_PATH
Executions<List<V>>	jsonObjkeys(K key, JsonPath jsonPath) Return the keys in the JSON document that are referenced by the given JsonPath
Executions<List<Long>>	jsonObjlen(K key) Report the number of keys in the JSON object at the JsonPath.ROOT_PATH and for the provided key
Executions<List<Long>>	jsonObjlen(K key, JsonPath jsonPath) Report the number of keys in the JSON object at the specified JsonPath and for the provided key
Executions<String>	jsonSet(K key, JsonPath jsonPath, JsonValue value) Sets the JSON value at a given JsonPath in the JSON document using defaults for the JsonSetArgs.
Executions<String>	jsonSet(K key, JsonPath jsonPath, JsonValue value, JsonSetArgs options) Sets the JSON value at a given JsonPath in the JSON document.
Executions<List<Long>>	jsonStrappend(K key, JsonPath jsonPath, JsonValue value) Append the json-string values to the string at the provided JsonPath in the JSON document.
Executions<List<Long>>	jsonStrappend(K key, JsonValue value) Append the json-string values to the string at the JsonPath.ROOT_PATH in the JSON document.
Executions<List<Long>>	jsonStrlen(K key) Report the length of the JSON String at the JsonPath.ROOT_PATH in the JSON document.
Executions<List<Long>>	jsonStrlen(K key, JsonPath jsonPath) Report the length of the JSON String at the provided JsonPath in the JSON document.
Executions<List<Long>>	jsonToggle(K key, JsonPath jsonPath) Toggle a Boolean value stored at the provided JsonPath in the JSON document.
Executions<List<JsonType>>	jsonType(K key) Report the type of JSON value at the JsonPath.ROOT_PATH in the JSON document.
Executions<List<JsonType>>	jsonType(K key, JsonPath jsonPath) Report the type of JSON value at the provided JsonPath in the JSON document.

Method Detail

jsonArrappend

Executions<List<Long>> jsonArrappend(K key,
                                     JsonPath jsonPath,
                                     JsonValue... values)

Append the JSON values into the array at a given JsonPath after the last element in a said array.

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the array inside the document.

values - one or more JsonValue to be appended.

Returns:

Long the resulting size of the arrays after the new data was appended, or null if the path does not exist.

Since:

6.5

jsonArrappend

Executions<List<Long>> jsonArrappend(K key,
                                     JsonValue... values)

Append the JSON values into the array at the JsonPath.ROOT_PATH after the last element in a said array.

Parameters:

key - the key holding the JSON document.

values - one or more JsonValue to be appended.

Returns:

Long the resulting size of the arrays after the new data was appended, or null if the path does not exist.

Since:

6.5

jsonArrindex

Executions<List<Long>> jsonArrindex(K key,
                                    JsonPath jsonPath,
                                    JsonValue value,
                                    JsonRangeArgs range)

Search for the first occurrence of a JsonValue in an array at a given JsonPath and return its index.

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the array inside the document.

value - the JsonValue to search for.

range - the JsonRangeArgs to search within.

Returns:

Long the index hosting the searched element, -1 if not found or null if the specified path is not an array.

Since:

6.5

jsonArrindex

Executions<List<Long>> jsonArrindex(K key,
                                    JsonPath jsonPath,
                                    JsonValue value)

Search for the first occurrence of a JsonValue in an array at a given JsonPath and return its index. This method uses defaults for the start and end indexes, see JsonRangeArgs.DEFAULT_START_INDEX and JsonRangeArgs.DEFAULT_END_INDEX.

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the array inside the document.

value - the JsonValue to search for.

Returns:

Long the index hosting the searched element, -1 if not found or null if the specified path is not an array.

Since:

6.5

jsonArrinsert

Executions<List<Long>> jsonArrinsert(K key,
                                     JsonPath jsonPath,
                                     int index,
                                     JsonValue... values)

Insert the JsonValues into the array at a given JsonPath before the provided index, shifting the existing elements to the right

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the array inside the document.

index - the index before which the new elements will be inserted.

values - one or more JsonValues to be inserted.

Returns:

Long the resulting size of the arrays after the new data was inserted, or null if the path does not exist.

Since:

6.5

jsonArrlen

Executions<List<Long>> jsonArrlen(K key,
                                  JsonPath jsonPath)

Report the length of the JSON array at a given JsonPath

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the array inside the document.

Returns:

the size of the arrays, or null if the path does not exist.

Since:

6.5

jsonArrlen

Executions<List<Long>> jsonArrlen(K key)

Report the length of the JSON array at a the JsonPath.ROOT_PATH

Parameters:

key - the key holding the JSON document.

Returns:

the size of the arrays, or null if the path does not exist.

Since:

6.5

jsonArrpop

Executions<List<JsonValue>> jsonArrpop(K key,
                                       JsonPath jsonPath,
                                       int index)

Remove and return JsonValue at a given index in the array at a given JsonPath

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the array inside the document.

index - the index of the element to be removed. Default is -1, meaning the last element. Out-of-range indexes round to their respective array ends. Popping an empty array returns null.

Returns:

List the removed element, or null if the specified path is not an array.

Since:

6.5

jsonArrpop

Executions<List<JsonValue>> jsonArrpop(K key,
                                       JsonPath jsonPath)

Remove and return JsonValue at index -1 (last element) in the array at a given JsonPath

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the array inside the document.

Returns:

List the removed element, or null if the specified path is not an array.

Since:

6.5

jsonArrpop

Executions<List<JsonValue>> jsonArrpop(K key)

Remove and return JsonValue at index -1 (last element) in the array at the JsonPath.ROOT_PATH

Parameters:

key - the key holding the JSON document.

Returns:

List the removed element, or null if the specified path is not an array.

Since:

6.5

jsonArrtrim

Executions<List<Long>> jsonArrtrim(K key,
                                   JsonPath jsonPath,
                                   JsonRangeArgs range)

Trim an array at a given JsonPath so that it contains only the specified inclusive range of elements. All elements with indexes smaller than the start range and all elements with indexes bigger than the end range are trimmed.

Behavior as of RedisJSON v2.0:

• If start is larger than the array's size or start > stop, returns 0 and an empty array.
• If start is < 0, then start from the end of the array.
• If stop is larger than the end of the array, it is treated like the last element.

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the array inside the document.

range - the JsonRangeArgs to trim by.

Returns:

Long the resulting size of the arrays after the trimming, or null if the path does not exist.

Since:

6.5

jsonClear

Executions<Long> jsonClear(K key,
                           JsonPath jsonPath)

Clear container values (arrays/objects) and set numeric values to 0

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the value to clear.

Returns:

Long the number of values removed plus all the matching JSON numerical values that are zeroed.

Since:

6.5

jsonClear

Executions<Long> jsonClear(K key)

Clear container values (arrays/objects) and set numeric values to 0 at the JsonPath.ROOT_PATH

Parameters:

key - the key holding the JSON document.

Returns:

Long the number of values removed plus all the matching JSON numerical values that are zeroed.

Since:

6.5

jsonDel

Executions<Long> jsonDel(K key,
                         JsonPath jsonPath)

Deletes a value inside the JSON document at a given JsonPath

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the value to clear.

Returns:

Long the number of values removed (0 or more).

Since:

6.5

jsonDel

Executions<Long> jsonDel(K key)

Deletes a value inside the JSON document at the JsonPath.ROOT_PATH

Parameters:

key - the key holding the JSON document.

Returns:

Long the number of values removed (0 or more).

Since:

6.5

jsonGet

Executions<List<JsonValue>> jsonGet(K key,
                                    JsonGetArgs options,
                                    JsonPath... jsonPaths)

Return the value at the specified path in JSON serialized form.

When using a single JSONPath, the root of the matching values is a JSON string with a top-level array of serialized JSON value. In contrast, a legacy path returns a single value.

When using multiple JSONPath arguments, the root of the matching values is a JSON string with a top-level object, with each object value being a top-level array of serialized JSON value. In contrast, if all paths are legacy paths, each object value is a single serialized JSON value. If there are multiple paths that include both legacy path and JSONPath, the returned value conforms to the JSONPath version (an array of values).

Parameters:

key - the key holding the JSON document.

options - the JsonGetArgs to use.

jsonPaths - the JsonPaths to use to identify the values to get.

Returns:

JsonValue the value at path in JSON serialized form, or null if the path does not exist.

Since:

6.5

jsonGet

Executions<List<JsonValue>> jsonGet(K key,
                                    JsonPath... jsonPaths)

Return the value at the specified path in JSON serialized form. Uses defaults for the JsonGetArgs.

When using a single JSONPath, the root of the matching values is a JSON string with a top-level array of serialized JSON value. In contrast, a legacy path returns a single value.

When using multiple JSONPath arguments, the root of the matching values is a JSON string with a top-level object, with each object value being a top-level array of serialized JSON value. In contrast, if all paths are legacy paths, each object value is a single serialized JSON value. If there are multiple paths that include both legacy path and JSONPath, the returned value conforms to the JSONPath version (an array of values).

Parameters:

key - the key holding the JSON document.

jsonPaths - the JsonPaths to use to identify the values to get.

Returns:

JsonValue the value at path in JSON serialized form, or null if the path does not exist.

Since:

6.5

jsonMerge

Executions<String> jsonMerge(K key,
                             JsonPath jsonPath,
                             JsonValue value)

Merge a given JsonValue with the value matching JsonPath. Consequently, JSON values at matching paths are updated, deleted, or expanded with new children.

Merging is done according to the following rules per JSON value in the value argument while considering the corresponding original value if it exists:

• merging an existing object key with a null value deletes the key
• merging an existing object key with non-null value updates the value
• merging a non-existing object key adds the key and value
• merging an existing array with any merged value, replaces the entire array with the value

This command complies with RFC7396 "Json Merge Patch"

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the value to merge.

value - the JsonValue to merge.

Returns:

String "OK" if the set was successful, error if the operation failed.

Since:

6.5

See Also:

RFC7396

jsonMGet

Executions<List<JsonValue>> jsonMGet(JsonPath jsonPath,
                                     K... keys)

Return the values at the specified path from multiple key arguments.

Parameters:

jsonPath - the JsonPath pointing to the value to fetch.

keys - the keys holding the JsonValues to fetch.

Returns:

List the values at path, or null if the path does not exist.

Since:

6.5

jsonMSet

Executions<String> jsonMSet(List<JsonMsetArgs<K,V>> arguments)

Set or update one or more JSON values according to the specified JsonMsetArgs

JSON.MSET is atomic, hence, all given additions or updates are either applied or not. It is not possible for clients to see that some keys were updated while others are unchanged.

A JSON value is a hierarchical structure. If you change a value in a specific path - nested values are affected.

Parameters:

arguments - the JsonMsetArgs specifying the values to change.

Returns:

"OK" if the operation was successful, error otherwise

Since:

6.5

jsonNumincrby

Executions<List<Number>> jsonNumincrby(K key,
                                       JsonPath jsonPath,
                                       Number number)

Increment the number value stored at the specified JsonPath in the JSON document by the provided increment.

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the value to increment.

number - the increment value.

Returns:

a List of the new values after the increment.

Since:

6.5

jsonObjkeys

Executions<List<V>> jsonObjkeys(K key,
                                JsonPath jsonPath)

Return the keys in the JSON document that are referenced by the given JsonPath

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the value(s) whose key(s) we want.

Returns:

List the keys in the JSON document that are referenced by the given JsonPath.

Since:

6.5

jsonObjkeys

Executions<List<V>> jsonObjkeys(K key)

Return the keys in the JSON document that are referenced by the JsonPath.ROOT_PATH

Parameters:

key - the key holding the JSON document.

Returns:

List the keys in the JSON document that are referenced by the given JsonPath.

Since:

6.5

jsonObjlen

Executions<List<Long>> jsonObjlen(K key,
                                  JsonPath jsonPath)

Report the number of keys in the JSON object at the specified JsonPath and for the provided key

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the value(s) whose key(s) we want to count

Returns:

Long the number of keys in the JSON object at the specified path, or null if the path does not exist.

Since:

6.5

jsonObjlen

Executions<List<Long>> jsonObjlen(K key)

Report the number of keys in the JSON object at the JsonPath.ROOT_PATH and for the provided key

Parameters:

key - the key holding the JSON document.

Returns:

Long the number of keys in the JSON object at the specified path, or null if the path does not exist.

Since:

6.5

jsonSet

Executions<String> jsonSet(K key,
                           JsonPath jsonPath,
                           JsonValue value,
                           JsonSetArgs options)

Sets the JSON value at a given JsonPath in the JSON document.

For new Redis keys, the path must be the root. For existing keys, when the entire path exists, the value that it contains is replaced with the JSON value. For existing keys, when the path exists, except for the last element, a new child is added with the JSON value.

Adds a key (with its respective value) to a JSON Object (in a RedisJSON data type key) only if it is the last child in the path, or it is the parent of a new child being added in the path. Optional arguments NX and XX modify this behavior for both new RedisJSON data type keys and the JSON Object keys in them.

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the value(s) where we want to set the value.

value - the JsonValue to set.

options - the JsonSetArgs the options for setting the value.

Returns:

String "OK" if the set was successful, null if the JsonSetArgs conditions are not met.

Since:

6.5

jsonSet

Executions<String> jsonSet(K key,
                           JsonPath jsonPath,
                           JsonValue value)

Sets the JSON value at a given JsonPath in the JSON document using defaults for the JsonSetArgs.

For new Redis keys the path must be the root. For existing keys, when the entire path exists, the value that it contains is replaced with the JSON value. For existing keys, when the path exists, except for the last element, a new child is added with the JSON value.

Adds a key (with its respective value) to a JSON Object (in a RedisJSON data type key) only if it is the last child in the path, or it is the parent of a new child being added in the path. Optional arguments NX and XX modify this behavior for both new RedisJSON data type keys and the JSON Object keys in them.

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the value(s) where we want to set the value.

value - the JsonValue to set.

Returns:

String "OK" if the set was successful, null if the JsonSetArgs conditions are not met.

Since:

6.5

jsonStrappend

Executions<List<Long>> jsonStrappend(K key,
                                     JsonPath jsonPath,
                                     JsonValue value)

Append the json-string values to the string at the provided JsonPath in the JSON document.

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the value(s) where we want to append the value.

value - the JsonValue to append.

Returns:

Long the new length of the string, or null if the matching JSON value is not a string.

Since:

6.5

jsonStrappend

Executions<List<Long>> jsonStrappend(K key,
                                     JsonValue value)

Append the json-string values to the string at the JsonPath.ROOT_PATH in the JSON document.

Parameters:

key - the key holding the JSON document.

value - the JsonValue to append.

Returns:

Long the new length of the string, or null if the matching JSON value is not a string.

Since:

6.5

jsonStrlen

Executions<List<Long>> jsonStrlen(K key,
                                  JsonPath jsonPath)

Report the length of the JSON String at the provided JsonPath in the JSON document.

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the value(s).

Returns:

Long (in recursive descent) the length of the JSON String at the provided JsonPath, or null if the value ath the desired path is not a string.

Since:

6.5

jsonStrlen

Executions<List<Long>> jsonStrlen(K key)

Report the length of the JSON String at the JsonPath.ROOT_PATH in the JSON document.

Parameters:

key - the key holding the JSON document.

Returns:

Long (in recursive descent) the length of the JSON String at the provided JsonPath, or null if the value ath the desired path is not a string.

Since:

6.5

jsonToggle

Executions<List<Long>> jsonToggle(K key,
                                  JsonPath jsonPath)

Toggle a Boolean value stored at the provided JsonPath in the JSON document.

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the value(s).

Returns:

List the new value after the toggle, 0 for false, 1 for true or null if the path does not exist.

Since:

6.5

jsonType

Executions<List<JsonType>> jsonType(K key,
                                    JsonPath jsonPath)

Report the type of JSON value at the provided JsonPath in the JSON document.

Parameters:

key - the key holding the JSON document.

jsonPath - the JsonPath pointing to the value(s).

Returns:

List the type of JSON value at the provided JsonPath

Since:

6.5

jsonType

Executions<List<JsonType>> jsonType(K key)

Report the type of JSON value at the JsonPath.ROOT_PATH in the JSON document.

Parameters:

key - the key holding the JSON document.

Returns:

List the type of JSON value at the provided JsonPath

Since:

6.5