Skip to content

Key Commands

Bases: BaseCommand

Mixin for Redis Key-level commands (e.g. EXISTS, DEL, EXPIRE, TTL, TYPE).

Source code in pyredis/commands/key.py 
  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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
class Key(BaseCommand):
    """Mixin for Redis Key-level commands (e.g. EXISTS, DEL, EXPIRE, TTL, TYPE)."""

    def __init__(self):
        super().__init__()

    def delete(self, *args):
        if self._cluster:
            return self.execute(
                *[b"DEL", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"DEL", *args]
        )

    def dump(self, *args):
        if self._cluster:
            return self.execute(
                *[b"DUMP", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"DUMP", *args]
        )

    def exists(self, *args):
        if self._cluster:
            return self.execute(
                *[b"EXISTS", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"EXISTS", *args]
        )

    def expire(self, *args):
        if self._cluster:
            return self.execute(
                *[b"EXPIRE", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"EXPIRE", *args]
        )

    def expireat(self, *args):
        if self._cluster:
            return self.execute(b"EXPIREAT")
        return self.execute(
            *[b"EXPIREAT", *args]
        )

    def keys(self, *args, shard_key=None, sock=None):
        if self._cluster:
            return self.execute(
                *[b"KEYS", *args],
                shard_key=shard_key,
                sock=sock
            )
        return self.execute(
            *[b"KEYS", *args]
        )

    def migrate(self, *args):
        if self._cluster:
            raise NotImplementedError
        return self.execute(
            *[b"MIGRATE", *args]
        )

    def move(self, *args):
        if self._cluster:
            return self.execute(
                *[b"MOVE", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"MOVE", *args]
        )

    def object(self, *args, shard_key=None, sock=None):
        if self._cluster:
            return self.execute(
                *[b"DEL", *args],
                shard_key=shard_key,
                sock=sock
            )
        return self.execute(
            *[b"OBJECT", *args]
        )

    def persist(self, *args):
        if self._cluster:
            return self.execute(
                *[b"PERSIST", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"PERSIST", *args]
        )

    def pexpire(self, *args):
        if self._cluster:
            return self.execute(
                *[b"PEXPIRE", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"PEXPIRE", *args]
        )

    def pexpireat(self, *args):
        if self._cluster:
            return self.execute(
                *[b"PEXPIREAT", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"PEXPIREAT", *args]
        )

    def pttl(self, *args):
        if self._cluster:
            return self.execute(
                *[b"PTTL", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"PTTL", *args]
        )

    def randomkey(self, *args, shard_key=None, sock=None):
        if self._cluster:
            return self.execute(
                *[b"RANDOMKEY", *args],
                shard_key=shard_key,
                sock=sock
            )
        return self.execute(
            *[b"RANDOMKEY", *args]
        )

    def rename(self, *args):
        if self._cluster:
            return self.execute(
                *[b"RENAME", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"RENAME", *args]
        )

    def renamenx(self, *args):
        if self._cluster:
            return self.execute(
                *[b"RENAMENX", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"RENAMENX", *args]
        )

    def restore(self, *args):
        if self._cluster:
            return self.execute(
                *[b"RESTORE", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"RESTORE", *args]
        )

    def scan(self, *args, shard_key=None, sock=None):
        if self._cluster:
            return self.execute(
                *[b"SCAN", *args],
                shard_key=shard_key,
                sock=sock
            )
        return self.execute(
            *[b"SCAN", *args]
        )

    def sort(self, *args):
        if self._cluster:
            return self.execute(
                *[b"SORT", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"SORT", *args]
        )

    def ttl(self, *args):
        if self._cluster:
            return self.execute(
                *[b"TTL", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"TTL", *args]
        )

    def type(self, *args):
        if self._cluster:
            return self.execute(
                *[b"TYPE", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"TYPE", *args]
        )

    def wait(self, *args):
        if self._cluster:
            return self.execute(
                *[b"WAIT", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"WAIT", *args]
        )

__init__()

Source code in pyredis/commands/key.py 
7
8
def __init__(self):
    super().__init__()

delete(*args)

Source code in pyredis/commands/key.py 
10
11
12
13
14
15
16
17
18
def delete(self, *args):
    if self._cluster:
        return self.execute(
            *[b"DEL", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"DEL", *args]
    )

dump(*args)

Source code in pyredis/commands/key.py 
20
21
22
23
24
25
26
27
28
def dump(self, *args):
    if self._cluster:
        return self.execute(
            *[b"DUMP", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"DUMP", *args]
    )

execute(*args, **kwargs)

Source code in pyredis/commands/base.py 
5
6
def execute(self, *args, **kwargs):
    raise NotImplementedError

exists(*args)

Source code in pyredis/commands/key.py 
30
31
32
33
34
35
36
37
38
def exists(self, *args):
    if self._cluster:
        return self.execute(
            *[b"EXISTS", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"EXISTS", *args]
    )

expire(*args)

Source code in pyredis/commands/key.py 
40
41
42
43
44
45
46
47
48
def expire(self, *args):
    if self._cluster:
        return self.execute(
            *[b"EXPIRE", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"EXPIRE", *args]
    )

