Skip to content
Bloom Filter and Cuckoo Filter Datatype for Redis
Branch: master
Clone or download
Latest commit e1bf9c9 Mar 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Update documentation deployment May 21, 2018
contrib
docs Adds complexity detail Mar 13, 2019
src update version to 1.1.1 Feb 21, 2019
tests Minor fixes to docker process May 9, 2018
.clang-format Add clang-format file Dec 25, 2017
.gitignore
Dockerfile
LICENSE
Makefile
README.md Update README.md Mar 7, 2019
mkdocs.yml Update mkdocs.yml Feb 21, 2019
ramp.yml

README.md

GitHub issues CircleCI DockerHub

RedisBloom - Bloom Filter Module for Redis

This module provides two probabalistic data structures as Redis data types: Bloom Filters and Cuckoo Filters. These two structures are similar in their purpose but have different performance and functionality characteristics

Quick Start Guide

  1. Launch RedisBloom with Docker
  2. Use RedisBloom with redis-cli

Note: You can also build and load the module yourself.

You can find a command reference in Bloom_Commands.md

1. Launch RedisBloom with Docker

docker run -p 6379:6379 --name redis-redisbloom redislabs/rebloom:latest

2. Use RedisBloom with redis-cli

docker exec -it redis-redisbloom bash

# redis-cli
# 127.0.0.1:6379> 

Start a new bloom filter by adding a new item

# 127.0.0.1:6379> BF.ADD newFilter foo
(integer) 1

Checking if an item exists in the filter

# 127.0.0.1:6379> BF.EXISTS newFilter foo
(integer) 1

Building and Loading RedisBloom

In order to use this module, build it using make and load it into Redis.

Loading

Invoking redis with the module loaded

$ redis-server --loadmodule /path/to/rebloom.so

You can find a command reference in docs/Bloom_Commands.md

Documentation

Read the docs at redisbloom.io.

License

Redis Source Available License Agreement - see LICENSE

You can’t perform that action at this time.