Redis

Most recent version: v1.0.0

See the changelog of this Action type here.

Overview

Redis is a powerful in-memory data structure store that can be used as a database, cache, and message broker. It provides high performance, scalability, and versatility, making it a popular choice for real-time applications and data processing.

The Redis Action allows users to set and retrieve data from a Redis server.

In order to configure this action, you must first link it to a Listener. Go to Building a Pipeline to learn how to link.

Ports

These are the input and output ports of this Action:

Input ports

• Default port - All the events to be processed by this Action enter through this port.

Output ports

• Default port - Events are sent through this port if no error occurs while processing them.

• Error port - Events are sent through this port if an error occurs while processing them.

Installing Redis

To use this Action, you must install Redis and Redis CLI.

As installing Redis via a Docker is generally preferable, we will brief you on this procedure. To install it locally, check this article.

1

Start your local Redis docker instance:

Using docker file

FROM redis:latest

EXPOSE 6379

CMD ["redis-server"]

## build

docker build -t my-redis-image

## run

docker run -d --name my-redis my-redis-image

Using one line command

docker run -d --name my-redis -p 6379:6379 redis/redis-stack-server:latest

2

Now, connect to the Redis container:

docker exec -it {{ContainerID}} sh

> redis-cli

3

Use this command to get the IP:

# Read Value

127.0.0.1:6379> GET key

# Set Value

SET key value

4

Paste this IP in the Redis endpoint field of your Redis Action.

For more help and in-depth detail, see these use cases.

Configuration

1

Find Redis in the Actions tab (under the Advanced group) and drag it onto the canvas. Link it to the required Listener and Data sink.

2

To open the configuration, click the Action in the canvas and select Configuration.

3

Enter the required parameters:

Parameter	Description
Redis endpoint*	Enter the endpoint used to establish the connection to the Redis server.
Commands	The command to read or write data from the Redis server. Choose between SET and GET.
Redis Key*	If the model has a version, enter it here.
Event in field / Event out field*	Depending on the selected command, you must Event in field - Choose the field that contains the events you want to input to Redis. Only available for the SET command. Event out field - Enter a name for the output field that will store the output data. Only available for the GET command.
Expiration in seconds	Optionally, enter how long the key will be available in the Redis server. Only available for the SET command.

4

Click Save to complete.