Bloom Filter Datatype for Redis
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

ReBloom - 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

CircleCI

Quick Start Guide

  1. Launch ReBloom with Docker
  2. Use Rebloom 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 ReBloom with Docker

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

2. Use ReBloom with redis-cli

docker exec -it redis-rebloom 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 ReBloom

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