HSTRLEN - Upstash Documentation

Use HSTRLEN to get the length in bytes of the value stored in a hash field.

The reply is 0 when either the field or the key is missing. Since the value itself is not transferred, this is how you check the size of a large field, or decide whether it is worth fetching, without paying for it.

Syntax#

HSTRLEN <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	Integer
RESP3	Integer

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

HSTRLEN my-key field

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const length = await redis.hstrlen("key", "field")

upstash_redis

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

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.hstrlen("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.hStrLen("my-key", "field");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.hstrlen("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.HStrLen(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.hstrlen("my-key", "field");  System.out.println(result);}

redis-rs

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 mut command = redis::cmd("HSTRLEN");    command.arg("my-key");    command.arg("field");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}