Back to Redis

Install

content/operate/oss_and_stack/stack-with-enterprise/gears-v1/python/install.md

latest1.5 KB
Original Source

Before you can use RedisGears with Python, you need to install the RedisGears module and Python plugin on your Redis Software cluster and enable them for a database.

Prerequisites

  1. Redis Software v6.0.12 or later

  2. [Created a Redis Software cluster]({{< relref "/operate/rs/clusters/new-cluster-setup" >}})

  3. [Added nodes to the cluster]({{< relref "/operate/rs/clusters/add-node" >}})

  4. [Installed RedisGears and the Python plugin]({{< relref "/operate/oss_and_stack/stack-with-enterprise/gears-v1/installing-redisgears#install-redisgears" >}})

Enable RedisGears for a database

  1. From the Redis Software admin console's databases page, select the Add button to create a new database:

    {{<image filename="images/rs/icon_add.png" width="30px" alt="The Add icon">}}

  2. Confirm that you want to create a new Redis database with the Next button.

  3. On the create database page, give your database a name.

  4. For Redis Modules, select the Add button and choose RedisGears from the Module dropdown list.

  5. Select Add Configuration, enter <nobr>Plugin gears_python CreateVenv 1</nobr> in the box, then select the OK button:

    {{<image filename="images/rs/icon_save.png" width="30px" alt="The Save icon">}}

    {{<note>}} Only RedisGears v1.2 and later require this configuration. {{</note>}}

  6. Select the Activate button.

Verify the install

Run the RG.PYSTATS command to view statistics and verify that you set up RedisGears and the Python plugin correctly:

sh
redis> RG.PYSTATS