Safe Haskell	Trustworthy
Language	Haskell2010

Data.RedisBloom

Contents

Bloom filter configuration
- Fundamental types
- Static bloom filter configuration
Bloom filter operations

Description

A bloom filter for the Redis in-memory store.

Synopsis

newtype HashCount = HashCount Int
newtype Capacity = Capacity Int
type Key = ByteString
data Bloom a = Bloom {
- key :: !Key
- capacity :: !Capacity
- hf :: HashFamily a
}
createBF :: RedisCtx m (Either Reply) => Bloom a -> m (Either Reply Status)
createIfNewBF :: RedisCtx m (Either Reply) => Bloom a -> m (Either Reply Bool)
addBF :: RedisCtx m f => Bloom a -> a -> m ()
queryBF :: (MonadRedis m, RedisCtx m (Either Reply)) => Bloom a -> a -> m Bool

Bloom filter configuration

Fundamental types

newtype HashCount Source #

Number of hashes to use in a bloom filter.

Constructors

HashCount Int

Instances

Bounded HashCount Source #
Instance details Defined in Data.RedisBloom.Internal Methods minBound :: HashCount maxBound :: HashCount
Enum HashCount Source #
Instance details Defined in Data.RedisBloom.Internal Methods succ :: HashCount -> HashCount pred :: HashCount -> HashCount toEnum :: Int -> HashCount fromEnum :: HashCount -> Int enumFrom :: HashCount -> [HashCount] enumFromThen :: HashCount -> HashCount -> [HashCount] enumFromTo :: HashCount -> HashCount -> [HashCount] enumFromThenTo :: HashCount -> HashCount -> HashCount -> [HashCount]
Eq HashCount Source #
Instance details Defined in Data.RedisBloom.Internal Methods (==) :: HashCount -> HashCount -> Bool (/=) :: HashCount -> HashCount -> Bool
Integral HashCount Source #
Instance details Defined in Data.RedisBloom.Internal Methods quot :: HashCount -> HashCount -> HashCount rem :: HashCount -> HashCount -> HashCount div :: HashCount -> HashCount -> HashCount mod :: HashCount -> HashCount -> HashCount quotRem :: HashCount -> HashCount -> (HashCount, HashCount) divMod :: HashCount -> HashCount -> (HashCount, HashCount) toInteger :: HashCount -> Integer
Num HashCount Source #
Instance details Defined in Data.RedisBloom.Internal Methods (+) :: HashCount -> HashCount -> HashCount (-) :: HashCount -> HashCount -> HashCount (*) :: HashCount -> HashCount -> HashCount negate :: HashCount -> HashCount abs :: HashCount -> HashCount signum :: HashCount -> HashCount fromInteger :: Integer -> HashCount
Ord HashCount Source #
Instance details Defined in Data.RedisBloom.Internal Methods compare :: HashCount -> HashCount -> Ordering (<) :: HashCount -> HashCount -> Bool (<=) :: HashCount -> HashCount -> Bool (>) :: HashCount -> HashCount -> Bool (>=) :: HashCount -> HashCount -> Bool max :: HashCount -> HashCount -> HashCount min :: HashCount -> HashCount -> HashCount
Real HashCount Source #
Instance details Defined in Data.RedisBloom.Internal Methods toRational :: HashCount -> Rational
Show HashCount Source #
Instance details Defined in Data.RedisBloom.Internal Methods showsPrec :: Int -> HashCount -> ShowS show :: HashCount -> String showList :: [HashCount] -> ShowS
Generic HashCount Source #
Instance details Defined in Data.RedisBloom.Internal Associated Types type Rep HashCount :: Type -> Type Methods from :: HashCount -> Rep HashCount x to :: Rep HashCount x -> HashCount
type Rep HashCount Source #
Instance details Defined in Data.RedisBloom.Internal type Rep HashCount = D1 (MetaData "HashCount" "Data.RedisBloom.Internal" "bloomfilter-redis-0.1.0.4-inplace" True) (C1 (MetaCons "HashCount" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

newtype Capacity Source #

Capacity of a bloom filter.

Constructors

Capacity Int

Instances

Enum Capacity Source #
Instance details Defined in Data.RedisBloom.Internal Methods succ :: Capacity -> Capacity pred :: Capacity -> Capacity toEnum :: Int -> Capacity fromEnum :: Capacity -> Int enumFrom :: Capacity -> [Capacity] enumFromThen :: Capacity -> Capacity -> [Capacity] enumFromTo :: Capacity -> Capacity -> [Capacity] enumFromThenTo :: Capacity -> Capacity -> Capacity -> [Capacity]
Eq Capacity Source #
Instance details Defined in Data.RedisBloom.Internal Methods (==) :: Capacity -> Capacity -> Bool (/=) :: Capacity -> Capacity -> Bool
Integral Capacity Source #
Instance details Defined in Data.RedisBloom.Internal Methods quot :: Capacity -> Capacity -> Capacity rem :: Capacity -> Capacity -> Capacity div :: Capacity -> Capacity -> Capacity mod :: Capacity -> Capacity -> Capacity quotRem :: Capacity -> Capacity -> (Capacity, Capacity) divMod :: Capacity -> Capacity -> (Capacity, Capacity) toInteger :: Capacity -> Integer
Num Capacity Source #
Instance details Defined in Data.RedisBloom.Internal Methods (+) :: Capacity -> Capacity -> Capacity (-) :: Capacity -> Capacity -> Capacity (*) :: Capacity -> Capacity -> Capacity negate :: Capacity -> Capacity abs :: Capacity -> Capacity signum :: Capacity -> Capacity fromInteger :: Integer -> Capacity
Ord Capacity Source #
Instance details Defined in Data.RedisBloom.Internal Methods compare :: Capacity -> Capacity -> Ordering (<) :: Capacity -> Capacity -> Bool (<=) :: Capacity -> Capacity -> Bool (>) :: Capacity -> Capacity -> Bool (>=) :: Capacity -> Capacity -> Bool max :: Capacity -> Capacity -> Capacity min :: Capacity -> Capacity -> Capacity
Real Capacity Source #
Instance details Defined in Data.RedisBloom.Internal Methods toRational :: Capacity -> Rational
Show Capacity Source #
Instance details Defined in Data.RedisBloom.Internal Methods showsPrec :: Int -> Capacity -> ShowS show :: Capacity -> String showList :: [Capacity] -> ShowS
Generic Capacity Source #
Instance details Defined in Data.RedisBloom.Internal Associated Types type Rep Capacity :: Type -> Type Methods from :: Capacity -> Rep Capacity x to :: Rep Capacity x -> Capacity
type Rep Capacity Source #
Instance details Defined in Data.RedisBloom.Internal type Rep Capacity = D1 (MetaData "Capacity" "Data.RedisBloom.Internal" "bloomfilter-redis-0.1.0.4-inplace" True) (C1 (MetaCons "Capacity" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

type Key = ByteString Source #

Redis Key

Static bloom filter configuration

data Bloom a Source #

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) Source #

Create a new bloom filter with the specified configuration.

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

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 () Source #

Add an element to an existing bloom filter.

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

Query whether an element exists in the bloom filter.

Gracefully fails upon failure by returning False.