Skip to content

Scripting Commands

Bases: BaseCommand

Mixin for Redis Lua scripting commands (e.g. EVAL, EVALSHA, SCRIPT LOAD).

Source code in pyredis/commands/scripting.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
class Scripting(BaseCommand):
    """Mixin for Redis Lua scripting commands (e.g. EVAL, EVALSHA, SCRIPT LOAD)."""

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

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

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

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

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

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

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

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

__init__()

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

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

Source code in pyredis/commands/scripting.py 
10
11
12
13
14
15
16
17
18
19
def eval(self, *args, shard_key=None, sock=None):
    if self._cluster:
        return self.execute(
            *[b"EVAL", *args],
            shard_key=shard_key,
            sock=sock
        )
    return self.execute(
        *[b"EVAL", *args]
    )

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

Source code in pyredis/commands/scripting.py 
21
22
23
24
25
26
27
28
29
30
def evalsha(self, *args, shard_key=None, sock=None):
    if self._cluster:
        return self.execute(
            *[b"EVALSHA", *args],
            shard_key=shard_key,
            sock=sock
        )
    return self.execute(
        *[b"EVALSHA", *args]
    )

execute(*args, **kwargs)

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

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

Source code in pyredis/commands/scripting.py 
32
33
34
35
36
37
38
39
40
41
def script_debug(self, *args, shard_key=None, sock=None):
    if self._cluster:
        return self.execute(
            *[b"SCRIPT", b"DEBUG", *args],
            shard_key=shard_key,
            sock=sock
        )
    return self.execute(
        *[b"SCRIPT", b"DEBUG", *args]
    )

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

Source code in pyredis/commands/scripting.py 
43
44
45
46
47
48
49
50
51
52
def script_exists(self, *args, shard_key=None, sock=None):
    if self._cluster:
        return self.execute(
            *[b"SCRIPT", b"EXISTS", *args],
            shard_key=shard_key,
            sock=sock
        )
    return self.execute(
        *[b"SCRIPT", b"EXISTS", *args]
    )

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

Source code in pyredis/commands/scripting.py 
54
55
56
57
58
59
60
61
62
63
def script_flush(self, *args, shard_key=None, sock=None):
    if self._cluster:
        return self.execute(
            *[b"SCRIPT", b"FLUSH", *args],
            shard_key=shard_key,
            sock=sock
        )
    return self.execute(
        *[b"SCRIPT", b"FLUSH", *args]
    )

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

Source code in pyredis/commands/scripting.py 
65
66
67
68
69
70
71
72
73
74
def script_kill(self, *args, shard_key=None, sock=None):
    if self._cluster:
        return self.execute(
            *[b"SCRIPT", b"KILL", *args],
            shard_key=shard_key,
            sock=sock
        )
    return self.execute(
        *[b"SCRIPT", b"KILL", *args]
    )

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

Source code in pyredis/commands/scripting.py 
76
77
78
79
80
81
82
83
84
85
def script_load(self, *args, shard_key=None, sock=None):
    if self._cluster:
        return self.execute(
            *[b"SCRIPT", b"LOAD", *args],
            shard_key=shard_key,
            sock=sock
        )
    return self.execute(
        *[b"SCRIPT", b"LOAD", *args]
    )