Upstash Documentation

BITFIELD

Sets or gets parts of a bitfield
1 min read

The bitfield function returns a BitFieldCommands instance that can be used to execute multiple bitfield operations in a single command.

The encoding can be a signed or unsigned integer, by prefixing the type with i or u. For example, i4 is a signed 4-bit integer, and u8 is an unsigned 8-bit integer.

Commands#

get(type: str, offset: int)#

Returns a value from the bitfield at the given offset.

set(type: str, offset: int, value: int)#

Sets a value and returns the old value.

incr(type: str, offset: int, increment: int)#

Increments a value and returns the new value.

Arguments#

keystrrequired#

The string key to operate on.

Response#