Interface RedisJsonCommands

All Known Subinterfaces:

DefaultedRedisClusterConnection, DefaultedRedisConnection, RedisClusterConnection, RedisCommands, RedisConnection, RedisConnectionUtils.RedisConnectionProxy, StringRedisConnection

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection

@NullUnmarked
public interface RedisJsonCommands

JSON commands supported by Redis.

Many methods in this interface return a List rather than a single value. This is because JSONPath expressions can match multiple values within a document, and each match produces its own result. For example, given the following document stored at key user:1:

{
  "groups": [
    { "name": "admins",  "roles": ["read", "write", "delete"] },
    { "name": "editors", "roles": ["read", "write"] },
    { "name": "viewers", "roles": ["read"] }
  ]
}

Calling JSON.ARRINDEX user:1 $.groups[*].roles "write" returns:

[1, 1, -1]

The path $.groups[*].roles matches three arrays, so the result contains one entry per match: index 1 for the first two arrays (where "write" appears at position 1) and -1 for the third array (where "write" is not found).

Since:

4.2

Author:

Yordan Tsintsov, Mark Paluch

See Also:

• RedisCommands

Method Summary

Modifier and Type	Method	Description
List<Long>	jsonArrAppend(byte @NonNull [] key, @NonNull JsonPath path, @NonNull JsonValue @NonNull ... values)	Append the JSON value into the array at JsonPath after the last element in it.
List<Long>	jsonArrIndex(byte @NonNull [] key, @NonNull JsonPath path, @NonNull JsonValue value)	Search for the first occurrence of a JSON value in an array.
List<Long>	jsonArrInsert(byte @NonNull [] key, @NonNull JsonPath path, int index, @NonNull JsonValue @NonNull ... values)	Insert the JSON value into the array at JsonPath before index.
List<Long>	jsonArrLen(byte @NonNull [] key, @NonNull JsonPath path)	Get the length of the array at the given path.
List<Long>	jsonArrTrim(byte @NonNull [] key, @NonNull JsonPath path, int start, int stop)	Trim an array so that it contains only the specified inclusive range of elements.
default Long	jsonClear(byte @NonNull [] key)	Clear container values (arrays/objects) and set numeric values to 0 at the root path of the given key.
Long	jsonClear(byte @NonNull [] key, @NonNull JsonPath path)	Clear container values (arrays/objects) and set numeric values to 0 at the given key and path.
default Long	jsonDel(byte @NonNull [] key)	Delete the JSON value at the root path of the given key.
Long	jsonDel(byte @NonNull [] key, @NonNull JsonPath path)	Delete the JSON value at the given key and path.
default byte[]	jsonGet(byte @NonNull [] key)	Get the JSON value at the root path of the given key.
byte[]	jsonGet(byte @NonNull [] key, @NonNull JsonPath @NonNull ... paths)	Get the JSON values at the given key and paths.
Boolean	jsonMerge(byte @NonNull [] key, @NonNull JsonPath path, @NonNull JsonValue value)	Merge the JSON value at the given key and path.
default Boolean	jsonMerge(byte @NonNull [] key, @NonNull JsonValue value)	Merge the JSON value at the root path of the given key.
default List<byte[]>	jsonMGet(byte @NonNull [] @NonNull ... keys)	Get the JSON values at the root path of the given keys.
List<byte[]>	jsonMGet(@NonNull JsonPath path, byte @NonNull [] @NonNull ... keys)	Get the JSON values at the given path for the given keys.
Boolean	jsonSet(byte @NonNull [] key, @NonNull JsonPath path, @NonNull JsonValue value, @NonNull JsonSetCondition condition)	Set the JSON value at the given key and path.
default Boolean	jsonSet(byte @NonNull [] key, @NonNull JsonValue value)	Set the JSON value at the root path of the given key.
List<Long>	jsonStrAppend(byte @NonNull [] key, @NonNull JsonPath path, @NonNull String value)	Append a string value to the JSON string at the given path.
List<Long>	jsonStrLen(byte @NonNull [] key, @NonNull JsonPath path)	Get the length of the JSON string value at the given path.
List<Boolean>	jsonToggle(byte @NonNull [] key, @NonNull JsonPath path)	Toggle boolean values at the given key and path.
default List<JsonType>	jsonType(byte @NonNull [] key)	Get the JSON type at the root path of the given key.
List<JsonType>	jsonType(byte @NonNull [] key, @NonNull JsonPath path)	Get the JSON type at the given key and path.

