-
Notifications
You must be signed in to change notification settings - Fork 29
chore: add cf.add and cf.addnx docs #541
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kostasrim
wants to merge
1
commit into
kcuckoo1
Choose a base branch
from
kcuckoo2
base: kcuckoo1
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| description: Learn how to use the CF.ADD command to add an item to a Cuckoo filter in Dragonfly. | ||
| --- | ||
| import PageTitle from '@site/src/components/PageTitle'; | ||
|
|
||
| # CF.ADD | ||
|
|
||
| <PageTitle title="Redis CF.ADD Command (Documentation) | Dragonfly" /> | ||
|
|
||
| ## Syntax | ||
|
|
||
| CF.ADD key item | ||
|
|
||
| **Time complexity:** O(k + i), where k is the number of sub-filters and i is `MAXITERATIONS` | ||
|
|
||
| **ACL categories:** @cuckoo | ||
|
|
||
| Adds a single `item` to the Cuckoo filter at `key`. | ||
| If `key` does not exist, a new filter is created with default parameters. | ||
|
|
||
| Unlike [`CF.ADDNX`](./cf.addnx.md), duplicate insertions are allowed — the same item can be added multiple times and will occupy a separate slot each time. | ||
| Use `CF.DEL` once per insertion to remove it. | ||
|
|
||
| If the filter is full and expansion is disabled (`EXPANSION 0`), an error is returned. | ||
|
|
||
| ## Return | ||
|
|
||
| [Integer reply](https://valkey.io/topics/protocol/#integers): | ||
|
|
||
| - `1` if the item was successfully added. | ||
| - `0` if the filter is full and could not be expanded. | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell | ||
| dragonfly> CF.ADD cf Hello | ||
| (integer) 1 | ||
|
|
||
| dragonfly> CF.ADD cf Hello | ||
| (integer) 1 | ||
|
|
||
| dragonfly> CF.COUNT cf Hello | ||
| (integer) 2 | ||
| ``` | ||
|
|
||
| ## See also | ||
|
|
||
| [`CF.ADDNX`](./cf.addnx.md) | [`CF.RESERVE`](./cf.reserve.md) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| description: Learn how to use the CF.ADDNX command to add an item to a Cuckoo filter only if it does not already exist. | ||
| --- | ||
| import PageTitle from '@site/src/components/PageTitle'; | ||
|
|
||
| # CF.ADDNX | ||
|
|
||
| <PageTitle title="Redis CF.ADDNX Command (Documentation) | Dragonfly" /> | ||
|
|
||
| ## Syntax | ||
|
|
||
| CF.ADDNX key item | ||
|
|
||
| **Time complexity:** O(k + i), where k is the number of sub-filters and i is `MAXITERATIONS` | ||
|
|
||
| **ACL categories:** @cuckoo | ||
|
|
||
| Adds a single `item` to the Cuckoo filter at `key` only if it does not already exist. | ||
| If `key` does not exist, a new filter is created with default parameters. | ||
|
|
||
| Unlike [`CF.ADD`](./cf.add.md), this command checks for the item before inserting. | ||
| Because Cuckoo filters can return false positives, `CF.ADDNX` may decline to insert | ||
| an item that was never actually added. | ||
|
|
||
| If the filter is full and expansion is disabled (`EXPANSION 0`), an error is returned. | ||
|
|
||
| ## Return | ||
|
|
||
| [Integer reply](https://valkey.io/topics/protocol/#integers): | ||
|
|
||
| - `1` if the item was successfully added. | ||
| - `0` if the item already exists in the filter (or is a false positive match). | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell | ||
| dragonfly> CF.ADDNX cf Hello | ||
| (integer) 1 | ||
|
|
||
| dragonfly> CF.ADDNX cf Hello | ||
| (integer) 0 | ||
|
|
||
| dragonfly> CF.ADDNX cf World | ||
| (integer) 1 | ||
| ``` | ||
|
|
||
| ## See also | ||
|
|
||
| [`CF.ADD`](./cf.add.md) | [`CF.RESERVE`](./cf.reserve.md) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. cf.add.md import before h1
📘 Rule violation⚙ MaintainabilityAgent Prompt
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools