HSET - Upstash Documentation

Use HSET to set one or more fields of a hash to the given values, creating the key when it does not exist.

Existing fields are overwritten, and the reply counts only the fields that were added, not those that were updated, which is how you tell an insert from an update. Setting fields does not touch the key's time to live, so a hash with an expiration keeps it as it is written to. A field's own expiration is a different matter: writing a field clears the TTL it may have been given by HEXPIRE or HSETEX.

Hashes are the compact way to store an object under one key: field access with HSET and HGET avoids reading and rewriting the whole value the way a serialized string would.

Syntax#

HSET <key> <field> <value> [<field> <value> ...]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<field> <value>`	Yes	Yes	Field and the value to store in it. Repeat to set several fields in one call.

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

HSET my-key field value

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.hset("key", {  id: 1,  username: "chronark",  name: "andreas"  });

upstash_redis

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

ioredis

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

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.hset("my-key", "field", "value")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.HSet(context.Background(), "my-key", "field", "value").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.hset("my-key", "field", "value");  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.hset("my-key", "field", "value")?;    println!("{result:?}");    Ok(())}