CLIENT SETINFO - Upstash Documentation

Use CLIENT SETINFO to attach library identification to the current connection.

LIB-NAME records the name of the client library and LIB-VER its version. Both values then appear in CLIENT INFO and CLIENT LIST output, which makes it possible to tell which application or SDK version owns a connection. Most client libraries send this during the handshake, so applications rarely call it themselves.

Syntax#

CLIENT SETINFO <LIB-NAME | LIB-VER> <value>

Arguments#

Argument	Required	Repeatable	Description
`LIB-NAME \| LIB-VER`	Yes	No	Attribute to update: the client library name or version.
`value`	Yes	No	Value to store for the selected client attribute.

Important points#

This is a connection-oriented command and is available over native Redis TCP, not the stateless REST endpoint.
This command can expose administrative information or make a broad destructive change. Restrict it to trusted code paths.

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

CLIENT SETINFO LIB-NAME my-client

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.call("CLIENT", "SETINFO", "LIB-NAME", "my-client");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.sendCommand(["CLIENT", "SETINFO", "LIB-NAME", "my-client"]);console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.client_setinfo("LIB-NAME", "my-client")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.Do(context.Background(), "CLIENT", "SETINFO", "LIB-NAME", "my-client").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.clientSetInfo(redis.clients.jedis.args.ClientAttributeOption.LIB_NAME, "my-client");  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("CLIENT");    command.arg("SETINFO");    command.arg("LIB-NAME");    command.arg("my-client");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}