Modulehedis-0.16.4Haskell2010

Database.Redis.ManualCommands.CF

4 types
17 values

Packagehedis-0.16.4
Exports21
LanguageHaskell2010
LicenceBSD-3-Clause
SourceCF.hs

datadata CFInfo

Constructors

CFInfo
- cfInfoSize :: Integer
  Number of bytes allocated for the Cuckoo filter.
- cfInfoBuckets :: Integer
  Number of buckets in the filter.
- cfInfoFilters :: Integer
  Number of sub-filters.
- cfInfoItemsInserted :: Integer
  Number of inserted items tracked by the filter.
- cfInfoItemsDeleted :: Integer
  Number of deleted items tracked by the filter.
- cfInfoBucketSize :: Integer
  Number of entries per bucket.
- cfInfoExpansion :: Integer
  Expansion rate used when additional sub-filters are created.
- cfInfoMaxIterations :: Integer
  Maximum number of displacement attempts during insertion.

Instances3Eq, Show, RedisResult

Eq CFInfoDefined in hedis-0.16.4 · Database.Redis.ManualCommands.CF
Show CFInfoDefined in hedis-0.16.4 · Database.Redis.ManualCommands.CF
RedisResult CFInfoDefined in hedis-0.16.4 · Database.Redis.ManualCommands.CF

datadata CFReserveOpts

Constructors

CFReserveOpts
- cfReserveBucketSize :: Maybe Integer
  Number of entries per bucket.
- cfReserveMaxIterations :: Maybe Integer
  Maximum number of displacement attempts during insertion.
- cfReserveExpansion :: Maybe Integer
  Expansion rate for newly created sub-filters.

Instances2Eq, Show

Eq CFReserveOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.CF
Show CFReserveOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.CF

valuedefaultCFReserveOpts :: CFReserveOpts

datadata CFInsertOpts

Constructors

CFInsertOpts
- cfInsertCapacity :: Maybe Integer
  Initial capacity to use if a new filter is created.
- cfInsertNoCreate :: Bool
  Return an error instead of creating the filter when the key does not exist.

Instances2Eq, Show

Eq CFInsertOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.CF
Show CFInsertOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.CF

valuedefaultCFInsertOpts :: CFInsertOpts

datadata CFInsertResult

CFInsertAdded CFInsertAlreadyExists CFInsertFilterFull

Instances3Eq, Show, RedisResult

Eq CFInsertResultDefined in hedis-0.16.4 · Database.Redis.ManualCommands.CF
Show CFInsertResultDefined in hedis-0.16.4 · Database.Redis.ManualCommands.CF
RedisResult CFInsertResultDefined in hedis-0.16.4 · Database.Redis.ManualCommands.CF

valuecfReserveOptsToArgs :: CFReserveOpts -> [ByteString]

valuecfInsertOptsToArgs :: CFInsertOpts -> [ByteString]

valuecfadd

:: RedisCtx m f
=> ByteString
Key of the Cuckoo filter.
-> ByteString
Item to add.
-> m (f Bool)

