JSON.TYPE - Upstash Documentation

Use JSON.TYPE to find out the JSON type of the values a path selects.

The reply names one type per match, one of object, array, string, integer, number, boolean, or null, and is empty when the path matches nothing. Whole numbers report as integer and fractional ones as number. It is the way to inspect documents whose shape you do not control before applying type-specific commands, which would otherwise fail.

Syntax#

JSON.TYPE <key> [path]

Arguments#

Argument	Required	Repeatable	Description
`key`	Yes	No	JSON document key.
`path`	No	No	Path to inspect; 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, array of bulk-string type names, or Null bulk string or null array
RESP3	One-element array wrapping the bulk string, the array of bulk-string type names, or Null

RESP3 adds one array level around the whole reply, matching upstream Redis. Where JSON.TYPE doc $.a replies ["string"] under RESP2, it replies [["string"]] under RESP3, and the no-path form replies "object" under RESP2 and ["object"] under RESP3.

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

@upstash/redis

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

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.json().type("profile", "$.name")print(result)

ioredis

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

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.json().type("profile", "$.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.JSONType(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.jsonType("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_type("profile", "$.name")?;    println!("{result:?}");    Ok(())}