src/commands/ttl.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

{
    "TTL": {
        "summary": "Returns the expiration time in seconds of a key.",
        "complexity": "O(1)",
        "group": "generic",
        "since": "1.0.0",
        "arity": 2,
        "function": "ttlCommand",
        "history": [
            [
                "2.8.0",
                "Added the -2 reply."
            ]
        ],
        "command_flags": [
            "READONLY",
            "FAST"
        ],
        "acl_categories": [
            "KEYSPACE"
        ],
        "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": {
            "oneOf": [
                {
                    "description": "TTL in seconds.",
                    "type": "integer",
                    "minimum": 0
                },
                {
                    "description": "The key exists but has no associated expire.",
                    "const": -1
                },
                {
                    "description": "The key does not exist.",
                    "const": -2
                }
            ]
        },
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            }
        ]
    }
}