JSON.OBJKEYS

Syntax
JSON.OBJKEYS key [path]
Available in:
Redis Open Source / JSON 1.0.0
Time complexity:
O(N) when path is evaluated to a single value, where N is the number of keys in the object, O(N) when path is evaluated to multiple values, where N is the size of the key
ACL categories:
@json, @read, @slow,
Compatibility:
Redis Enterprise and Redis Cloud compatibility

Return the keys in the object that's referenced by path

Examples

Required arguments

key

is key to parse. Returns null for nonexistent keys.

Optional arguments

path

is JSONPath to specify. Default is root $. Returns null for nonexistant path.

Examples 

redis> JSON.SET doc $ '{"a":[3], "nested": {"a": {"b":2, "c": 1}}}'
OK
redis> JSON.OBJKEYS doc $..a
1) (nil)
2) 1) "b"
   2) "c"

Redis Enterprise and Redis Cloud compatibility

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

Return information

With $-based path argument: Array reply of array replies of bulk string replies, where each nested array contains the key names in the object, or null if the matching value is not an object.

With .-based path argument: Array reply of bulk string replies containing the key names in the object, or null reply if the matching value is not an object.

See also

JSON.ARRINDEX | JSON.ARRINSERT