PING - Upstash Documentation

Use PING to check that the connection and the server are alive. Without arguments the server replies PONG. With a message it echoes that message back instead, which lets a client match a reply to the exact request that produced it. PING is the standard health check for a connection pool, both to test a connection before handing it out and to keep an otherwise idle connection from being closed by intermediate proxies. It also works while the connection is subscribed to channels, where it doubles as a keepalive.

Syntax

PING [<message>]

Arguments

Argument	Required	Repeatable	Description
`<message>`	No	No	Message payload.

Important points

Without arguments the reply is PONG; with a message, the message is echoed back as a bulk string.
While the connection is subscribed under RESP2, PING replies with a two-element array holding pong and the message instead.

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 `PONG`, or the message as a bulk string; a two-element `pong`/message array while subscribed
RESP3	Simple string `PONG`, or the message as a bulk string

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

PING

@upstash/redis

import { Redis } from "@upstash/redis";

const redis = Redis.fromEnv();

const response = await redis.ping();
console.log(response); // "PONG"

upstash_redis

from upstash_redis import Redis

redis = Redis.from_env()
result = redis.ping()
print(result)

ioredis

import Redis from "ioredis";

const redis = new Redis(process.env.REDIS_URL!);
const result = await redis.ping();
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.ping();
console.log(result);

redis-py

import os
import redis

client = redis.from_url(os.environ["REDIS_URL"])
result = client.ping()
print(result)

go-redis

package main

import (
    "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.Ping(context.Background()).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.ping();
  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.ping()?;
    println!("{result:?}");
    Ok(())
}

​Syntax

​Arguments

​Important points

​Response

​Examples

Syntax

Arguments

Important points

Response

Examples