HGET - Upstash Documentation

Use HGET to read the value of a single field of a hash.

The reply is null when either the field or the whole key is missing, so the two cases cannot be told apart from the reply alone; use HEXISTS when that difference matters. To read several fields use HMGET rather than repeated calls, and to read all of them use HGETALL.

Syntax#

HGET <key> <field>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<field>`	Yes	No	Hash 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.

Protocol	Reply
RESP2	Bulk string or Null bulk string or null array
RESP3	Bulk string or Null

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

HGET my-key field

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.hset("key", {field: "value"});const field = await redis.hget("key", "field");console.log(field); // "value"

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.hget("my-key", "field")print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.hget("my-key", "field");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.hGet("my-key", "field");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.hget("my-key", "field")print(result)

go-redis

package mainimport (    "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.HGet(context.Background(), "my-key", "field").Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.hget("my-key", "field");  System.out.println(result);}

redis-rs

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.hget("my-key", "field")?;    println!("{result:?}");    Ok(())}