Skip to content
HotKVDocs

Ask the HotKV docs

Answers come only from these docs and can be wrong; check the linked pages before you rely on them.

GETBIT

Last updated 
GETBIT key offset
Group
Bitmap
Complexity
O(1)
Arity
3 (exactly, counting the command name)
Flags
read-only, fast
Keys
first 1, last 1, step 1
HotKV Cloud
All plans
On-Premise
no license needed

GETBIT returns the bit at offset in the string at key. Bit 0 is the most significant bit of the first byte. Bits past the end of the string, and every bit of a missing key, read as 0. offset must be at least 0 and below the number of bits in the largest allowed string (2^32 with the default proto-max-bulk-len of 512 MB).

Return value

Section titled “Return value”
Case RESP2 RESP3
Always Integer: 0 or 1 Integer

Errors:

  • ERR bit offset is not an integer or out of range for a bad offset.
  • WRONGTYPE when the key holds a value that is not a string.

Examples

Section titled “Examples”
127.0.0.1:6379> SETBIT flags 7 1
(integer) 0
127.0.0.1:6379> GETBIT flags 7
(integer) 1
127.0.0.1:6379> GETBIT flags 100
(integer) 0
127.0.0.1:6379> GETBIT missing 0
(integer) 0

Compatibility

Section titled “Compatibility”

Same as Redis 7 and Valkey 8.

See also

Section titled “See also”

SETBIT, BITCOUNT, BITFIELD_RO