JSON.CLEAR

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

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

Examples

Required arguments

key

is key to parse.

Optional arguments

path

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

Return

JSON.CLEAR returns an integer reply specifying the number of matching JSON arrays and objects cleared + number of matching JSON numerical values zeroed. For more information about replies, see Redis serialization protocol specification.

Note:
Already cleared values are ignored for empty containers and zero numbers.

Examples

Clear container values and set numeric values to 0

Create a JSON document.

redis> JSON.SET doc $ '{"obj":{"a":1, "b":2}, "arr":[1,2,3], "str": "foo", "bool": true, "int": 42, "float": 3.14}'
OK

Clear all container values. This returns the number of objects with cleared values.

redis> JSON.CLEAR doc $.*
(integer) 4

Get the updated document. Note that numeric values have been set to 0.

redis> JSON.GET doc $
"[{\"obj\":{},\"arr\":[],\"str\":\"foo\",\"bool\":true,\"int\":0,\"float\":0}]"

See also

JSON.ARRINDEX | JSON.ARRINSERT


RATE THIS PAGE
Back to top ↑