> ## Documentation Index
> Fetch the complete documentation index at: https://upstash.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# BITOP

> Perform bitwise operations between strings.

Use `BITOP` to combine several strings with a bitwise operation and store the result in another key.

Source strings are combined bit by bit, and shorter ones are treated as if they were padded with zero bits up to the length of the longest input, so the destination always ends up as long as the longest source. A missing key counts as an empty string, and if the result is empty the destination key is deleted. The reply is the length of the stored value in bytes.

`AND`, `OR`, and `XOR` accept any number of source keys and `NOT` accepts exactly one. The remaining operators compare the first key with the rest: `DIFF` keeps the bits set in the first key and in none of the others, `DIFF1` keeps the bits set in at least one of the other keys but not in the first, `ANDOR` keeps the bits set in the first key and in at least one of the others, and `ONE` keeps the bits set in exactly one of the source keys. `DIFF`, `DIFF1`, and `ANDOR` each require at least two source keys.

This is how bitmaps are used as sets: with one bit per user, `AND` gives users present in every bitmap and `OR` gives users present in any of them, and [`BITCOUNT`](/docs/redis/commands/bitmap/bitcount) then turns the result into a number.

## Syntax

```redis theme={"system"}
BITOP (AND | OR | XOR | NOT | DIFF | DIFF1 | ANDOR | ONE) <destkey> <key> [<key> ...]
```

## Arguments

| Argument                                                     | Required | Repeatable | Description                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ------------------------------------------------------------ | -------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `(AND \| OR \| XOR \| NOT \| DIFF \| DIFF1 \| ANDOR \| ONE)` | Yes      | No         | The bitwise operation to apply. `AND`, `OR`, and `XOR` combine any number of source keys and `NOT` inverts exactly one. The rest compare the first key with the others: `DIFF` keeps bits set in the first key and in none of the others, `DIFF1` keeps bits set in at least one of the others but not in the first, `ANDOR` keeps bits set in the first key and in at least one of the others, and `ONE` keeps bits set in exactly one source key. |
| `<destkey>`                                                  | Yes      | No         | Redis key used as destkey.                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `<key>`                                                      | Yes      | Yes        | Redis key targeted by the command.                                                                                                                                                                                                                                                                                                                                                                                                                  |

## 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 |
| RESP3    | Integer |

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

## Examples

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

<AccordionGroup>
  <Accordion title="Redis CLI" icon="terminal">
    ```bash theme={"system"}
    BITOP AND destination-key source-key-1 source-key-2
    ```
  </Accordion>

  <Accordion title="@upstash/redis" icon="node-js" iconType="brands">
    ```ts theme={"system"}
    import { Redis } from "@upstash/redis";

    const redis = Redis.fromEnv();

    // AND operation
    await redis.bitop("and", "destKey", "sourceKey1", "sourceKey2");

    // OR operation
    await redis.bitop("or", "destKey", "sourceKey1", "sourceKey2");

    // XOR operation
    await redis.bitop("xor", "destKey", "sourceKey1", "sourceKey2");

    // NOT operation (only accepts one source key)
    await redis.bitop("not", "destKey", "sourceKey");
    ```
  </Accordion>

  <Accordion title="upstash_redis" icon="python" iconType="brands">
    ```python theme={"system"}
    from upstash_redis import Redis

    redis = Redis.from_env()
    result = redis.bitop("AND", "destination-key", "source-key-1", "source-key-2")
    print(result)
    ```
  </Accordion>

  <Accordion title="ioredis" icon="node-js" iconType="brands">
    ```ts theme={"system"}
    import Redis from "ioredis";

    const redis = new Redis(process.env.REDIS_URL!);
    const result = await redis.bitop("AND", "destination-key", "source-key-1", "source-key-2");
    console.log(result);
    ```
  </Accordion>

  <Accordion title="node-redis" icon="node-js" iconType="brands">
    ```ts theme={"system"}
    import { createClient } from "redis";

    const client = await createClient({ url: process.env.REDIS_URL })
      .on("error", console.error)
      .connect();
    const result = await client.bitOp("AND", "destination-key", ["source-key-1", "source-key-2"]);
    console.log(result);
    ```
  </Accordion>

  <Accordion title="redis-py" icon="python" iconType="brands">
    ```python theme={"system"}
    import os
    import redis

    client = redis.from_url(os.environ["REDIS_URL"])
    result = client.bitop("AND", "destination-key", "source-key-1", "source-key-2")
    print(result)
    ```
  </Accordion>

  <Accordion title="go-redis" icon="golang" iconType="brands">
    ```go theme={"system"}
    package main

    import (
        "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.BitOpAnd(context.Background(), "destination-key", "source-key-1", "source-key-2").Result()
        if err != nil {
            panic(err)
        }
        fmt.Println(result)
    }
    ```
  </Accordion>

  <Accordion title="jedis" icon="java" iconType="brands">
    ```java theme={"system"}
    import java.net.URI;

    import redis.clients.jedis.Jedis;

    try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {
      Object result = jedis.bitop(redis.clients.jedis.args.BitOP.AND, "destination-key", "source-key-1", "source-key-2");
      System.out.println(result);
    }
    ```
  </Accordion>

  <Accordion title="redis-rs" icon="rust" iconType="brands">
    ```rust theme={"system"}
    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.bit_and("destination-key", &["source-key-1", "source-key-2"])?;
        println!("{result:?}");
        Ok(())
    }
    ```
  </Accordion>
</AccordionGroup>


## Related topics

- [BITOP](/docs/redis/sdks/py/commands/bitmap/bitop.md)
- [Changelog](/docs/redis/overall/changelog.md)
- [REST API](/docs/redis/features/restapi.md)
- [SETBIT](/docs/redis/commands/bitmap/setbit.md)