Method Details

jsonArrAppend

List<Long> jsonArrAppend(byte @NonNull [] key,
 @NonNull JsonPath path,
 @NonNull JsonValue @NonNull ... values)

Append the JSON value into the array at JsonPath after the last element in it.

Parameters:

key - must not be null.

path - must not be null.

values - must not be null.

Returns:

a list where each element contains the new length of the array or null if the matched value is not an array. Returns an empty list if the path does not match any value.

See Also:

• Redis Documentation: JSON.ARRAPPEND

jsonArrIndex

List<Long> jsonArrIndex(byte @NonNull [] key,
 @NonNull JsonPath path,
 @NonNull JsonValue value)

Search for the first occurrence of a JSON value in an array.

Parameters:

key - must not be null.

path - must not be null.

value - must not be null.

Returns:

a list where each element contains the index of the first occurrence of the value, -1 if not found, or null if the matched value is not an array. Returns an empty list if the path does not match any value.

See Also:

• Redis Documentation: JSON.ARRINDEX

jsonArrInsert

List<Long> jsonArrInsert(byte @NonNull [] key,
 @NonNull JsonPath path,
 int index,
 @NonNull JsonValue @NonNull ... values)

Insert the JSON value into the array at JsonPath before index.

Parameters:

key - must not be null.

path - must not be null.

index - to insert before.

values - must not be null.

Returns:

a list where each element contains the new length of the array after the insertion or null if the matched value is not an array. Returns an empty list if the path does not match any value.

See Also:

• Redis Documentation: JSON.ARRINSERT

jsonArrLen

List<Long> jsonArrLen(byte @NonNull [] key,
 @NonNull JsonPath path)

Get the length of the array at the given path.

Parameters:

key - must not be null.

path - must not be null.

Returns:

a list where each element contains the length of the array or null if the matched value is not an array. Returns an empty list if the path does not match any value.

See Also:

• Redis Documentation: JSON.ARRLEN

jsonArrTrim

List<Long> jsonArrTrim(byte @NonNull [] key,
 @NonNull JsonPath path,
 int start,
 int stop)

Trim an array so that it contains only the specified inclusive range of elements.

Parameters:

key - must not be null.

path - must not be null.

start - index to start trimming from (inclusive).

stop - index to stop trimming at (inclusive).

Returns:

a list where each element contains the length of the array after the trim or null if the matched value is not an array. Returns an empty list if the path does not match any value.

See Also:

• Redis Documentation: JSON.ARRTRIM

jsonClear

default Long jsonClear(byte @NonNull [] key)

Clear container values (arrays/objects) and set numeric values to 0 at the root path of the given key.

Parameters:

key - must not be null.

Returns:

the number of paths cleared.

See Also:

• Redis Documentation: JSON.CLEAR

jsonClear

Long jsonClear(byte @NonNull [] key,
 @NonNull JsonPath path)

Clear container values (arrays/objects) and set numeric values to 0 at the given key and path.

Parameters:

key - must not be null.

path - must not be null.

Returns:

the number of paths cleared.

See Also:

• Redis Documentation: JSON.CLEAR

jsonDel

default Long jsonDel(byte @NonNull [] key)

Delete the JSON value at the root path of the given key.

Parameters:

key - must not be null.

Returns:

the number of paths deleted.

See Also:

• Redis Documentation: JSON.DEL
• JsonPath.root()

jsonDel

Long jsonDel(byte @NonNull [] key,
 @NonNull JsonPath path)

Delete the JSON value at the given key and path.

Parameters:

key - must not be null.

path - must not be null.

Returns:

the number of paths deleted.

See Also:

• Redis Documentation: JSON.DEL

jsonGet

default byte[] jsonGet(byte @NonNull [] key)

Get the JSON value at the root path of the given key.

Parameters:

key - must not be null.

Returns:

a JSON-serialized byte array.

See Also:

• Redis Documentation: JSON.GET
• JsonPath.root()

jsonGet

byte[] jsonGet(byte @NonNull [] key,
 @NonNull JsonPath @NonNull ... paths)

