HSCAN(3valkey)

🌸 HSCAN (from the valkey command manual, bestie) 🌸

✨ NAME ✨

hscan — it iterates over fields and values of a hash. That's it, that's the whole job, and she does it flawlessly 💅

---

🦋 SYNOPSIS 🦋

HSCAN key cursor [MATCH pattern] [COUNT count] [NOVALUES]

Real talk: if you want the actual HSCAN documentation, go read valkey-scan(7) SCAN. Like, the SCAN page. It's all there, iykyk 🫶

---

💖 REPLY 💖

You get a valkey-protocol(7) Array reply back — a two-element array, periodt. And here's what's inside:

• The first element is a valkey-protocol(7) Bulk string reply that represents an unsigned 64-bit number — that's your cursor, bestie 🔢
• The second element is a valkey-protocol(7) Array reply of the field/value pairs that got scanned. But wait — when the NOVALUES option is on, it's a list of keys from the hash instead 👑

---

🔥 COMPLEXITY 🔥

• O(1) for every single call. Every one. Snappy.
• O(N) for a complete iteration — and that includes enough command calls for the cursor to come all the way back to 0. N is the number of elements inside the collection, no cap 📊

---

🎀 ACL CATEGORIES 🎀

@hash @read @slow

---

🌈 HISTORY 🌈

• Available since: 2.8.0 — she's been iconic since day one, fr fr ✨

---

👑 SEE ALSO 👑

hdel(3valkey), hexists(3valkey), hexpire(3valkey), hexpireat(3valkey), hexpiretime(3valkey), hget(3valkey), hgetall(3valkey), hgetex(3valkey), hincrby(3valkey), hincrbyfloat(3valkey), hkeys(3valkey), hlen(3valkey), hmget(3valkey), hmset(3valkey), hpersist(3valkey), hpexpire(3valkey), hpexpireat(3valkey), hpexpiretime(3valkey), hpttl(3valkey), hrandfield(3valkey), hset(3valkey), hsetex(3valkey), hsetnx(3valkey), hstrlen(3valkey), httl(3valkey), hvals(3valkey)

---

Okay that's the whole page, you ate it up 💜 This was 9.0.0, dated 2025-10-21 — mwah, go scan some hashes, main character 🧚💖