summaryrefslogtreecommitdiffstats
path: root/src/commands/unlink.json
blob: a05704a1b3f2c21516b32cedb64e26cd70911e19 (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
{
    "UNLINK": {
        "summary": "Asynchronously deletes one or more keys.",
        "complexity": "O(1) for each key removed regardless of its size. Then the command does O(N) work in a different thread in order to reclaim memory, where N is the number of allocations the deleted objects where composed of.",
        "group": "generic",
        "since": "4.0.0",
        "arity": -2,
        "function": "unlinkCommand",
        "command_flags": [
            "WRITE",
            "FAST"
        ],
        "acl_categories": [
            "KEYSPACE"
        ],
        "command_tips": [
            "REQUEST_POLICY:MULTI_SHARD",
            "RESPONSE_POLICY:AGG_SUM"
        ],
        "key_specs": [
            {
                "flags": [
                    "RM",
                    "DELETE"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": -1,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0,
                "multiple": true
            }
        ],
        "reply_schema": {
            "description": "the number of keys that were unlinked",
            "type": "integer",
            "minimum": 0
        }
    }
}