getbit.3valkey - Man Page

Returns a bit value by offset.

Synopsis

GETBIT key offset

Description

Returns the bit value at offset in the string value stored at key.

When offset is beyond the string length, the string is assumed to be a contiguous space with 0 bits. When key does not exist it is assumed to be an empty string, so offset is always out of range and the value is also assumed to be a contiguous space with 0 bits.

Reply

The bit value stored at offset, one of the following:

Complexity

O(1)

Acl Categories

@bitmap @fast @read

History

Examples

127.0.0.1:6379> SETBIT mykey 7 1
(integer) 0
127.0.0.1:6379> GETBIT mykey 0
(integer) 0
127.0.0.1:6379> GETBIT mykey 7
(integer) 1
127.0.0.1:6379> GETBIT mykey 100
(integer) 0

See Also

bitcount(3valkey), bitfield(3valkey), bitfield_ro(3valkey), bitop(3valkey), bitpos(3valkey), setbit(3valkey)

Info

2024-09-23 8.0.0 Valkey Command Manual