JSON.TOGGLE - Upstash Documentation

Use JSON.TOGGLE to flip the boolean values a path selects, turning true into false and back.

The reply is the new value of each match, and a match that is not a boolean returns an error. Because the read and the write are one atomic step, this is the safe way to flip a flag inside a document, where reading it and writing the opposite value back would race with other clients.

Syntax#

JSON.TOGGLE <key> <path>

Arguments#

Argument	Required	Repeatable	Description
`key`	Yes	No	JSON document key.
`path`	Yes	No	Path selecting Boolean values.

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 integer Boolean values or null values, one per matched path
RESP3	Array of integer Boolean values or null values, one per matched path

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.TOGGLE profile $.active

@upstash/redis

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

upstash_redis

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

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.call("JSON.TOGGLE", "profile", "$.active");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.toggle("profile", "$.active");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.json().toggle("profile", "$.active")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.JSONToggle(context.Background(), "profile", "$.active").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.jsonToggle("profile", new redis.clients.jedis.json.Path("$.active"));  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_toggle("profile", "$.active")?;    println!("{result:?}");    Ok(())}