W3cubDocs

/Redis

JSON.TOGGLE

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

Toggle a Boolean value stored at path

Examples

Required arguments

key

is key to modify.

Optional arguments

path

is JSONPath to specify. Default is root $.

Return

JSON.TOGGLE returns an array of integer replies for each path, the new value (0 if false or 1 if true), or nil for JSON values matching the path that are not Boolean. For more information about replies, see Redis serialization protocol specification.

Examples

Toogle a Boolean value stored at path

Create a JSON document.

127.0.0.1:6379> JSON.SET doc $ '{"bool": true}'
OK

Toggle the Boolean value.

127.0.0.1:6379> JSON.TOGGLE doc $.bool
1) (integer) 0

Get the updated document.

127.0.0.1:6379> JSON.GET doc $
"[{\"bool\":false}]"

Toggle the Boolean value.

127.0.0.1:6379> JSON.TOGGLE doc $.bool
1) (integer) 1

Get the updated document.

127.0.0.1:6379> JSON.GET doc $
"[{\"bool\":true}]"

See also

JSON.SET | JSON.GET

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