futriix/src/commands/zrevrangebyscore.json
Itamar Haber 0c3b8b7e90
Overhauls command summaries and man pages. (#11942)
This is an attempt to normalize/formalize command summaries.

Main actions performed:

* Starts with the continuation of the phrase "The XXXX command, when called, ..." for user commands.
* Starts with "An internal command...", "A container command...", etc... when applicable.
* Always uses periods.
* Refrains from referring to other commands. If this is needed, backquotes should be used for command names.
* Tries to be very clear about the data type when applicable.
* Tries to mention additional effects, e.g. "The key is created if it doesn't exist" and "The set is deleted if the last member is removed."
* Prefers being terse over verbose.
* Tries to be consistent.
2023-03-29 20:48:59 +03:00

119 lines
3.7 KiB
JSON

{
"ZREVRANGEBYSCORE": {
"summary": "Returns members in a sorted set within a range of scores in reverse order.",
"complexity": "O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).",
"group": "sorted_set",
"since": "2.2.0",
"arity": -4,
"function": "zrevrangebyscoreCommand",
"history": [
[
"2.1.6",
"`min` and `max` can be exclusive."
]
],
"deprecated_since": "6.2.0",
"replaced_by": "`ZRANGE` with the `REV` and `BYSCORE` arguments",
"doc_flags": [
"DEPRECATED"
],
"command_flags": [
"READONLY"
],
"acl_categories": [
"SORTEDSET"
],
"key_specs": [
{
"flags": [
"RO",
"ACCESS"
],
"begin_search": {
"index": {
"pos": 1
}
},
"find_keys": {
"range": {
"lastkey": 0,
"step": 1,
"limit": 0
}
}
}
],
"reply_schema": {
"anyOf": [
{
"type": "array",
"description": "List of the elements in the specified score range, as not WITHSCORES",
"uniqueItems": true,
"items": {
"type": "string",
"description": "Element"
}
},
{
"type": "array",
"description": "List of the elements and their scores in the specified score range, as WITHSCORES used",
"uniqueItems": true,
"items": {
"type": "array",
"description": "Tuple of element and its score",
"minItems": 2,
"maxItems": 2,
"items": [
{
"type": "string",
"description": "element"
},
{
"type": "number",
"description": "score"
}
]
}
}
]
},
"arguments": [
{
"name": "key",
"type": "key",
"key_spec_index": 0
},
{
"name": "max",
"type": "double"
},
{
"name": "min",
"type": "double"
},
{
"name": "withscores",
"token": "WITHSCORES",
"type": "pure-token",
"optional": true
},
{
"token": "LIMIT",
"name": "limit",
"type": "block",
"optional": true,
"arguments": [
{
"name": "offset",
"type": "integer"
},
{
"name": "count",
"type": "integer"
}
]
}
]
}
}