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

HKEYS

Syntax text Syntax diagram API methods

HKEYS key

Client:

hkeys(
    name: str
) → Union[Awaitable[List], List]

HKEYS(
    key: RedisArgument
) → Any

hkeys(
    key: String
) → Set<String>  // All the fields names contained into a hash.

hkeys(
    key: K  // the key.
) → List<K>  // Long count of the keys.

hkeys(
    channel: KeyStreamingChannel<K>,  // the channel.
    key: K  // the key.
) → Long  // Long count of the keys.

hkeys(
    key: K  // the key.
) → RedisFuture<List<K>>  // Long count of the keys.

hkeys(
    channel: KeyStreamingChannel<K>,  // the channel.
    key: K  // the key.
) → RedisFuture<Long>  // Long count of the keys.

hkeys(
    key: K  // the key.
) → Flux<K>  // Long count of the keys. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #hkeys.

hkeys(
    channel: KeyStreamingChannel<K>,  // the channel.
    key: K  // the key.
) → Mono<Long>  // Long count of the keys. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #hkeys.

HKeys(
    ctx: context.Context,
    key: string
) → *StringSliceCmd

HashKeys(
    key: RedisKey,  // The key of the hash.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue[]  // List of fields in the hash, or an empty list when key does not exist.

HashKeys(
    key: RedisKey,  // The key of the hash.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue[]  // List of fields in the hash, or an empty list when key does not exist.

HashKeys(
    key: RedisKey,  // The key of the hash.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue[]  // List of fields in the hash, or an empty list when key does not exist.

HashKeys(
    key: RedisKey,  // The key of the hash.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue[]  // List of fields in the hash, or an empty list when key does not exist.

hkeys(
    $key: string
) → array

hkeys(
    key: K
) → (Vec<String>)

hkeys(
    key: K
) → (Vec<String>)

Available since:: Redis Open Source 2.0.0
Time complexity:: O(N) where N is the size of the hash.
ACL categories:: @read, @hash, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Returns all field names in the hash stored at key.

Required arguments

key

The name of the key that holds the hash.

Examples

redis> HSET myhash field1 "Hello"
(integer) 1
redis> HSET myhash field2 "World"
(integer) 1
redis> HKEYS myhash
1) "field1"
2) "field2"

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

Array reply: a list of fields in the hash, or an empty list when the key does not exist