summaryrefslogtreecommitdiffstats
path: root/src/commands/sort_ro.json
blob: 04cc3c8417a419508400321d5e69ba86899175a2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
{
    "SORT_RO": {
        "summary": "Returns the sorted elements of a list, a set, or a sorted set.",
        "complexity": "O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N).",
        "group": "generic",
        "since": "7.0.0",
        "arity": -2,
        "function": "sortroCommand",
        "get_keys_function": "sortROGetKeys",
        "command_flags": [
            "READONLY"
        ],
        "acl_categories": [
            "SET",
            "SORTEDSET",
            "LIST",
            "DANGEROUS"
        ],
        "key_specs": [
            {
                "flags": [
                    "RO",
                    "ACCESS"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            },
            {
                "notes": "For the optional BY/GET keyword. It is marked 'unknown' because the key names derive from the content of the key we sort",
                "flags": [
                    "RO",
                    "ACCESS"
                ],
                "begin_search": {
                    "unknown": null
                },
                "find_keys": {
                    "unknown": null
                }
            }
        ],
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "token": "BY",
                "name": "by-pattern",
                "display": "pattern",
                "type": "pattern",
                "key_spec_index": 1,
                "optional": true
            },
            {
                "token": "LIMIT",
                "name": "limit",
                "type": "block",
                "optional": true,
                "arguments": [
                    {
                        "name": "offset",
                        "type": "integer"
                    },
                    {
                        "name": "count",
                        "type": "integer"
                    }
                ]
            },
            {
                "token": "GET",
                "name": "get-pattern",
                "display": "pattern",
                "key_spec_index": 1,
                "type": "pattern",
                "optional": true,
                "multiple": true,
                "multiple_token": true
            },
            {
                "name": "order",
                "type": "oneof",
                "optional": true,
                "arguments": [
                    {
                        "name": "asc",
                        "type": "pure-token",
                        "token": "ASC"
                    },
                    {
                        "name": "desc",
                        "type": "pure-token",
                        "token": "DESC"
                    }
                ]
            },
            {
                "name": "sorting",
                "token": "ALPHA",
                "type": "pure-token",
                "optional": true
            }
        ],
        "reply_schema": {
            "description": "a list of sorted elements",
            "type": "array",
            "items": {
                "oneOf": [
                    {
                        "type": "string"
                    },
                    {
                        "description": "GET option is specified, but no object was found",
                        "type": "null"
                    }
                ]
            }
        }
    }
}