GETBIT - Upstash Documentation

Use GETBIT to read a single bit of the string stored at a key.

The offset is counted in bits from the start of the value, so offset 0 is the most significant bit of the first byte. When the key does not exist, or the offset lies past the end of the stored string, the bit reads as 0 rather than producing an error.

Syntax#

GETBIT <key> <offset>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<offset>`	Yes	No	Zero-based bit offset to read.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Integer: the bit at the offset, `0` or `1`
RESP3	Integer: the bit at the offset, `0` or `1`

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

GETBIT my-key 0

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const bit = await redis.getbit(key, 4);

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.getbit("my-key", 0)print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.getbit("my-key", "0");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.getBit("my-key", 0);console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.getbit("my-key", 0)print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    result, err := client.GetBit(context.Background(), "my-key", 0).Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.getbit("my-key", 0);  System.out.println(result);}

redis-rs

use redis::TypedCommands;fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let result = connection.getbit("my-key", 0)?;    println!("{result:?}");    Ok(())}