PERSIST - Upstash Documentation

Use PERSIST to remove the expiration from a key so that it stops being deleted automatically and lives until it is removed explicitly.

The reply is 1 when an expiration was removed and 0 when the key does not exist or had no expiration to begin with. This is how a value gets promoted from temporary to permanent without rewriting it, for example when a trial record becomes a persistent one.

Syntax#

PERSIST <key>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.

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: `1` if the timeout was removed, `0` otherwise
RESP3	Integer: `1` if the timeout was removed, `0` otherwise

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

PERSIST my-key

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.persist(key);

upstash_redis

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

ioredis

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

redis-py

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