CMS.INCRBY

Syntax text Syntax diagram API methods

CMS.INCRBY key item increment [item increment ...]

Client:

incrby(
    key: str,
    items: List,  // Items to increment
    increments: List  // Increment values for each item
) → List[int]  // Count of each item after increment

CMS.INCRBY(
    key: RedisArgument,
    items: BfIncrByItem | Array<BfIncrByItem>  // { item, incrementBy }
) → ArrayReply<NumberReply>  // Counts after increment

cmsIncrBy(
    key: String,
    item: String,
    increment: long
) → long  // Count for item after increment

cmsIncrBy(
    key: String,
    itemIncrements: Map<String, Long>
) → List<Long>  // Count of each item after increment

CMSIncrBy(
    ctx: context.Context,
    key: string,
    elements: ...interface{}  // Alternating items and increments
) → *IntSliceCmd  // Counts after increment

IncrBy(
    key: RedisKey,
    item: RedisValue,
    increment: long
) → long  // Count after increment

IncrBy(
    key: RedisKey,
    itemIncrements: Tuple<RedisValue, long>[]
) → long[]  // Counts after increment

IncrByAsync(
    key: RedisKey,
    item: RedisValue,
    increment: long
) → Task<long>  // Count after increment

IncrByAsync(
    key: RedisKey,
    itemIncrements: Tuple<RedisValue, long>[]
) → Task<long[]>  // Counts after increment

cmsincrby(
    key: string,
    itemsAndIncrements: mixed...  // Alternating items and increments
) → array  // Counts after increment

Available in:: Redis Open Source / Bloom 2.0.0
Time complexity:: O(n) where n is the number of items
ACL categories:: @cms, @write,
Compatibility:: Redis Software and Redis Cloud compatibility

Increases the count of item by increment. Multiple items can be increased with one call.

Required arguments

key

The name of the sketch.

item increment [item increment ...]

One or more item-increment pairs. Each item's counter is increased by its corresponding increment.

Examples

redis> CMS.INCRBY test foo 10 bar 42
1) (integer) 10
2) (integer) 42

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Supported	✅ Flexible & Annual ✅ Free & Fixed

Return information

RESP2 RESP3

One of the following:

Array of integer replies representing updated min-counts of each of the provided items in the sketch.
Simple error reply in these cases: invalid arguments, missing key, overflow, or wrong key type.