W3cubDocs

/Redis

JSON.NUMINCRBY

JSON.NUMINCRBY
Syntax
JSON.NUMINCRBY key path value
Available in:
Redis Stack / JSON 1.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

Increment the number value stored at path by number

Examples

Required arguments

key

is key to modify.

path

is JSONPath to specify.

value

is number value to increment.

Return

JSON.NUMINCRBY returns a bulk string reply specified as a stringified new value for each path, or nil, if the matching JSON value is not a number. For more information about replies, see Redis serialization protocol specification.

Examples

Increment number values

Create a document.

127.0.0.1:6379> JSON.SET doc . '{"a":"b","b":[{"a":2}, {"a":5}, {"a":"c"}]}'
OK

Increment a value of a object by 2. The command fails to find a number and returns null.

127.0.0.1:6379> JSON.NUMINCRBY doc $.a 2
"[null]"

Recursively find and increment a value of all a objects. The command increments numbers it finds and returns null for nonnumber values.

127.0.0.1:6379> JSON.NUMINCRBY doc $..a 2
"[null,4,7,null]"

See also

JSON.ARRINDEX | JSON.ARRINSERT

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