hscan.3valkey - Man Page
Iterates over fields and values of a hash.
Synopsis
HSCAN key cursor [MATCH pattern] [COUNT count] [NOVALUES]
See valkey-scan(7) SCAN for HSCAN documentation.
Reply
valkey-protocol(7) Array reply: a two-element array.
- The first element is a valkey-protocol(7) Bulk string reply that represents an unsigned 64-bit number, the cursor.
- The second element is an valkey-protocol(7) Array reply of field/value pairs that were scanned. When
NOVALUESoption is on, a list of keys from the hash.
Complexity
O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.
Acl Categories
@hash @read @slow
History
- Available since: 2.8.0
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)