JSON.DEBUG - Upstash Documentation

Use JSON.DEBUG to inspect internal details of stored JSON values.

JSON.DEBUG MEMORY reports the approximate number of bytes used by the value a key and optional path select, which is how you find out which documents, or which branches of a document, are responsible for memory growth. The figure includes internal overhead and is an estimate meant for comparison rather than exact accounting. JSON.DEBUG HELP lists the supported forms.

It is a diagnostic aid: the details it exposes are implementation-specific and can change, so do not build application logic on them.

Syntax#

JSON.DEBUG MEMORY <key> [path]JSON.DEBUG HELP

Arguments#

Argument	Required	Repeatable	Description
`MEMORY`	One form	No	Report the approximate memory used by the JSON value selected by key and optional path.
`key`	For MEMORY	No	JSON document key.
`path`	No	No	JSONPath to inspect; defaults to the root.
`HELP`	One form	No	Return the supported JSON.DEBUG forms.

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	Integer, array of integers, or array of help strings
RESP3	Integer, array of integers, or array of help strings

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.DEBUG MEMORY profile $.stats

@upstash/redis

Note

This command is not supported yet in @upstash/redis.

upstash_redis

Note

This command is not supported yet in upstash_redis.

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.call("JSON.DEBUG", "MEMORY", "profile", "$.stats");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.debugMemory("profile", { path: "$.stats" });console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.json().debug("MEMORY", "profile", "$.stats")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.JSONDebugMemory(context.Background(), "profile", "$.stats").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.jsonDebugMemory("profile", new redis.clients.jedis.json.Path("$.stats"));  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.DEBUG");    command.arg("MEMORY");    command.arg("profile");    command.arg("$.stats");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}