JSON.ARRINSERT key path index value [value ...]
Available in:
Redis Stack / JSON 1.0.0
Time complexity:
O(N) when path is evaluated to a single value where N is the size of the array, O(N) when path is evaluated to multiple values, where N is the size of the key

Insert the json values into the array at path before the index (shifts to the right)


Required arguments


is key to modify.


is one or more values to insert in one or more arrays.

About using strings with JSON commands:
To specify a string as an array value to insert, wrap the quoted string with an additional set of single quotes. Example: '"silver"'. For more detailed use, see Examples.

is position in the array where you want to insert a value. The index must be in the array's range. Inserting at index 0 prepends to the array. Negative index values start from the end of the array.

Optional arguments


is JSONPath to specify. Default is root $.

Return value

JSON.ARRINSERT returns an array of integer replies for each path, the array's new size, or nil, if the matching JSON value is not an array. For more information about replies, see Redis serialization protocol specification.


Add new colors to a specific place in a list of product colors

Create a document for noise-cancelling headphones in black and silver colors.

redis> JSON.SET item:1 $ '{"name":"Noise-cancelling Bluetooth headphones","description":"Wireless Bluetooth headphones with noise-cancelling technology","connection":{"wireless":true,"type":"Bluetooth"},"price":99.98,"stock":25,"colors":["black","silver"]}'

Add color blue to the end of the colors array. JSON.ARRAPEND returns the array's new size.

redis> JSON.ARRAPPEND item:1 $.colors '"blue"'
1) (integer) 3

Return the new length of the colors array.

redis> JSON.GET item:1
"{\"name\":\"Noise-cancelling Bluetooth headphones\",\"description\":\"Wireless Bluetooth headphones with noise-cancelling technology\",\"connection\":{\"wireless\":true,\"type\":\"Bluetooth\"},\"price\":99.98,\"stock\":25,\"colors\":[\"black\",\"silver\",\"blue\"]}"

Get the list of colors for the product.

redis> JSON.GET item:1 '$.colors[*]'

Insert two more colors after the second color. You now have five colors.

redis> JSON.ARRINSERT item:1 $.colors 2 '"yellow"' '"gold"'
1) (integer) 5

Get the updated list of colors.

redis> JSON.GET item:1 $.colors

See also


Back to top ↑