JSON.ARRINSERT - Upstash Documentation

Use JSON.ARRINSERT to insert one or more values into the arrays a path selects, before a given index.

Elements at and after that index shift to the right, keeping the rest of the array in order. A negative index counts from the end of the array and an index equal to the array's length appends, while an index outside the array returns an error. The reply is the new length of each array the path matched.

Syntax#

JSON.ARRINSERT <key> <path> <index> <value> [value ...]

Arguments#

Argument	Required	Repeatable	Description
`key`	Yes	No	JSON document key.
`path`	Yes	No	Path selecting arrays.
`index`	Yes	No	Insertion index; negative indexes count from the end.
`value`	Yes	Yes	Valid JSON value to insert.

Important points#

Raw TCP examples pass JSON values as valid JSON text. Typed Upstash SDK helpers serialize native objects and values for you.
Paths beginning with $ use JSONPath and can match multiple values, so many JSON commands return an array of per-match results.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Array of integer lengths or null values, one per matched path
RESP3	Array of integer lengths or null values, one per matched path

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

JSON.ARRINSERT profile $.tags 0 '"first"'

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const length = await redis.json.arrinsert("key", "$.path.to.array", 2, "a", "b");

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.json().arrinsert("profile", "$.tags", 0, "first")print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.call("JSON.ARRINSERT", "profile", "$.tags", "0", "\"first\"");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.json.arrInsert("profile", "$.tags", 0, "first");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.json().arrinsert("profile", "$.tags", 0, "first")print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    result, err := client.JSONArrInsert(context.Background(), "profile", "$.tags", 0, "first").Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.JedisPooled;try (JedisPooled jedis = new JedisPooled(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.jsonArrInsert("profile", new redis.clients.jedis.json.Path("$.tags"), 0, "first");  System.out.println(result);}

redis-rs

use redis::JsonCommands;fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let result: redis::Value = connection.json_arr_insert("profile", "$.tags", 0, &"first")?;    println!("{result:?}");    Ok(())}