> ## Documentation Index
> Fetch the complete documentation index at: https://upstash.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# HGETALL

> Get all fields and values.

Use `HGETALL` to read every field and value of a hash in one call.

The reply pairs each field with its value. RESP2 flattens it into a single alternating array while RESP3 returns a map, and client libraries normally decode either form into a native dictionary. A missing key returns an empty result rather than an error.

The whole hash is transferred, so on hashes with many fields prefer [`HMGET`](/docs/redis/commands/hash/hmget) when you know which fields you need, or [`HSCAN`](/docs/redis/commands/hash/hscan) to walk the hash in batches.

## Syntax

```redis theme={"system"}
HGETALL <key>
```

## Arguments

| Argument | Required | Repeatable | Description |
| - | - | - | - |
| `<key>` | Yes | No | Redis key targeted by the command. |

## Important points

* Pair-based results may be flattened into one alternating array in RESP2 while RESP3 preserves nested pairs or a map.

## 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.

| Protocol | Reply |
| - | - |
| RESP2 | Flat array of alternating keys and values |
| RESP3 | Map |

> [!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**
>
> ```bash theme={"system"}
> HGETALL my-key
> ```

> **@upstash/redis**
>
> ```ts theme={"system"}
> import { Redis } from "@upstash/redis";
>
> const redis = Redis.fromEnv();
>
> await redis.hset("key", {
>   field1: "value1",
>   field2: "value2",
>   });
> const hash = await redis.hgetall("key");
> console.log(hash); // { field1: "value1", field2: "value2" }
> ```

> **upstash\_redis**
>
> ```python theme={"system"}
> from upstash_redis import Redis
>
> redis = Redis.from_env()
> result = redis.hgetall("my-key")
> print(result)
> ```

> **ioredis**
>
> ```ts theme={"system"}
> import Redis from "ioredis";
>
> const redis = new Redis(process.env.REDIS_URL!);
> const result = await redis.hgetall("my-key");
> console.log(result);
> ```

> **node-redis**
>
> ```ts theme={"system"}
> import { createClient } from "redis";
>
> const client = await createClient({ url: process.env.REDIS_URL })
>   .on("error", console.error)
>   .connect();
> const result = await client.hGetAll("my-key");
> console.log(result);
> ```

> **redis-py**
>
> ```python theme={"system"}
> import os
> import redis
>
> client = redis.from_url(os.environ["REDIS_URL"])
> result = client.hgetall("my-key")
> print(result)
> ```

> **go-redis**
>
> ```go theme={"system"}
> package main
>
> import (
>     "context"
>     "fmt"
>     "os"
>
>     "github.com/redis/go-redis/v9"
> )
>
> func main() {
>     opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))
>     if err != nil {
>         panic(err)
>     }
>     client := redis.NewClient(opts)
>     result, err := client.HGetAll(context.Background(), "my-key").Result()
>     if err != nil {
>         panic(err)
>     }
>     fmt.Println(result)
> }
> ```

> **jedis**
>
> ```java theme={"system"}
> import java.net.URI;
>
> import redis.clients.jedis.Jedis;
>
> try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {
>   Object result = jedis.hgetAll("my-key");
>   System.out.println(result);
> }
> ```

> **redis-rs**
>
> ```rust theme={"system"}
> use redis::TypedCommands;
>
> fn main() -> redis::RedisResult<()> {
>     let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");
>     let client = redis::Client::open(url)?;
>     let mut connection = client.get_connection()?;
>
>     let result = connection.hgetall("my-key")?;
>     println!("{result:?}");
>     Ok(())
> }
> ```


## Related topics

- [HGETALL](/docs/redis/sdks/ts/commands/hash/hgetall.md)
- [HGET](/docs/redis/commands/hash/hget.md)
- [HMGET](/docs/redis/commands/hash/hmget.md)
- [HELLO](/docs/redis/commands/connection/hello.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.