Get the JSON values at the given key and paths.

Parameters:

key - must not be null.

paths - must not be null.

Returns:

a JSON-serialized byte array. When a single path is given, returns the value at that path. When multiple paths are given, returns a JSON object with each path as a key. Returns null if the key does not exist.

See Also:

• Redis Documentation: JSON.GET

jsonMerge

default Boolean jsonMerge(byte @NonNull [] key,
 @NonNull JsonValue value)

Merge the JSON value at the root path of the given key.

Parameters:

key - must not be null.

value - must not be null.

Returns:

true if the key was merged, false otherwise.

See Also:

• Redis Documentation: JSON.MERGE

jsonMerge

Boolean jsonMerge(byte @NonNull [] key,
 @NonNull JsonPath path,
 @NonNull JsonValue value)

Merge the JSON value at the given key and path.

Parameters:

key - must not be null.

path - must not be null.

value - must not be null.

Returns:

true if the key was merged, false otherwise.

See Also:

• Redis Documentation: JSON.MERGE

jsonMGet

default List<byte[]> jsonMGet(byte @NonNull [] @NonNull ... keys)

Get the JSON values at the root path of the given keys.

Parameters:

keys - must not be null.

Returns:

list of root JSON values.

See Also:

• Redis Documentation: JSON.MGET
• JsonPath.root()

jsonMGet

List<byte[]> jsonMGet(@NonNull JsonPath path,
 byte @NonNull [] @NonNull ... keys)

Get the JSON values at the given path for the given keys.

Parameters:

path - must not be null.

keys - must not be null.

Returns:

list of JSON values.

See Also:

• Redis Documentation: JSON.MGET

jsonSet

default Boolean jsonSet(byte @NonNull [] key,
 @NonNull JsonValue value)

Set the JSON value at the root path of the given key.

Parameters:

key - must not be null.

value - must not be null.

Returns:

true if the key was set, false otherwise.

See Also:

• Redis Documentation: JSON.SET

jsonSet

Boolean jsonSet(byte @NonNull [] key,
 @NonNull JsonPath path,
 @NonNull JsonValue value,
 @NonNull JsonSetCondition condition)

Set the JSON value at the given key and path.

Parameters:

key - must not be null.

path - must not be null.

value - must not be null.

condition - must not be null.

Returns:

true if the key was set, false otherwise.

See Also:

• Redis Documentation: JSON.SET

jsonStrAppend

List<Long> jsonStrAppend(byte @NonNull [] key,
 @NonNull JsonPath path,
 @NonNull String value)

Append a string value to the JSON string at the given path.

Parameters:

key - must not be null.

path - must not be null.

value - the plain string value, must not be null.

Returns:

a list where each element is the new string length or null if the matched value is not a string. Returns an empty list if the path does not match any value.

See Also:

• Redis Documentation: JSON.STRAPPEND

jsonStrLen

List<Long> jsonStrLen(byte @NonNull [] key,
 @NonNull JsonPath path)

Get the length of the JSON string value at the given path.

Parameters:

key - must not be null.

path - must not be null.

Returns:

a list where each element is the string length or null if the matched value is not a string. Returns an empty list if the path does not match any value.

See Also:

• Redis Documentation: JSON.STRLEN

jsonToggle

List<Boolean> jsonToggle(byte @NonNull [] key,
 @NonNull JsonPath path)

Toggle boolean values at the given key and path.

Parameters:

key - must not be null.

path - must not be null.

Returns:

a list where each element is the new boolean value after toggling, or null if the matched value is not a boolean. Returns an empty list if the path does not match any value.

See Also:

• Redis Documentation: JSON.TOGGLE

jsonType

default List<JsonType> jsonType(byte @NonNull [] key)

Get the JSON type at the root path of the given key.

Parameters:

key - must not be null.

Returns:

a list where each element is the type at the given path.

See Also:

• Redis Documentation: JSON.TYPE
• JsonPath.root()

jsonType

List<JsonType> jsonType(byte @NonNull [] key,
 @NonNull JsonPath path)

Get the JSON type at the given key and path.

Parameters:

key - must not be null.

path - must not be null.

Returns:

a list where each element is the type at the given path.

See Also:

• Redis Documentation: JSON.TYPE