Data.RedisBloom

A bloom filter for the Redis in-memory store.

Bloom filter configuration

Fundamental types

newtype HashCount

Number of hashes to use in a bloom filter.

Constructors

HashCount Int

Instances

Bounded HashCount

Enum HashCount

Eq HashCount

Integral HashCount

Num HashCount

Ord HashCount

Real HashCount

Show HashCount

Generic HashCount

type Rep HashCount

newtype Capacity

Capacity of a bloom filter.

Constructors

Capacity Int

Instances

Enum Capacity

Eq Capacity

Integral Capacity

Num Capacity

Ord Capacity

Real Capacity

Show Capacity

Generic Capacity

type Rep Capacity

type Key = ByteString

Redis Key

Static bloom filter configuration

data Bloom a

Bloom filter static configuration. To use suggested values based on the desired false-positive rate and capacity, use suggestCreate.

Constructors

Bloom

Fields

key :: !Key

The key to store the bloom filter under.

capacity :: !Capacity

Bloom filter capacity, i.e. the number of bits used.

hf :: HashFamily a

The hash family associated with the bloom filter. See hashFamilyFNV and hashFamilySimple

Bloom filter operations

createBF :: RedisCtx m (Either Reply) => Bloom a -> m (Either Reply Status)

Create a new bloom filter with the specified configuration.

createIfNewBF :: RedisCtx m (Either Reply) => Bloom a -> m (Either Reply Bool)

Create a new bloom filter with the specified configuration if the specified key does not yet exist.

addBF :: RedisCtx m f => Bloom a -> a -> m ()

Add an element to an existing bloom filter.

queryBF :: (MonadRedis m, RedisCtx m (Either Reply)) => Bloom a -> a -> m Bool

Query whether an element exists in the bloom filter.

Gracefully fails upon failure by returning False.