ECHO - Upstash Documentation

Use ECHO to have the server send the given message back unchanged.

The command performs no work beyond the round trip, which makes it a simple way to verify that a connection is alive and that values survive the client library's encoding and decoding. For plain liveness checks PING is the more common choice.

Syntax#

ECHO <message>

Arguments#

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

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	Bulk string
RESP3	Bulk string

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

ECHO hello

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const response = await redis.echo("hello world");console.log(response); // "hello world"

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.echo("hello")print(result)

ioredis

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

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.echo("hello")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.Echo(context.Background(), "hello").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.echo("hello");  System.out.println(result);}

redis-rs

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 mut command = redis::cmd("ECHO");    command.arg("hello");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}