HMSET - Upstash Documentation

Warning

Prefer HSET with multiple field-value pairs in new code: HSET <key> <field> <value> [<field> <value> ...].

Use HMSET to set several field and value pairs of a hash in one call, creating the key if it does not exist.

Existing fields are overwritten and the reply is always OK, so it says nothing about what changed. HSET accepts multiple pairs as well and additionally reports how many fields were new, so prefer it in new code.

Syntax#

HMSET <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	Simple string `OK`
RESP3	Simple string `OK`

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

HMSET my-key field value

@upstash/redis

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

upstash_redis

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

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.hmset("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", mapping={"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.HMSet(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.hmset("my-key", java.util.Map.of("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_multiple("my-key", &[("field", "value")])?;    println!("{result:?}");    Ok(())}