Skip to content

Commit 1f8993a

Browse files
Simon Prickettleibale
andauthored
Adds Bloom overview README. (#1850)
* Adds Bloom overview README. * Update README.md * Incorporates feedback. * Update README.md Co-authored-by: Leibale Eidelman <[email protected]>
1 parent 2ff7084 commit 1f8993a

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

packages/bloom/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
11
# @node-redis/bloom
22

3-
The source code and documentation for this package are in the main [node-redis](https://github.com/redis/node-redis) repo.
3+
This package provides support for the [RedisBloom](https://redisbloom.io) module, which adds additional probabilistic data structures to Redis. It extends the [Node Redis client](https://github.com/redis/node-redis) to include functions for each of the RediBloom commands.
4+
5+
To use these extra commands, your Redis server must have the RedisBloom module installed.
6+
7+
RedisBloom provides the following probabilistic data structures:
8+
9+
* Bloom Filter: for checking set membership with a high degree of certainty.
10+
* Cuckoo Filter: for checking set membership with a high degree of certainty.
11+
* Count-Min Sketch: Determine the frequency of events in a stream.
12+
* Top-K: Maintain a list of k most frequently seen items.
13+
14+
For complete examples, see `bloom-filter.js`, `cuckoo-filter.js`, `count-min-sketch.js` and `topk.js` in the Node Redis examples folder.

0 commit comments

Comments
 (0)