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

HINCRBYFLOAT

Syntax text Syntax diagram API methods

HINCRBYFLOAT key field increment

Client:

hincrbyfloat(
    name: str,
    key: str,
    amount: float = 1.0
) → Union[Awaitable[float], float]

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.

hIncrByFloat(
    key: RedisArgument,
    field: RedisArgument,
    increment: number
) → BlobStringReply

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.

hincrbyfloat(
    key: RedisKey,
    field: string | Buffer,
    increment: number | string,
    callback?: Callback<string>
) → Result<string, 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.

hincrByFloat(
    key: byte[],
    field: byte[],
    value: double
) → double  // The new value at field after the increment operation

hincrByFloat(
    key: String,
    field: String,
    value: double
) → double  // The new value at field after the increment operation

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.

hincrbyfloat(
    key: K,  // the key.
    field: K,  // the field type: key.
    amount: double  // the increment type: double.
) → Double  // Double bulk-string-reply the value of field after the increment.

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.

hincrbyfloat(
    key: K,  // the key.
    field: K,  // the field type: key.
    amount: double  // the increment type: double.
) → RedisFuture<Double>  // Double bulk-string-reply the value of field after the increment.

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.

hincrbyfloat(
    key: K,  // the key.
    field: K,  // the field type: key.
    amount: double  // the increment type: double.
) → Mono<Double>  // Double bulk-string-reply the value of field after the increment.

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.

HIncrByFloat(
    ctx: context.Context,
    key: Any,
    field: string,
    incr: float64
) → *FloatCmd

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.

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.

HashIncrement(
    key: Any,  // The key of the hash.
    hashField: Any,  // The field in the hash to increment.
    -value: Any,
    flags: Any  // The flags to use for this operation.
) → return  // The value at field after the increment operation.

HashIncrement(
    key: Any,  // The key of the hash.
    hashField: Any,  // The field in the hash to increment.
    -value: Any,
    flags: Any  // The flags to use for this operation.
) → return  // 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: long,  // The amount to increment by.
    flags: CommandFlags  // The flags to use for this operation.
) → long  // 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.

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.

HashIncrement(
    key: Any,  // The key of the hash.
    hashField: Any,  // The field in the hash to increment.
    -value: Any,
    flags: Any  // The flags to use for this operation.
) → return  // The value at field after the increment operation.

HashIncrement(
    key: Any,  // The key of the hash.
    hashField: Any,  // The field in the hash to increment.
    -value: Any,
    flags: Any  // The flags to use for this operation.
) → return  // 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: 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.

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.

hincrbyfloat(
    $key: string,
    $field: string,
    $increment: int|float
) → string

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.

hincrbyfloat(
    key: String,
    field: String,
    increment: Float
) → Float  // 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.

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

Increment the specified field of a hash stored at key, and representing a floating point number, by the specified increment. If the increment value is negative, the result is to have the hash field value decremented instead of incremented. If the field does not exist, it is set to 0 before performing the operation. An error is returned if one of the following conditions occur:

The key contains a value of the wrong type (not a hash).
The current field content or the specified increment are not parsable as a double precision floating point number.

The exact behavior of this command is identical to the one of the INCRBYFLOAT command, please refer to the documentation of INCRBYFLOAT for further information.

Required arguments

key

The name of the key that holds the hash.

field

The field whose value to increment.

increment

The floating-point amount to add to the field's value. A negative value decrements the field instead.

Examples

redis> HSET mykey field 10.50
(integer) 1
redis> HINCRBYFLOAT mykey field 0.1
"10.6"
redis> HINCRBYFLOAT mykey field -5
"5.6"
redis> HSET mykey field 5.0e3
(integer) 0
redis> HINCRBYFLOAT mykey field 2.0e2
"5200"

Implementation details

The command is always propagated in the replication link and the Append Only File as a HSET operation, so that differences in the underlying floating point math implementation will not be sources of inconsistency.

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

Bulk string reply: the value of the field after the increment operation.