JSON.MGET - Upstash Documentation

Use JSON.MGET to read the same path from several JSON documents in one call.

The reply holds one entry per key, in the order requested, containing what the path selected in that document, or null when the key does not exist or the path matches nothing. It replaces one JSON.GET per key when you are gathering the same field across many documents, for example the price of every product in a cart.

Syntax#

JSON.MGET <key> [key ...] <path>

Arguments#

Argument	Required	Repeatable	Description
`key`	Yes	Yes	One or more JSON document keys.
`path`	Yes	No	Path read from every key.

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 bulk-string JSON values or null values, one per key
RESP3	Array of bulk-string JSON values or null values, one per key

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.MGET profile:1 profile:2 $.name

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const values = await redis.json.mget(["key1", "key2"],  "$.path.to.somewhere");

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.json().mget(["profile:1", "profile:2"], "$.name")print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.call("JSON.MGET", "profile:1", "profile:2", "$.name");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.mGet(["profile:1", "profile:2"], "$.name");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.json().mget(["profile:1", "profile:2"], "$.name")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.JSONMGet(context.Background(), "$.name", "profile:1", "profile:2").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.jsonMGet(new redis.clients.jedis.json.Path2("$.name"), "profile:1", "profile:2");  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_mget(&["profile:1", "profile:2"], "$.name")?;    println!("{result:?}");    Ok(())}