PSETEX - Upstash Documentation

Warning

Prefer SET with the PX argument in new code: SET <key> <value> PX <milliseconds>.

Use PSETEX to set a value together with a lifetime in milliseconds.

The value and the expiration are applied in the same atomic step, so the key never exists without its expiration, which is the point of the command: setting the value and then expiring it separately leaves a window where a crash makes the key permanent. A lifetime of zero or less returns an error.

It is the millisecond form of SETEX, and SET with the PX option is the more flexible way to write the same thing.

Syntax#

PSETEX <key> <milliseconds> <value>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<milliseconds>`	Yes	No	Lifetime in milliseconds.
`<value>`	Yes	No	String value to store.

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

PSETEX my-key 1000 value

@upstash/redis

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

upstash_redis

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

ioredis

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

redis-py

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

go-redis

package mainimport (    "context"    "fmt"    "os"    "time"    "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.Set(context.Background(), "my-key", "value", time.Second).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.psetex("my-key", 1000, "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.pset_ex("my-key", "value", 1000)?;    println!("{result:?}");    Ok(())}