CLIENT-SETNAME(3valkey)

📦
version 9.0.6 · 2 versions
, in fedora 44

✨ CLIENT-SETNAME ✨

okay bestie, welcome to the valkey command manual, CLIENT-SETNAME edition 💖 this one's short, sweet, and lowkey iconic.

🌸 NAME 🌸

client-setname — gives your connection a little name tag 🎀

🦋 SYNOPSIS 🦋

CLIENT SETNAME connection-name

💜 DESCRIPTION 💜

So basically, CLIENT SETNAME slaps a name onto the current connection. That's it. That's the whole job. 👑

And why do we care? Because that name you just gave it shows up in the output of valkey-client-list(7) CLIENT LIST — so now you can actually tell which client did a thing on a given connection. no more mystery connections, we love to see it 🔥

fr fr, picture this: you're using Valkey to implement a queue, and your producers and consumers both want to announce their whole role in life by naming their connection accordingly. now they can. main character energy for every connection 💅

Now for the deets:

  • There's no limit to how long the name can be — beyond the usual limits of the String type, that's 512 MB. go off, write a novel, we support you 📚
  • BUT you can't use spaces in a connection name, because that would violate the format of the CLIENT LIST reply. sorry babe, no spaces. 😭
  • You can completely remove the connection name by setting it to the empty string — and fun fact, the empty string is not a valid connection name, precisely because it serves this one specific purpose. it's the "no name" name 🫶
  • Wanna peek at what the name currently is? Use valkey-client-getname(7) CLIENT GETNAME. 👀
  • Every brand-new connection starts out with no assigned name. fresh start, no baggage ✨
💡 Tip: naming your connections is a genuinely great way to debug connection leaks caused by bugs in the application using Valkey. yes bestie, name them and catch the leaky ones 🔍

🌈 REPLY 🌈

valkey-protocol(7) Simple string reply: OK if the connection name was successfully set. 🎉

⭐ COMPLEXITY ⭐

O(1) — constant time, instant, no thoughts required, we love efficiency 💫

🎀 ACL CATEGORIES 🎀

@connection @slow

🦄 HISTORY 🦄

  • Available since: 2.6.9

👑 SEE ALSO 👑

and that's a wrap, bestie 🫶 this page is from Valkey 9.0.0, dated 2025-10-21. go name those connections, you absolute legend 💖✨

📦 where this page comes from