JSON.MSET - Upstash Documentation

Use JSON.MSET to set values at paths in several JSON documents in one atomic call.

Each triple gives a key, a path, and a value, and missing keys are created. Either every write is applied or none is, with no other command running in between, which is what makes it the right tool for documents that must stay consistent with each other. The reply is OK.

Syntax#

JSON.MSET <key> <path> <value> [key path value ...]

Arguments#

Argument	Required	Repeatable	Description
`key path value`	Yes	Yes	One or more key, path, and valid-JSON-value triples.

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`
RESP3	Simple string `OK`

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

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const result = await redis.json.mset([  { key: "profile:1", path: "$", value: { name: "Ada" } },]);console.log(result);

upstash_redis

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

ioredis

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

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.json().mset([("profile:1", "$", {"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.JSONMSet(context.Background(), "profile:1", "$", `{"name":"Ada"}`).Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import java.nio.charset.StandardCharsets;import redis.clients.jedis.Jedis;import redis.clients.jedis.commands.ProtocolCommand;ProtocolCommand command = () -> "JSON.MSET".getBytes(StandardCharsets.UTF_8);try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.sendCommand(command, "profile:1", "$", "{\"name\":\"Ada\"}");  System.out.println(result);}

redis-rs

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 mut command = redis::cmd("JSON.MSET");    command.arg("profile:1");    command.arg("$");    command.arg("{\"name\":\"Ada\"}");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}