JSON.NUMINCRBY

Syntax text Syntax diagram API methods

JSON.NUMINCRBY key path value

Client:

numincrby(
    name: str,
    path: str,
    number: int
) → str

NUMINCRBY(
    key: RedisArgument,
    path: RedisArgument,
    by: number
) → Any

jsonNumIncrBy(
    key: String,
    path: Path,
    value: double
) → double

jsonNumIncrBy(
    key: String,
    path: Path2,
    value: double
) → Object

jsonNumincrby(
    key: K,  // the key holding the JSON document.
    jsonPath: JsonPath,  // the JsonPath pointing to the value to increment.
    number: Number  // the increment value.
) → List<Number>  // a List of the new values after the increment. @since 6.5

jsonNumincrby(
    key: K,  // the key holding the JSON document.
    jsonPath: JsonPath,  // the JsonPath pointing to the value to increment.
    number: Number  // the increment value.
) → RedisFuture<List<Number>>  // a List of the new values after the increment. @since 6.5

jsonNumincrby(
    key: K,  // the key holding the JSON document.
    jsonPath: JsonPath,  // the JsonPath pointing to the value to increment.
    number: Number  // the increment value.
) → Flux<Number>  // a List of the new values after the increment. @since 6.5

JSONNumIncrBy(
    ctx: context.Context,
    key: Any,
    path: string,
    value: float64
) → *JSONCmd

NumIncrby(
    key: RedisKey,
    path: string,
    value: double
) → double?[]

jsonnumincrby(
    $key: string,
    $path: string,
    $value: int
) → mixed

json_num_incr_by(
    key: K,  // The key holding the JSON document.
    path: P,  // The path to the numeric value to increment.
    value: i64  // The amount to add to the numeric value.
) → (RV)  // The updated numeric value.

json_num_incr_by(
    key: K,  // The key holding the JSON document.
    path: P,  // The path to the numeric value to increment.
    value: i64  // The amount to add to the numeric value.
) → (RV)  // The updated numeric value.

Available in:: Redis Open Source / 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
ACL categories:: @json, @write, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Increment the number value stored at path by value

Examples

Required arguments

key

is key to modify.

path

is JSONPath to specify.

value

is number value to increment.

Examples

Increment number values

Create a document.

redis> 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.

redis> 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.

redis> JSON.NUMINCRBY doc $..a 2
"[null,4,7,null]"

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Supported	✅ Flexible & Annual ✅ Free & Fixed

Return information

RESP2 RESP3

With $-based path argument: Bulk string reply containing a JSON array with one element per matching path: the new value, or null if the matching value is not a number. The array is empty if no path matches.

With .-based path argument: Bulk string reply representing the stringified new value. If the path matches more than one number, the command updates all of them and returns the last new value. Simple error reply if no matching value is a number.

With either path argument: simple error reply if the key doesn't exist or the result is out of range.

	Products	Version
	Develop with Redis Clients, data types, programmability, and Redis for AI. RedisVL is listed separately.
	Libraries and tools Client libraries, observability, and cloud integrations. Redis Data Integration is listed separately.
	RedisVL
	Redis Software
	Redis Cloud
	Redis for Kubernetes
	Redis Open Source
	Redis Iris context engine
	Redis Feature Form
	Redis Insight
	Redis Data Integration
	Glossary
	Command reference

JSON.NUMINCRBY

Required arguments

Examples

Redis Software and Redis Cloud compatibility

Return information

See also

Related topics