src/commands/hrandfield.json


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

{
    "HRANDFIELD": {
        "summary": "Returns one or more random fields from a hash.",
        "complexity": "O(N) where N is the number of fields returned",
        "group": "hash",
        "since": "6.2.0",
        "arity": -2,
        "function": "hrandfieldCommand",
        "command_flags": [
            "READONLY"
        ],
        "acl_categories": [
            "HASH"
        ],
        "command_tips": [
            "NONDETERMINISTIC_OUTPUT"
        ],
        "key_specs": [
            {
                "flags": [
                    "RO",
                    "ACCESS"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "reply_schema": {
            "anyOf": [
                {
                    "description": "Key doesn't exist",
                    "type": "null"
                },
                {
                    "description": "A single random field. Returned in case `COUNT` was not used.",
                    "type": "string"
                },
                {
                    "description": "A list of fields. Returned in case `COUNT` was used.",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                {
                    "description": "Fields and their values. Returned in case `COUNT` and `WITHVALUES` were used. In RESP2 this is returned as a flat array.",
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 2,
                        "maxItems": 2,
                        "items": [
                            {
                                "description": "Field",
                                "type": "string"
                            },
                            {
                                "description": "Value",
                                "type": "string"
                            }
                        ]
                    }
                }
            ]
        },
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "name": "options",
                "type": "block",
                "optional": true,
                "arguments": [
                    {
                        "name": "count",
                        "type": "integer"
                    },
                    {
                        "name": "withvalues",
                        "token": "WITHVALUES",
                        "type": "pure-token",
                        "optional": true
                    }
                ]
            }
        ]
    }
}