Skip to main content

Redis Component

Manage items in a Redis database

Component key: redis

Description

Redis is an in-memory data structure store, used as a distributed, in-memory key–value database, cache and message broker. The Redis component provides the ability to create, read, update, and delete data inside a Redis database.

This component returns data that can be used in subsequent steps.

Connections

Redis Connection

InputDefaultNotesExample
CA Certificate
text
ca
Provide the CA certificate for the TLS connection. If not provided, the connection will not be verified.
 
Client Certificate
text
cert
Provide the client certificate for the TLS connection.
 
Database
string
db
Select a logical database to connect to.
0
Host
string
/ Required
host
192.168.0.1
Provide the string value for the host of the server.
 
Client Key
text
key
Provide the client key for the TLS connection.
 
Password
password
/ Required
password
 
 
Port
string
/ Required
port
The port of the redis server.
 
Username
string
username
 
 
Use TLS
boolean
useTls
false
Set to true to enable TLS for the connection.
 

Actions

Delete Key

Delete the value of a key | key: deleteKey

InputNotesExample
Key
string
/ Required
key
Provide a string value for key of the item.
customerId
Connection
connection
/ Required
redisConnection
 
 

{
"data": 1
}

Flush All

Delete all the keys of all the existing databases, not just the currently selected one | key: flushAll

InputNotes
Connection
connection
/ Required
redisConnection
 

{
"data": "OK"
}

Get

Get the value of a key | key: get

InputNotesExample
Key
string
/ Required
key
Provide a string value for key of the item.
customerId
Connection
connection
/ Required
redisConnection
 
 

{
"data": "myValue"
}

Get Time

Get the local time of the redis server | key: getTime

InputNotes
Connection
connection
/ Required
redisConnection
 

{
"data": "2024-05-20T23:01:37.700Z"
}

Keys

Returns all keys matching a specified pattern | key: keys

InputNotesExample
Key
string
/ Required
key
Provide a string value for key of the item.
customerId
Connection
connection
/ Required
redisConnection
 
 

{
"data": [
"key1",
"key2",
"key3"
]
}

Ping

Send a ping to the redis server | key: ping

InputNotes
Connection
connection
/ Required
redisConnection
 

{
"data": "PONG"
}

Set

Set the value of a key | key: set

InputNotesExample
Key
string
/ Required
key
Provide a string value for key of the item.
customerId
Connection
connection
/ Required
redisConnection
 
 
Value
string
/ Required
value
Provide a string for the value to be set.
cust#3017

{
"data": "OK"
}