JSON.SET - Upstash Documentation

Use JSON.SET to set a JSON value at a path inside a document, creating the key when it does not exist.

The value is JSON text; the Upstash SDK helpers serialize native objects for you. With the root path ($) the whole document is replaced, which is also how a new document is created. For a nested path the parent must already exist: the command adds one missing child to an existing object or appends to an existing array, but it does not create intermediate levels along the way.

NX writes only when the path does not exist yet and XX only when it does, which makes conditional updates atomic. When the path is a JSONPath that matches several places, every match is updated in the same call, so a single command can update all elements of an array.

Syntax#

JSON.SET <key> <path> <value> [NX | XX]

Arguments#

Argument	Required	Repeatable	Description
`key`	Yes	No	JSON document key.
`path`	Yes	No	Path to create or replace.
`value`	Yes	No	Valid JSON value.
`NX \| XX`	No	No	Write only when the path is absent (`NX`) or present (`XX`).

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	Simple string `OK`, or Null bulk string or null array when `NX` or `XX` prevented the write
RESP3	Simple string `OK`, or Null when `NX` or `XX` prevented the write

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.SET profile $ '{"name":"Ada"}'

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();redis.json.set(key, "$.path", value);

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.json().set("profile", "$", {"name": "Ada"})print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.call("JSON.SET", "profile", "$", "{\"name\":\"Ada\"}");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.set("profile", "$", { name: "Ada" });console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.json().set("profile", "$", {"name": "Ada"})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.JSONSet(context.Background(), "profile", "$", map[string]interface{}{"name": "Ada"}).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.jsonSet("profile", new redis.clients.jedis.json.Path("$"), java.util.Map.of("name", "Ada"));  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_set("profile", "$", &serde_json::json!({"name": "Ada"}))?;    println!("{result:?}");    Ok(())}