DECRBY - Upstash Documentation

Use DECRBY to subtract an integer from the value stored at a key and get the result.

A missing key counts as 0. The stored value must be the string form of a 64-bit signed integer, and an operation that would exceed that range returns an error. The whole update is atomic, so concurrent callers cannot lose a decrement. Passing a negative amount adds instead, which makes INCRBY and DECRBY two views of the same operation.

Syntax#

DECRBY <key> <decrement>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<decrement>`	Yes	No	Amount to subtract from the current value.

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
RESP3	Integer

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

DECRBY my-key 1

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.set("key", 6);await redis.decrby("key", 4);// returns 2

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.decrby("my-key", 1)print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.decrby("my-key", "1");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.decrBy("my-key", 1);console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.decrby("my-key", 1)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.DecrBy(context.Background(), "my-key", 1).Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.decrBy("my-key", 1);  System.out.println(result);}

redis-rs

use redis::TypedCommands;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 = connection.decr("my-key", 1)?;    println!("{result:?}");    Ok(())}