Adapter - Redis
This page describes version 2.0.7 of the adapter.
Overview
The Redis adapter is used to store transient data in the workflow system to be used in other workflows or in future workflows.
The user is responsible for setting up a redis instance for this adapter to use and obtaining a valid redis connection string to configure this adapter.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| connectionstring | The connection string for connecting to Redis | True | server:port,password= | string | 1024 | ||||
| keyprefix | Key Prefix | False | The prefix that will be added to the keys, mainly for distinguishing, max length is 10, allowed chars are a-z,0-9 and underscore | string | 10 | ||||
| database | Default Database | False | The database to connect to (0-15), default is 0 | integer | 0 | 15 | 0 |
Commands
Set a value for a key (set)
Set a value for a key
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| key | Key | The key to set | True | string |
| value | Value | The value to set | True | string |
| expiry_seconds | Expire Timeout | The key timeout in seconds (0-2147483647). Default is never expire. | False | string |
| database | Database | The database to connect to | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| success | true if request was set, false if not | string |
Get the value of the key (get)
Get the value of the key
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| key | Key | The key to get the value for | True | string |
| database | Database | The database to connect to | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| success | true if a value was retrieved, false if not | string |
| value | the value of the key | string |
Delete the key (delete)
Delete the key
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| key | Key | The key to delete | True | string |
| database | Database | The database to connect to | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| success | true if the key was deleted, false if not | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.5 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.6 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-30 |
| 2.0.7 | Maintenance | Updated third-party components and improved maintainability. | NAP-27635 | 2024-07-31 |