-
Notifications
You must be signed in to change notification settings - Fork 43
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
Add a page to list commands that do not exist in Redis #248
base: main
Are you sure you want to change the base?
Conversation
Made the documentation of redis commands which is not included in kvrocks documentation.
@PragmaTwice sir please review it and tell me if there is any issue in it. |
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.
@AryanSingh1112 Thank you for your contribution. I am very grateful for your help in improving our documents.
However, some commands are available in the new version of Redis, and I have marked them for you. Could you please remove them?
PS: Most of the commands we added ourselves end with X
. Thank you.
apache/kvrocks#2225 (comment)
6.1 HEXPIRE | ||
|
||
Syntax: HEXPIRE <key> <field> <seconds> | ||
Function: Sets a timeout on a hash field. | ||
Notes: Field will be removed after the timeout. | ||
|
||
|
||
6.2 HEXPIREAT | ||
|
||
Syntax: HEXPIREAT <key> <field> <timestamp> | ||
Function: Sets an expiration timestamp on a hash field. | ||
Notes: Field will be removed at the specified time. | ||
|
||
|
||
6.3 HEXPIRETIME | ||
|
||
Syntax: HEXPIRETIME <key> <field> | ||
Function: Gets the expiration time of a hash field. | ||
Notes: Returns the remaining time to live. | ||
|
||
|
||
6.4 HPERSIST | ||
|
||
Syntax: HPERSIST <key> <field> | ||
Function: Removes the expiration from a hash field. | ||
Notes: Field will no longer expire. | ||
|
||
|
||
6.5 HPEXPIRE | ||
|
||
Syntax: HPEXPIRE <key> <field> <milliseconds> | ||
Function: Sets a timeout on a hash field in milliseconds. | ||
Notes: Field will be removed after the timeout. | ||
|
||
|
||
6.6 HPTTL | ||
|
||
Syntax: HPTTL <key> <field> | ||
Function: Gets the time to live of a hash field in milliseconds. | ||
Notes: Returns the remaining time to live. | ||
|
||
|
||
6.7 HRANDFIELD | ||
|
||
Syntax: HRANDFIELD <key> [count [WITHVALUES]] | ||
Function: Gets one or more random fields from a hash. | ||
Notes: WITHVALUES option returns the field values as well. | ||
|
||
|
||
6.8 HTTL | ||
|
||
Syntax: HTTL <key> <field> | ||
Function: Gets the time to live of a hash field in seconds. | ||
Notes: Returns the remaining time to live. | ||
|
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.
https://redis.io/docs/latest/commands/hexpire/
Those commands have added to Redis at 7.4.0
|
||
|
||
|
||
8. CLUSTER COMMANDS |
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.
https://redis.io/docs/latest/commands/asking/
Those are Redis cluster commands
|
||
10. ZSET COMMANDS | ||
|
||
10.1 ZDIFF |
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.
Function: Computes the difference between multiple sorted sets. | ||
Notes: WITHSCORES option returns the scores of the resulting elements. | ||
|
||
10.2 ZDIFFSTORE |
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.
|
||
9. PUBSUB COMMANDS | ||
|
||
9.1 SPUBLISH |
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.
Notes: Provides information about function execution and memory usage. | ||
|
||
|
||
11.2 FUNCTION RESTORE |
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.
Notes: Subcommands include GETREG to get the raw register values. | ||
|
||
|
||
2. SEARCH COMMANDS |
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.
https://redis.io/docs/latest/commands/ft.aggregate/
Those are Redis stack Search commands
|
||
1. HYPERLOGLOG COMMANDS | ||
|
||
1.1 PFSELFTEST |
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.
Function: Performs a self-test of the HyperLogLog implementation. | ||
Notes: Used for debugging purposes to ensure the HyperLogLog implementation is working correctly. | ||
|
||
1.2 PFDEBUG |
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.
@@ -0,0 +1,463 @@ | |||
# Documentation for Missing Redis Commands |
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.
Add a page to list commands that do not exist in Redis
In this page, all of these commands exist in Redis.
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.
See above.
Made the documentation of redis commands which is not included in kvrocks documentation.
Please review it, if any changes are required then I am happy to solve it.