Upstash Documentation

HEXISTS

Check if a hash field exists.
2 min read

Use HEXISTS to check whether a field is present in a hash.

The reply is 1 when the field exists and 0 when either the field or the key is missing. Since the value is never transferred, this is the cheap way to test for presence, and it is also how you tell a missing field apart from a field whose value happens to be empty, which HGET cannot do.

Syntax#

Arguments#

ArgumentRequiredRepeatableDescription
<key>YesNoRedis key targeted by the command.
<field>YesNoHash field name.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

ProtocolReply
RESP2Integer: 1 if the field exists, 0 otherwise
RESP3Integer: 1 if the field exists, 0 otherwise
Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI
@upstash/redis
upstash_redis
ioredis
node-redis
redis-py
go-redis
jedis
redis-rs