expireat(*args)

Source code in pyredis/commands/key.py 
50
51
52
53
54
55
def expireat(self, *args):
    if self._cluster:
        return self.execute(b"EXPIREAT")
    return self.execute(
        *[b"EXPIREAT", *args]
    )

keys(*args, shard_key=None, sock=None)

Source code in pyredis/commands/key.py 
57
58
59
60
61
62
63
64
65
66
def keys(self, *args, shard_key=None, sock=None):
    if self._cluster:
        return self.execute(
            *[b"KEYS", *args],
            shard_key=shard_key,
            sock=sock
        )
    return self.execute(
        *[b"KEYS", *args]
    )

migrate(*args)

Source code in pyredis/commands/key.py 
68
69
70
71
72
73
def migrate(self, *args):
    if self._cluster:
        raise NotImplementedError
    return self.execute(
        *[b"MIGRATE", *args]
    )

move(*args)

Source code in pyredis/commands/key.py 
75
76
77
78
79
80
81
82
83
def move(self, *args):
    if self._cluster:
        return self.execute(
            *[b"MOVE", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"MOVE", *args]
    )

object(*args, shard_key=None, sock=None)

Source code in pyredis/commands/key.py 
85
86
87
88
89
90
91
92
93
94
def object(self, *args, shard_key=None, sock=None):
    if self._cluster:
        return self.execute(
            *[b"DEL", *args],
            shard_key=shard_key,
            sock=sock
        )
    return self.execute(
        *[b"OBJECT", *args]
    )

persist(*args)

Source code in pyredis/commands/key.py 
 96
 97
 98
 99
100
101
102
103
104
def persist(self, *args):
    if self._cluster:
        return self.execute(
            *[b"PERSIST", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"PERSIST", *args]
    )

pexpire(*args)

Source code in pyredis/commands/key.py 
106
107
108
109
110
111
112
113
114
def pexpire(self, *args):
    if self._cluster:
        return self.execute(
            *[b"PEXPIRE", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"PEXPIRE", *args]
    )

pexpireat(*args)

Source code in pyredis/commands/key.py 
116
117
118
119
120
121
122
123
124
def pexpireat(self, *args):
    if self._cluster:
        return self.execute(
            *[b"PEXPIREAT", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"PEXPIREAT", *args]
    )

pttl(*args)

Source code in pyredis/commands/key.py 
126
127
128
129
130
131
132
133
134
def pttl(self, *args):
    if self._cluster:
        return self.execute(
            *[b"PTTL", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"PTTL", *args]
    )

randomkey(*args, shard_key=None, sock=None)

Source code in pyredis/commands/key.py 
136
137
138
139
140
141
142
143
144
145
def randomkey(self, *args, shard_key=None, sock=None):
    if self._cluster:
        return self.execute(
            *[b"RANDOMKEY", *args],
            shard_key=shard_key,
            sock=sock
        )
    return self.execute(
        *[b"RANDOMKEY", *args]
    )

rename(*args)

Source code in pyredis/commands/key.py 
147
148
149
150
151
152
153
154
155
def rename(self, *args):
    if self._cluster:
        return self.execute(
            *[b"RENAME", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"RENAME", *args]
    )

renamenx(*args)

Source code in pyredis/commands/key.py 
157
158
159
160
161
162
163
164
165
def renamenx(self, *args):
    if self._cluster:
        return self.execute(
            *[b"RENAMENX", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"RENAMENX", *args]
    )

restore(*args)

Source code in pyredis/commands/key.py 
167
168
169
170
171
172
173
174
175
def restore(self, *args):
    if self._cluster:
        return self.execute(
            *[b"RESTORE", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"RESTORE", *args]
    )

scan(*args, shard_key=None, sock=None)

Source code in pyredis/commands/key.py 
177
178
179
180
181
182
183
184
185
186
def scan(self, *args, shard_key=None, sock=None):
    if self._cluster:
        return self.execute(
            *[b"SCAN", *args],
            shard_key=shard_key,
            sock=sock
        )
    return self.execute(
        *[b"SCAN", *args]
    )

sort(*args)

Source code in pyredis/commands/key.py 
188
189
190
191
192
193
194
195
196
def sort(self, *args):
    if self._cluster:
        return self.execute(
            *[b"SORT", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"SORT", *args]
    )

ttl(*args)

Source code in pyredis/commands/key.py 
198
199
200
201
202
203
204
205
206
def ttl(self, *args):
    if self._cluster:
        return self.execute(
            *[b"TTL", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"TTL", *args]
    )

type(*args)

Source code in pyredis/commands/key.py 
208
209
210
211
212
213
214
215
216
def type(self, *args):
    if self._cluster:
        return self.execute(
            *[b"TYPE", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"TYPE", *args]
    )

wait(*args)

Source code in pyredis/commands/key.py 
218
219
220
221
222
223
224
225
226
def wait(self, *args):
    if self._cluster:
        return self.execute(
            *[b"WAIT", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"WAIT", *args]
    )