https://github.com/snawoot/cuckoo-filter-redis
Set of Lua stored functions implementing Cuckoo Filter backed by Redis.
https://github.com/snawoot/cuckoo-filter-redis
cuckoo-filter redis redis-lua redis-lua-script
Last synced: about 1 month ago
JSON representation
Set of Lua stored functions implementing Cuckoo Filter backed by Redis.
- Host: GitHub
- URL: https://github.com/snawoot/cuckoo-filter-redis
- Owner: Snawoot
- Created: 2020-05-07T18:18:15.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-09T22:00:29.000Z (over 4 years ago)
- Last Synced: 2025-01-26T06:11:16.228Z (3 months ago)
- Topics: cuckoo-filter, redis, redis-lua, redis-lua-script
- Language: Lua
- Homepage:
- Size: 5.86 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
cuckoo-filter-redis
===================
Set of Lua stored functions implementing [Cuckoo Filter](https://www.cs.cmu.edu/~dga/papers/cuckoo-conext2014.pdf) backed by Redis.
---
:heart: :heart: :heart:
You can say thanks to the author by donations to these wallets:
- ETH: `0xB71250010e8beC90C5f9ddF408251eBA9dD7320e`
- BTC:
- Legacy: `1N89PRvG1CSsUk9sxKwBwudN6TjTPQ1N8a`
- Segwit: `bc1qc0hcyxc000qf0ketv4r44ld7dlgmmu73rtlntw`
---
## Requirements
* Redis 3.2 or newer
## Usage
All commands illustrated using `redis-cli` utility. Of course you may use EVAL/EVALSHA commands provided by Redis interface for your programming language.
### Initialize
Initialize Cuckoo Filter with 8388608 buckets with 4 elements containing 73-bit fingerprints, backed by redis key with name `cf`:
```
redis-cli --eval cf_init.lua cf , 8388608 4 73
```
Response: true upon success
### Insert
Add some elements:
```
redis-cli --eval cf_insert.lua cf , elem1 elem2 very_long_element_number_3
```
Response: true or false for each element upon success
### Lookup
Check for elements existence:
```
redis-cli --eval cf_lookup.lua cf , elem2 elem3
```
Response: true or false for each element if corresponding element found in table
### Delete
Delete element from Cuckoo Filter:
```
redis-cli --eval cf_delete.lua cf , elem1
```
Response: true or false for each element if corresponding element existed in table before.