W3cubDocs

/Redis

JSON.DEL

JSON.DEL
Syntax
JSON.DEL key [path]
Available in:
Redis Stack / JSON 1.0.0
Time complexity:
O(N) when path is evaluated to a single value where N is the size of the deleted value, O(N) when path is evaluated to multiple values, where N is the size of the key

Delete a value

Examples

Required arguments

key

is key to modify.

Optional arguments

path

is JSONPath to specify. Default is root $. Nonexisting paths are ignored.

Note

Deleting an object's root is equivalent to deleting the key from Redis.

Return

JSON.DEL returns an integer reply specified as the number of paths deleted (0 or more). For more information about replies, see Redis serialization protocol specification.

Examples

Delete a value

Create a JSON document.

127.0.0.1:6379> JSON.SET doc $ '{"a": 1, "nested": {"a": 2, "b": 3}}'
OK

Delete specified values.

127.0.0.1:6379> JSON.DEL doc $..a
(integer) 2

Get the updated document.

127.0.0.1:6379> JSON.GET doc $
"[{\"nested\":{\"b\":3}}]"

See also

JSON.SET | JSON.ARRLEN

© 2006–2022 Salvatore Sanfilippo
Licensed under the Creative Commons Attribution-ShareAlike License 4.0.
https://redis.io/commands/json.del/