HSETNX

Syntax text Syntax diagram API methods

HSETNX key field value

Client:

hsetnx(
    name: str,
    key: str,
    value: str
) → Union[Awaitable[bool], bool]

HSETNX(
    key: RedisArgument,
    field: RedisArgument,
    value: RedisArgument
) → Any

hsetnx(
    key: byte[],
    field: byte[],
    value: byte[]
) → long  // If the field already exists, 0 is returned, otherwise if a new field is created 1 is returned.

hsetnx(
    key: String,
    field: String,
    value: String
) → long  // If the field already exists, 0 is returned, otherwise if a new field is created 1 is returned.

hsetnx(
    key: K,  // the key.
    field: K,  // the field type: key.
    value: V  // the value.
) → Boolean  // Boolean integer-reply specifically: 1 if field is a new field in the hash and value was set. 0 if field already exists in the hash and no operation was performed.

hsetnx(
    key: K,  // the key.
    field: K,  // the field type: key.
    value: V  // the value.
) → RedisFuture<Boolean>  // Boolean integer-reply specifically: 1 if field is a new field in the hash and value was set. 0 if field already exists in the hash and no operation was performed.

hsetnx(
    key: K,  // the key.
    field: K,  // the field type: key.
    value: V  // the value.
) → Mono<Boolean>  // Boolean integer-reply specifically: 1 if field is a new field in the hash and value was set. 0 if field already exists in the hash and no operation was performed.

HSetNX(
    ctx: context.Context,
    key: Any,
    field: string,
    value: interface{}
) → *BoolCmd

hsetnx(
    $key: string,
    $field: string,
    $value: string
) → int

hset_nx(
    key: K,
    field: F,
    value: V
) → (bool)

hset_nx(
    key: K,
    field: F,
    value: V
) → (bool)

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

Sets field in the hash stored at key to value, only if field does not yet exist. If key does not exist, a new key holding a hash is created. If field already exists, this operation has no effect.

Required arguments

key

The name of the key that holds the hash.

field

The field to set, only if it does not already exist.

value

The value to set.

Examples

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

One of the following:

Integer reply: 0 if the field already exists in the hash and no operation was performed.
Integer reply: 1 if the field is a new field in the hash and the value was set.