Redis Iris

Redis install Data types

Tools Community Docs

Login Sign up

Develop with Redis Libraries and tools Redis products

Commands

Download documentation

Choose the products and versions you want. Everything arrives as one .tar.gz, with a directory per product.

Format

This page

	Products	Version
	Develop with Redis Clients, data types, programmability, and Redis for AI. RedisVL is listed separately.
	Libraries and tools Client libraries, observability, and cloud integrations. Redis Data Integration is listed separately.
	RedisVL
	Redis Software
	Redis Cloud
	Redis for Kubernetes
	Redis Open Source
	Redis Iris context engine
	Redis Feature Form
	Redis Insight
	Redis Data Integration
	Glossary
	Command reference

HINCRBY

Syntax text Syntax diagram API methods

HINCRBY key field increment

Client:

hincrby(
    name: str,
    key: str,
    amount: int = 1
) → Union[Awaitable[int], int]

Possible errors

ERR value is not an integer: ResponseError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

hIncrBy(
    key: RedisArgument,
    field: RedisArgument,
    increment: number
) → NumberReply

Possible errors

ERR value is not an integer: SimpleError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

hincrby(
    key: RedisKey,
    field: string | Buffer,
    increment: number | string,
    callback?: Callback<number>
) → Result<number, Context>

Possible errors

ERR value is not an integer: ReplyError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

hincrBy(
    key: byte[],
    field: byte[],
    value: long
) → long  // The value of key after the increment

hincrBy(
    key: String,
    field: String,
    value: long
) → long  // The value of key after the increment

Possible errors

ERR value is not an integer: JedisDataException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

hincrby(
    key: K,  // the key.
    field: K,  // the field type: key.
    amount: long  // the increment type: long.
) → Long  // Long integer-reply the value at field after the increment operation.

Possible errors

ERR value is not an integer: RedisCommandExecutionException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

hincrby(
    key: K,  // the key.
    field: K,  // the field type: key.
    amount: long  // the increment type: long.
) → RedisFuture<Long>  // Long integer-reply the value at field after the increment operation.

Possible errors

ERR value is not an integer: RedisCommandExecutionException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

hincrby(
    key: K,  // the key.
    field: K,  // the field type: key.
    amount: long  // the increment type: long.
) → Mono<Long>  // Long integer-reply the value at field after the increment operation.

Possible errors

ERR value is not an integer: RedisCommandExecutionException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

HIncrBy(
    ctx: context.Context,
    key: Any,
    field: string,
    incr: int64
) → *IntCmd

Possible errors

ERR value is not an integer: redis.Error

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

HashDecrement(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,  // The field in the hash to decrement.
    value: long,  // The amount to decrement by.
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The value at field after the decrement operation.

HashDecrement(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,  // The field in the hash to decrement.
    value: double,  // The amount to decrement by.
    flags: CommandFlags  // The flags to use for this operation.
) → double  // The value at field after the decrement operation.

HashIncrement(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,  // The field in the hash to increment.
    value: long,  // The amount to increment by.
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The value at field after the increment operation.

HashIncrement(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,  // The field in the hash to increment.
    value: double,  // The amount to increment by.
    flags: CommandFlags  // The flags to use for this operation.
) → double  // The value at field after the increment operation.

Possible errors

ERR value is not an integer: RedisServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

HashDecrementAsync(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,  // The field in the hash to decrement.
    value: long,  // The amount to decrement by.
    flags: CommandFlags  // The flags to use for this operation.
) → Task<long>  // The value at field after the decrement operation.

HashDecrementAsync(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,  // The field in the hash to decrement.
    value: double,  // The amount to decrement by.
    flags: CommandFlags  // The flags to use for this operation.
) → Task<double>  // The value at field after the decrement operation.

HashIncrementAsync(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,  // The field in the hash to increment.
    value: long,  // The amount to increment by.
    flags: CommandFlags  // The flags to use for this operation.
) → Task<long>  // The value at field after the increment operation.

HashIncrementAsync(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,  // The field in the hash to increment.
    value: double,  // The amount to increment by.
    flags: CommandFlags  // The flags to use for this operation.
) → Task<double>  // The value at field after the increment operation.

Possible errors

ERR value is not an integer: RedisServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

hincrby(
    $key: string,
    $field: string,
    $increment: int
) → int

Possible errors

ERR value is not an integer: Predis\Response\ServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

hincrby(
    key: String,
    field: String,
    increment: Integer
) → Integer  // value of the field after incrementing it

Possible errors

ERR value is not an integer: Redis::CommandError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

hincr(
    key: K,
    field: F,
    delta: D
) → (f64)

Possible errors

ERR value is not an integer: ErrorKind::Server(ServerErrorKind::ResponseError)

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

hincr(
    key: K,
    field: F,
    delta: D
) → (f64)

Possible errors

ERR value is not an integer: ErrorKind::Server(ServerErrorKind::ResponseError)

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

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

Increments the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist the value is set to 0 before the operation is performed.

The range of values supported by HINCRBY is limited to 64 bit signed integers.

Required arguments

key

The name of the key that holds the hash.

field

The field whose value to increment.

increment

The integer amount to add to the field's value.

Examples

Since the increment argument is signed, both increment and decrement operations can be performed:

redis> HSET myhash field 5
(integer) 1
redis> HINCRBY myhash field 1
(integer) 6
redis> HINCRBY myhash field -1
(integer) 5
redis> HINCRBY myhash field -10
(integer) -5

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 field after the increment operation.