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.

Redis Connections#

Redis Connection#

InputDefaultNotesExample
Input
Database
string
/ Required
Default
 
Notes
Provide a string value for the redis database
Example
admin
Input
Host
string
/ Required
Default
192.168.0.1
Notes
Provide the string value for the host of the server.
Example
 
Input
Password
string
Default
 
Notes
 
Example
 
Input
Port
string
/ Required
Default
 
Notes
The port of the redis server.
Example
 
Input
Username
string
Default
 
Notes
 
Example
 

Actions#

Delete Key#

Delete the value of a key | key: deleteKey

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

Output Example Payload#

{  "data": {}}

Flush All#

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

InputNotes
Input
Connection
connection
/ Required
Notes
 

Output Example Payload#

{  "data": {}}

Get#

Get the value of a key | key: get

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

Output Example Payload#

{  "data": "myValue"}

Get Time#

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

InputNotes
Input
Connection
connection
/ Required
Notes
 

Output Example Payload#

{  "data": "12:34"}

Keys#

Returns all keys matching a specified pattern | key: keys

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

Output Example Payload#

{  "data": {}}

Ping#

Send a ping to the redis server | key: ping

InputNotes
Input
Connection
connection
/ Required
Notes
 

Output Example Payload#

{  "data": "pong"}

Set#

Set the value of a key | key: set

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

Output Example Payload#

{  "data": "Ok"}