JSON.GET - Upstash Documentation

Use JSON.GET to read one or more values from a JSON document. Without a path the whole document is returned. The reply shape depends on the path syntax: a path starting with $ is a JSONPath and always returns an array with one entry per match, so an empty array means nothing matched, while the legacy dot syntax returns the value itself and reports an error when the path does not exist. Passing several paths returns an object keyed by the path expressions, which is a cheap way to pull a few unrelated branches of a large document in one call. INDENT, NEWLINE, and SPACE control the formatting of the returned JSON text, which is otherwise compact. They are meant for human-readable output; leave them out when a program parses the reply.

Syntax

JSON.GET <key>
  [INDENT indent]
  [NEWLINE newline]
  [SPACE space]
  [path [path ...]]

Arguments

Argument	Required	Repeatable	Description
`key`	Yes	No	JSON document key.
`INDENT indent`	No	No	Indentation characters for formatted JSON.
`NEWLINE newline`	No	No	Line-separator characters for formatted JSON.
`SPACE space`	No	No	Characters placed after JSON separators.
`path`	No	Yes	One or more paths; defaults to the root.

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	Bulk string or Null bulk string or null array
RESP3	Bulk string or Null

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.GET profile $.name

@upstash/redis

import { Redis } from "@upstash/redis";

const redis = Redis.fromEnv();

const value = await redis.json.get("key", "$.path.to.somewhere");

upstash_redis

from upstash_redis import Redis

redis = Redis.from_env()
result = redis.json().get("profile", "$.name")
print(result)

ioredis

import Redis from "ioredis";

const redis = new Redis(process.env.REDIS_URL!);
const result = await redis.call("JSON.GET", "profile", "$.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.get("profile", { path: "$.name" });
console.log(result);

redis-py

import os
import redis

client = redis.from_url(os.environ["REDIS_URL"])
result = client.json().get("profile", "$.name")
print(result)

go-redis

package main

import (
    "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.JSONGet(context.Background(), "profile", "$.name").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.jsonGet("profile", new redis.clients.jedis.json.Path("$.name"));
  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_get("profile", &["$.name"])?;
    println!("{result:?}");
    Ok(())
}

​Syntax

​Arguments

​Important points

​Response

​Examples

Syntax

Arguments

Important points

Response

Examples