[](https://github.com/RedisBloom/RedisBloom/releases/latest) [](https://circleci.com/gh/RedisBloom/RedisBloom) [](https://img.shields.io/docker/pulls/redis/redis-stack-server) [](https://codecov.io/gh/RedisBloom/RedisBloom) # RedisBloom: Probabilistic Data Structures for Redis [](https://forum.redis.com/c/modules/redisbloom) [](https://discord.gg/wXhwjCQ) <img src="docs/docs/images/logo.svg" alt="logo" width="300"/> ## Overview RedisBloom adds a set of probabilistic data structures to Redis, including Bloom filter, Cuckoo filter, Count-min sketch, Top-K, and t-digest. Using this capability, you can query streaming data without needing to store all the elements of the stream. Probabilistic data structures each answer the following questions: - Bloom filter and Cuckoo filter: - Did value _v_ already appear in the data stream? - Count-min sketch: - How many times did value _v_ appear in the data stream? - Top-k: - What are the _k_ most frequent values in the data stream? - t-digest: - Which fraction of the values in the data stream are smaller than a given value? - How many values in the data stream are smaller than a given value? - Which value is smaller than _p_ percent of the values in the data stream? (What is the _p_-percentile value?) - What is the mean value between the _p1_-percentile value and the _p2_-percentile value? - What is the value of the *n*ᵗʰ smallest/largest value in the data stream? (What is the value with [reverse] rank _n_?) Answering each of these questions accurately can require a huge amount of memory, but you can lower the memory requirements drastically at the cost of reduced accuracy. Each of these data structures allows you to set a controllable trade-off between accuracy and memory consumption. In addition to having a smaller memory footprint, probabilistic data structures are generally much faster than accurate algorithms. RedisBloom is part of [Redis Stack](https://github.com/redis-stack). ### How do I Redis? [Learn for free at Redis University](https://university.redis.com/) [Build faster with the Redis Launchpad](https://launchpad.redis.com/) [Try the Redis Cloud](https://redis.com/try-free/) [Dive in developer tutorials](https://developer.redis.com/) [Join the Redis community](https://redis.com/community/) [Work at Redis](https://redis.com/company/careers/jobs/) ## Setup You can either get RedisBloom setup in a Docker container or on your own machine. ### Docker To quickly try out RedisBloom, launch an instance using docker: ```sh docker run -p 6379:6379 -it --rm redis/redis-stack-server:latest ``` ### Build it yourself You can also build RedisBloom on your own machine. Major Linux distributions as well as macOS are supported. First step is to have Redis installed, of course. The following, for example, builds Redis on a clean Ubuntu docker image (`docker pull ubuntu`): ``` mkdir ~/Redis cd ~/Redis apt-get update -y && apt-get upgrade -y apt-get install -y wget make pkg-config build-essential wget https://download.redis.io/redis-stable.tar.gz tar -xzvf redis-stable.tar.gz cd redis-stable make distclean make make install ``` Next, you should get the RedisBloom repository from git and build it: ``` apt-get install -y git cd ~/Redis git clone --recursive https://github.com/RedisBloom/RedisBloom.git cd RedisBloom ./sbin/setup bash -l make ``` Then `exit` to exit bash. **Note:** to get a specific version of RedisBloom, e.g. 2.4.5, add `-b v2.4.5` to the `git clone` command above. Next, run `make run -n` and copy the full path of the RedisBloom executable (e.g., `/root/Redis/RedisBloom/bin/linux-x64-release/redisbloom.so`). Next, add RedisBloom module to `redis.conf`, so Redis will load when started: ``` apt-get install -y vim cd ~/Redis/redis-stable vim redis.conf ``` Add: `loadmodule /root/Redis/RedisBloom/bin/linux-x64-release/redisbloom.so` under the MODULES section (use the full path copied above). Save and exit vim (ESC :wq ENTER) For more information about modules, go to the [Redis official documentation](https://redis.io/topics/modules-intro). ### Run Run redis-server in the background and then redis-cli: ``` cd ~/Redis/redis-stable redis-server redis.conf & redis-cli ``` ## Give it a try After you setup RedisBloom, you can interact with it using redis-cli. Create a new bloom filter by adding a new item: ``` # 127.0.0.1:6379> BF.ADD newFilter foo (integer) 1 ``` Find out whether an item exists in the filter: ``` # 127.0.0.1:6379> BF.EXISTS newFilter foo (integer) 1 ``` In this case, `1` means that the `foo` is most likely in the set represented by `newFilter`. But recall that false positives are possible with Bloom filters. ``` # 127.0.0.1:6379> BF.EXISTS newFilter bar (integer) 0 ``` A value `0` means that `bar` is definitely not in the set. Bloom filters do not allow for false negatives. ## Client libraries | Project | Language | License | Author | Stars | Package | Comment | | ------- | -------- | ------- | ------ | ----- | ------- | ------- | | [jedis][jedis-url] | Java | MIT | [Redis][redis-url] | ![Stars][jedis-stars] | [Maven][jedis-package]|| | [redis-py][redis-py-url] | Python | MIT | [Redis][redis-url] | ![Stars][redis-py-stars] | [pypi][redis-py-package]|| | [node-redis][node-redis-url] | Node.JS | MIT | [Redis][redis-url] | ![Stars][node-redis-stars] | [npm][node-redis-package]|| | [nredisstack][nredisstack-url] | .NET | MIT | [Redis][redis-url] | ![Stars][nredisstack-stars] | [nuget][nredisstack-package]|| | redisbloom-go | Go | BSD | [Redis](https://redis.com) |  | [GitHub](https://github.com/RedisBloom/redisbloom-go) || | rueidis | Go | Apache License 2.0 | [Rueian](https://github.com/rueian) |  | [GitHub](https://github.com/rueian/rueidis) || | rebloom | JavaScript | MIT | [Albert Team](https://cvitae.now.sh/) |  |[GitHub](https://github.com/albert-team/rebloom) || | phpredis-bloom | PHP | MIT | [Rafa Campoy](https://github.com/averias) |  | [GitHub](https://github.com/averias/phpredis-bloom) || | phpRebloom | PHP | MIT | [Alessandro Balasco](https://github.com/palicao) |  | [GitHub](https://github.com/palicao/phpRebloom) || | vertx-redis-client | Java | Apache License 2.0 | [Eclipse Vert.x](https://github.com/vert-x3) |  | [GitHub](https://github.com/vert-x3/vertx-redis-client) || | rustis | Rust | MIT | [Dahomey Technologies](https://github.com/dahomey-technologies) |  | [GitHub](https://github.com/dahomey-technologies/rustis) | [redis-url]: https://redis.com [redis-py-url]: https://github.com/redis/redis-py [redis-py-stars]: https://img.shields.io/github/stars/redis/redis-py.svg?style=social&amp;label=Star&amp;maxAge=2592000 [redis-py-package]: https://pypi.python.org/pypi/redis [jedis-url]: https://github.com/redis/jedis [jedis-stars]: https://img.shields.io/github/stars/redis/jedis.svg?style=social&amp;label=Star&amp;maxAge=2592000 [Jedis-package]: https://search.maven.org/artifact/redis.clients/jedis [nredisstack-url]: https://github.com/redis/nredisstack [nredisstack-stars]: https://img.shields.io/github/stars/redis/nredisstack.svg?style=social&amp;label=Star&amp;maxAge=2592000 [nredisstack-package]: https://www.nuget.org/packages/nredisstack/ [node-redis-url]: https://github.com/redis/node-redis [node-redis-stars]: https://img.shields.io/github/stars/redis/node-redis.svg?style=social&amp;label=Star&amp;maxAge=2592000 [node-redis-package]: https://www.npmjs.com/package/redis ## Documentation Documentation and full command reference at [redisbloom.io](http://redisbloom.io). ## Mailing List / Forum Got questions? Feel free to ask at the [RedisBloom mailing list](https://forum.redis.com/c/modules/redisbloom). ## License RedisBloom is licensed under the [Redis Source Available License 2.0 (RSALv2)](https://redis.com/legal/rsalv2-agreement) or the [Server Side Public License v1 (SSPLv1)](https://www.mongodb.com/licensing/server-side-public-license).