Adds an item to a Cuckoo filter (https://redis.io/commands/cf.add).

A filter is created automatically if the key does not exist.

O(k + i), where k is the number of sub-filters and i is maxIterations.

Since RedisBloom 1.0.0

valuecfaddnx

:: RedisCtx m f
=> ByteString
Key of the Cuckoo filter.
-> ByteString
Item to add.
-> m (f Bool)

Adds an item to a Cuckoo filter only if it did not already exist (https://redis.io/commands/cf.addnx).

A filter is created automatically if the key does not exist.

O(k + i), where k is the number of sub-filters and i is maxIterations.

Since RedisBloom 1.0.0

valuecfcount

:: RedisCtx m f
=> ByteString
Key of the Cuckoo filter.
-> ByteString
Item to count.
-> m (f Integer)

Returns the number of times an item might appear in a Cuckoo filter (https://redis.io/commands/cf.count).

Returns 0 when the key does not exist or the item was not found.

O(k), where k is the number of sub-filters.

Since RedisBloom 1.0.0

valuecfdel

:: RedisCtx m f
=> ByteString
Key of the Cuckoo filter.
-> ByteString
Item to delete.
-> m (f Bool)

Deletes an item from a Cuckoo filter (https://redis.io/commands/cf.del).

Returns False when the key does not exist or the item was not found.

O(k), where k is the number of sub-filters.

Since RedisBloom 1.0.0

valuecfexists

:: RedisCtx m f
=> ByteString
Key of the Cuckoo filter.
-> ByteString
Item to check.
-> m (f Bool)

Checks whether an item may exist in a Cuckoo filter (https://redis.io/commands/cf.exists).

Returns False when the key does not exist or the item is definitely absent.

O(k), where k is the number of sub-filters.

Since RedisBloom 1.0.0

valuecfinfo

:: RedisCtx m f
=> ByteString
Key of the Cuckoo filter.
-> m (f CFInfo)

Returns information about a Cuckoo filter (https://redis.io/commands/cf.info).

O(1)

Since RedisBloom 1.0.0

valuecfinsert

:: RedisCtx m f
=> ByteString
Key of the Cuckoo filter.
-> NonEmpty ByteString
Items to add.
-> m (f [CFInsertResult])

Adds one or more items to a Cuckoo filter, creating it when needed (https://redis.io/commands/cf.insert).

This is equivalent to inserting with default options and automatic creation enabled.

O(n * (k + i)), where n is the number of items, k is the number of sub-filters, and i is maxIterations.

Since RedisBloom 1.0.0

valuecfinsertOpts

:: RedisCtx m f
=> ByteString
Key of the Cuckoo filter.
-> NonEmpty ByteString
Items to add.
-> CFInsertOpts
Optional creation parameters.
-> m (f [CFInsertResult])

Adds one or more items to a Cuckoo filter, creating it when needed (https://redis.io/commands/cf.insert).

O(n * (k + i)), where n is the number of items, k is the number of sub-filters, and i is maxIterations.

Since RedisBloom 1.0.0

valuecfinsertnx

:: RedisCtx m f
=> ByteString
Key of the Cuckoo filter.
-> NonEmpty ByteString
Items to add.
-> m (f [CFInsertResult])

Adds one or more items to a Cuckoo filter only if they did not already exist (https://redis.io/commands/cf.insertnx).

This is equivalent to inserting with default options and automatic creation enabled.

O(n * (k + i)), where n is the number of items, k is the number of sub-filters, and i is maxIterations.

Since RedisBloom 1.0.0

valuecfinsertnxOpts

:: RedisCtx m f
=> ByteString
Key of the Cuckoo filter.
-> NonEmpty ByteString
Items to add.
-> CFInsertOpts
Optional creation parameters.
-> m (f [CFInsertResult])

Adds one or more items to a Cuckoo filter only if they did not already exist (https://redis.io/commands/cf.insertnx).

O(n * (k + i)), where n is the number of items, k is the number of sub-filters, and i is maxIterations.

Since RedisBloom 1.0.0

valuecfmexists

:: RedisCtx m f
=> ByteString
Key of the Cuckoo filter.
-> NonEmpty ByteString
Items to check.
-> m (f [Bool])

Checks whether one or more items may exist in a Cuckoo filter (https://redis.io/commands/cf.mexists).

A False result means the item is definitely absent, or the key does not exist.

O(k * n), where k is the number of sub-filters and n is the number of items.

Since RedisBloom 1.0.0

valuecfreserve

:: RedisCtx m f
=> ByteString
Key of the Cuckoo filter to create.
-> Integer
Initial capacity.
-> m (f Status)

Creates an empty Cuckoo filter (https://redis.io/commands/cf.reserve).

The filter will fail if the key already exists.

O(1)

Since RedisBloom 1.0.0

valuecfreserveOpts

:: RedisCtx m f
=> ByteString
Key of the Cuckoo filter to create.
-> Integer
Initial capacity.
-> CFReserveOpts
Bucket and scaling options.
-> m (f Status)

Creates an empty Cuckoo filter (https://redis.io/commands/cf.reserve).

O(1)

Since RedisBloom 1.0.0