DECR

Syntax text Syntax diagram API methods

DECR key

Client:

decrby(
    name: KeyT,
    amount: int = 1
) → ResponseT

DECR(
    key: RedisArgument
) → Any

DECRBY(
    key: RedisArgument,
    decrement: number
) → Any

decrBy(
    key: byte[],
    decrement: long
) → long  // The value of key after the decrement

decr(
    key: byte[]
) → long  // The value of key after the decrement

decrBy(
    key: String,
    decrement: long
) → long  // The value of key after the decrement

decr(
    key: String
) → long  // The value of key after the decrement

decr(
    key: K  // the key.
) → Long  // Long integer-reply the value of key after the decrement.

decrby(
    key: K,  // the key.
    amount: long  // the decrement type: long.
) → Long  // Long integer-reply the value of key after the decrement.

decr(
    key: K  // the key.
) → RedisFuture<Long>  // Long integer-reply the value of key after the decrement.

decrby(
    key: K,  // the key.
    amount: long  // the decrement type: long.
) → RedisFuture<Long>  // Long integer-reply the value of key after the decrement.

decr(
    key: K  // the key.
) → Mono<Long>  // Long integer-reply the value of key after the decrement.

decrby(
    key: K,  // the key.
    amount: long  // the decrement type: long.
) → Mono<Long>  // Long integer-reply the value of key after the decrement.

Decr(
    ctx: context.Context,
    key: string
) → *IntCmd

DecrBy(
    ctx: context.Context,
    key: string,
    decrement: int64
) → *IntCmd

StringDecrement(
    key: RedisKey,  // The key of the string.
    value: long,  // The amount to decrement by (defaults to 1).
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The value of key after the decrement.

StringDecrement(
    key: RedisKey,  // The key of the string.
    value: double,  // The amount to decrement by (defaults to 1).
    flags: CommandFlags  // The flags to use for this operation.
) → double  // The value of key after the decrement.

StringDecrement(
    key: RedisKey,  // The key of the string.
    value: long,  // The amount to decrement by (defaults to 1).
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The value of key after the decrement.

StringDecrement(
    key: RedisKey,  // The key of the string.
    value: double,  // The amount to decrement by (defaults to 1).
    flags: CommandFlags  // The flags to use for this operation.
) → double  // The value of key after the decrement.

StringDecrement(
    key: RedisKey,  // The key of the string.
    value: long,  // The amount to decrement by (defaults to 1).
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The value of key after the decrement.

StringDecrement(
    key: RedisKey,  // The key of the string.
    value: double,  // The amount to decrement by (defaults to 1).
    flags: CommandFlags  // The flags to use for this operation.
) → double  // The value of key after the decrement.

StringDecrement(
    key: RedisKey,  // The key of the string.
    value: long,  // The amount to decrement by (defaults to 1).
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The value of key after the decrement.

StringDecrement(
    key: RedisKey,  // The key of the string.
    value: double,  // The amount to decrement by (defaults to 1).
    flags: CommandFlags  // The flags to use for this operation.
) → double  // The value of key after the decrement.

decr(
    $key: string
) → int

decrby(
    $key: string,
    $decrement: int
) → int

decr(
    key: K,
    delta: V
) → (isize)

decr(
    key: K,
    delta: V
) → (isize)

Available since:: Redis Open Source 1.0.0
Time complexity:: O(1)
ACL categories:: @write, @string, @fast,
Compatibility:: Redis Software and Redis Cloud compatibility

Decrements the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer. This operation is limited to 64-bit signed integers.

See INCR for extra information on increment/decrement operations.

Required arguments

key

The name of the key.

Examples

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

Integer reply: the value of the key after decrementing it.