JSON commands
Lists JSON commands and provides links to the command reference pages.
Redis Stack |
---|
The following table lists JSON commands. See the command links for more information about each command's syntax, arguments, and examples.
Command | Redis Enterprise |
Redis Cloud |
Description |
---|---|---|---|
JSON.ARRAPPEND | ✅ Supported |
✅ Free & Fixed |
Appends an element to a JSON array. |
JSON.ARRINDEX | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Returns the index of a value's first occurrence in a JSON array. |
JSON.ARRINSERT | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Inserts JSON values into a JSON array before the given index. |
JSON.ARRLEN | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Returns the length of a JSON array. |
JSON.ARRPOP | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Removes and returns an element located at the index in the JSON array. |
JSON.ARRTRIM | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Trims a JSON array so that it contains only the specified inclusive range of elements. |
JSON.CLEAR | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Clears container values (arrays/objects) and sets numeric values to 0. |
JSON.DEBUG | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Debugging container command. |
JSON.DEBUG HELP | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Returns helpful information about the JSON.DEBUG command. |
JSON.DEBUG MEMORY | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Reports a JSON element's memory usage in bytes. |
JSON.DEL | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Removes a JSON element. |
JSON.FORGET | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Removes a JSON element, the same as JSON.DEL. |
JSON.GET | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Returns the value of an element in JSON-serialized form. |
JSON.MGET | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Returns the values of multiple elements. |
JSON.NUMINCRBY | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Increments the number stored at path by the specified number. |
JSON.NUMMULTBY | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Multiplies the number stored at path by the specified number. (deprecated as of RedisJSON v2.0) |
JSON.OBJKEYS | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Returns the keys contained in the specified JSON object. |
JSON.OBJLEN | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Returns the number of keys in the specified JSON object. |
JSON.RESP | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Returns a JSON element in Redis Serialization Protocol (RESP) format. |
JSON.SET | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Sets the value of a JSON element. |
JSON.STRAPPEND | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Appends the given string to the specified key's existing strings. |
JSON.STRLEN | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Returns the length of a string. |
JSON.TOGGLE | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
If the boolean is true , changes it to false . If the boolean is false , changes it to true . |
JSON.TYPE | ✅ Supported |
✅ Flexible & Annual ✅ Free & Fixed |
Returns a JSON element's type. |