summaryrefslogtreecommitdiff
path: root/redis/commands/redismodules.py
blob: b3cbee1d872095fc7f94a2bb10e8ffef0ff2c733 (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
from json import JSONEncoder, JSONDecoder
from redis.exceptions import ModuleError


class RedisModuleCommands:
    """This class contains the wrapper functions to bring supported redis
    modules into the command namepsace.
    """

    def json(self, encoder=JSONEncoder(), decoder=JSONDecoder()):
        """Access the json namespace, providing support for redis json.
        """
        if 'JSON.SET' not in self.__commands__:
            raise ModuleError("redisjson is not loaded in redis. "
                              "For more information visit "
                              "https://redisjson.io/")

        from .json import JSON
        jj = JSON(
                client=self,
                encoder=encoder,
                decoder=decoder)
        return jj

    def ft(self, index_name="idx"):
        """Access the search namespace, providing support for redis search.
        """
        if 'FT.INFO' not in self.__commands__:
            raise ModuleError("redisearch is not loaded in redis. "
                              "For more information visit "
                              "https://redisearch.io/")

        from .search import Search
        s = Search(client=self, index_name=index_name)
        return s

    def ts(self):
        """Access the timeseries namespace, providing support for
        redis timeseries data.
        """
        if 'TS.INFO' not in self.__commands__:
            raise ModuleError("reditimeseries is not loaded in redis. "
                              "For more information visit "
                              "https://redistimeseries.io/")

        from .timeseries import TimeSeries
        s = TimeSeries(client=self)
        return s