HGETALL
HGETALL key
- Group
- Hash
- Complexity
- O(N) where N is the size of the hash
- Arity
- 2 (exactly, counting the command name)
- Flags
- read-only
- Keys
- first 1, last 1, step 1
- HotKV Cloud
- All plans
- On-Premise
- no license needed
HGETALL returns every field of the hash stored at key together with its
value. The order is not defined. For large hashes, prefer
HSCAN.
Return value
Section titled “Return value”| Case | RESP2 | RESP3 |
|---|---|---|
| Hash exists | Flat array: field, value, field, value, … | Map of field to value |
| Key does not exist | Empty array | Empty map |
HGETALL replies with a WRONGTYPE error if key holds a value that is not
a hash.
Examples
Section titled “Examples”127.0.0.1:6379> HSET user:1 name "Ada" lang "en"(integer) 2127.0.0.1:6379> HGETALL user:11) "name"2) "Ada"3) "lang"4) "en"With RESP3 (redis-cli -3):
127.0.0.1:6379> HGETALL user:11# "name" => "Ada"2# "lang" => "en"Compatibility
Section titled “Compatibility”Same as Redis 7.4 and Valkey 8.
See also
Section titled “See also”HKEYS, HVALS, HMGET, HSCAN, HRANDFIELD
Was this page helpful?
Thanks for the feedback.