A .NET client library for RedisBloom probabilistic module, based on StackExchange.Redis.
This project contains a .NET library abstracting the API of the RedisBloom Redis module, that provides four data structures: a scalable bloom filter, a cuckoo filter, a count-min sketch, and a top-k.
See redisbloom.io for installation instructions of the module and documentation about the available commands.
- Redis server 4.0+ version (Redis Modules are only available from Redis 4.0+)
- RedisBloom Module installed on Redis server as specified in Building and running
PM> Install-Package NRedisBloom// Create redis connection
var muxer = ConnectionMultiplexer.Connect(options);
var db = muxer.GetDatabase();
// Bloom Filter commands
var bloomFilter = new BloomFilterClient(db);
await bloomFilter.ReserveAsync(key, capacity, errorRate);
await bloomFilter.AddAsync(key, item);
await bloomFilter.AddMultipleAsync(key, item, item2);
await bloomFilter.InsertAsync(key, insertOptions, item, item2);
await bloomFilter.ExistsAsync(key, item);
await bloomFilter.ExistsMultipleAsync(key, item);
await bloomFilter.ScanDumpAsync(key, iterator);
await bloomFilter.LoadChunkAsync(key, iterator, dumpData);
await bloomFilter.InfoAsync(key);
// Cuckoo Filter commands
var cuckooFilter = new CuckooFilterClient(db);
await cuckooFilter.ReserveAsync(key, capacity);
await cuckooFilter.AddAsync(key, item);
await cuckooFilter.AddAdvancedAsync(key, item);
await cuckooFilter.InsertAsync(key, insertOptions, item, item2);
await cuckooFilter.InsertAdvanced(key, insertOptions, item, item2);
await cuckooFilter.ExistsAsync(key, item);
await cuckooFilter.DeleteAsync(key, item);
await cuckooFilter.CountAsync(key, item);
await cuckooFilter.ScanDumpAsync(key, iterator);
await cuckooFilter.LoadChunkAsync(key, iterator, dumpData);
await cuckooFilter.InfoAsync(key);
// Count-Min Sketch commands
var countMinSketch = new CountMinSketchClient(db);
await countMinSketch.InitByDimAsync(key, width, depth);
await countMinSketch.InitByProbAsync(key, error, probability);
await countMinSketch.IncrByAsync(key, item, increment);
await countMinSketch.QueryAsync(key, item);
await countMinSketch.MergeAsync(destinationKey, sourceKey);
await countMinSketch.InfoAsync(key);
// Top-K commands
var topk = new TopKClient(db);
await topk.ReserveAsync(key, topk, width, depth, decay);
await topk.AddAsync(key, item);
await topk.IncrementByAsync(key, item, increment);
await topk.QueryAsync(key, item);
await topk.CountAsync(key, item);
await topk.ListAsync(key);
await topk.InfoAsync(key);There are a suite of tests in the repository that should be sufficient to serve as examples on how to use all supported commands.
If you think you have found a bug or have a feature request, please report an issue, or if appropriate, submit a pull request. If you have a question, feel free to contact me.