JSON.STRLEN

Syntax text Syntax diagram API methods

JSON.STRLEN key [path]

Client:

strlen(
    name: str,
    path: Optional[str] = None
) → List[Optional[int]]

STRLEN(
    key: RedisArgument,
    options?: JsonStrLenOptions
) → Any

jsonStrLen(
    key: String
) → Long

jsonStrLen(
    key: String,
    path: Path
) → Long

jsonStrLen(
    key: String,
    path: Path2
) → List<Long>

jsonStrlen(
    key: K,  // the key holding the JSON document.
    jsonPath: JsonPath
) → List<Long>  // Long (in recursive descent) the length of the JSON String at the provided JsonPath, or null if the value ath the desired path is not a string. @since 6.5

jsonStrlen(
    key: K  // the key holding the JSON document.
) → List<Long>  // Long (in recursive descent) the length of the JSON String at the provided JsonPath, or null if the value ath the desired path is not a string. @since 6.5

jsonStrlen(
    key: K,  // the key holding the JSON document.
    jsonPath: JsonPath
) → RedisFuture<List<Long>>  // Long (in recursive descent) the length of the JSON String at the provided JsonPath, or null if the value ath the desired path is not a string. @since 6.5

jsonStrlen(
    key: K  // the key holding the JSON document.
) → RedisFuture<List<Long>>  // Long (in recursive descent) the length of the JSON String at the provided JsonPath, or null if the value ath the desired path is not a string. @since 6.5

jsonStrlen(
    key: K,  // the key holding the JSON document.
    jsonPath: JsonPath
) → Flux<Long>  // Long (in recursive descent) the length of the JSON String at the provided JsonPath, or null if the value ath the desired path is not a string. @since 6.5

jsonStrlen(
    key: K  // the key holding the JSON document.
) → Flux<Long>  // Long (in recursive descent) the length of the JSON String at the provided JsonPath, or null if the value ath the desired path is not a string. @since 6.5

JSONStrLen(
    ctx: context.Context,
    key: Any,
    path: string
) → *IntPointerSliceCmd

StrLen(
    key: RedisKey,
    path: string?
) → long?[]

jsonstrlen(
    $key: string,
    string $path = '$': Any
) → array

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, @read, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Returns the length of JSON strings at the paths matching a given path expression.

Examples

Required arguments

key

is a Redis key storing a value of type JSON.

Optional arguments

path

is either

A JSONPath expression
- The root "$", or any string that starts with "$." or "$[".
- Resolves to all matching locations in key.
A legacy path expression
- Any string that does not match the JSONPath syntax above.
- Allow the leading "." to be omitted (for example, "name" and ".name" are equivalent).
- Resolves to only the first matching location in key.

Default: "." (legacy path pointing to the root of the document).

Examples

redis> JSON.SET doc $ '{"a":"foo", "nested": {"a": "hello"}, "nested2": {"a": 31}}'
OK
redis> JSON.STRLEN doc $..a
1) (integer) 3
2) (integer) 5
3) (nil)

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

If path is a JSONPath expression:

A simple error if key does not exist.
An empty array reply if path has no matches.
An array reply where each array element corresponds to one match:
- nil if the match is not a string.
- An integer reply: the length of the string.

If path is a legacy path expression:

nil if key does not exist.
A simple error if path has no matches.
A simple error if the first match is not a string.
An integer reply: the length of the string at the first match.

If path is a JSONPath expression:

A simple error if key does not exist.
An empty array reply if path has no matches.
An array reply where each array element corresponds to one match:
- nil if the match is not a string.
- An integer reply: the length of the string.

If path is a legacy path expression:

nil if key does not exist.
A simple error if path has no matches.
A simple error if the first match is not a string.
An integer reply: the length of the string at the first match.

Products

Tools

Get Redis

Connect

Learn

Latest

See how it works

JSON.STRLEN

Required arguments

Optional arguments

Examples

Redis Software and Redis Cloud compatibility

Return information

See also

JSON.STRLEN

Required arguments

Optional arguments

Examples

Redis Software and Redis Cloud compatibility

Return information

See also

Related topics