Connector to manipulate specific data to Redis.
Configurations
Redis
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
The name of this configuration. With this name can be later referenced. |
x |
|
Connection |
The connection types that can be provided to this configuration. |
x |
Connection Types
Clustered
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Cluster Hosts |
String |
Redis cluster hosts separated by comma and having format host:port. Use this field when you want to access you Redis cluster through connector. |
|
|
Connection Timeout |
Number |
Connection timeout in milliseconds. |
2000 |
|
Entry TTL |
Number |
The default time to live to be set on keys stored through connector. |
|
|
Pool Config |
Object pool configuration. |
x |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Pooled
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Host |
String |
Redis host. Use this field when you want to access you Redis server that is not part of a cluster through connector. |
localhost |
|
Port |
Number |
Redis port. The port on which your non cluster server is running. |
6379 |
|
Connection Timeout |
Number |
Connection timeout in milliseconds. |
2000 |
|
Password |
String |
Redis password. Set this in case that the server requires authentication. |
|
|
Entry TTL |
Number |
The default time to live to be set on keys stored through connector. |
|
|
Pool Config |
Object pool configuration. |
|
||
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Associated Operations
Associated Sources
Operations
Add To Set
Add the message payload to the set stored at the specified key. If key does not exist, a new key holding a set is created.
Key that will be used for SADD If true, ensures that adding to the set was successful (ie no pre-existing identical value in the set) The value to set.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Value |
String |
#[payload] |
|
|
Key |
String |
x |
||
Must Succeed |
Boolean |
false |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Binary |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Add To Sorted Set
Add the message payload with the desired score to the sorted set stored at the specified key. If key does not exist, a new key holding a sorted set is created.
Key that will be used for ZADD Score to use for the value If true, ensures that adding to the sorted set was successful (ie no pre-existing identical value in the set) The value to set.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Value |
String |
#[payload] |
|
|
Key |
String |
x |
||
Score |
Number |
x |
||
Must Succeed |
Boolean |
false |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Binary |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Decrement
Decrements the number stored at key by step. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains data that can not be represented as integer.
Key that will be used for DECR. Step used for the increment.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Step |
Number |
1 |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Number |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Del
Remove the specified key. A key is ignored if it does not exist.
Key that will be used for DEL
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Number |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Exists
Test if the specified key exists.
Key that will be used for EXISTS
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Boolean |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Expire
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Seconds |
Number |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Boolean |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Expire At
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Unix Time |
Number |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Boolean |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Get
Get the value of the specified key. If the key does not exist null is returned.
Key that will be used for GET
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Binary |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Get All From Hash
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Object |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Get From Hash
Get the value stored at the specified field in the hash at the specified key. If the field or the hash don't exist, null is returned.
Key that will be used for HGET Field that will be used for HGET
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Field |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Binary |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Get Range By Index
Retrieve a range of values from the sorted set stored at the specified key. The range of values is defined by indices in the sorted set and sorted as desired.
Key that will be used for ZRANGE/ZREVRANGE Range start index Range end index Index order for sorting the range, either ASCENDING or DESCENDING
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Start |
Number |
x |
||
End |
Number |
x |
||
Order |
Enumeration, one of:
|
ASCENDING |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Array of Binary |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Get Range By Score
Retrieve a range of values from the sorted set stored at the specified key. The range of values is defined by scores in the sorted set and sorted as desired.
Key that will be used for ZRANGEBYSCORE/ZREVRANGEBYSCORE Range start score Range end score Score order for sorting the range, either ASCENDING or DESCENDING
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Min |
Number |
x |
||
Max |
Number |
x |
||
Order |
Enumeration, one of:
|
ASCENDING |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Array of Binary |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Get Ttl
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Number |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Increment
Increments the number stored at key by step. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains data that can not be represented as integer.
Key that will be used for INCR. Step used for the increment.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Step |
Number |
1 |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Number |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Increment Hash
Increments the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist the value is set to 0 before the operation is performed.
Key that will be used for HGET Field that will be used for HGET Step used for the increment.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Field |
String |
x |
||
Step |
Number |
1 |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Number |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Increment Sorted Set
Increments the score of member in the sorted set stored at key by increment. If member does not exist in the sorted set, it is added with increment as its score (as if its previous score was 0.0). If key does not exist, a new sorted set with the specified member as its sole member is created.
the key in the sorted set. the step to use to increment the score. The value to set.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Value |
String |
#[payload] |
|
|
Key |
String |
x |
||
Step |
Number |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Number |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Persist
Undo an expire or expireAt ; turning the volatile key into a normal key.
the key in the sorted set.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Boolean |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Pop From List
Pop a value from the desired side of the list stored at the specified key.
Key that will be used for LPOP/RPOP The side where to pop the value from, either LEFT or RIGHT
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Side |
Enumeration, one of:
|
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Binary |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Pop From Set
Pops a random value from the set stored at the specified key.
Key that will be used for SPOP
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Binary |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Publish
Publish the message payload to the specified channel.
Destination of the published message The message to publish.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Channel |
String |
x |
||
Message |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Boolean |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Push To List
Push the message payload to the desired side (LEFT or RIGHT) of the list stored at the specified key. If key does not exist, a new key holding a list is created as long as ifExists is not true.
Key that will be used for LPUSH/RPUSH/LPUSHX/RPUSH The side where to push the payload, either LEFT or RIGHT If true execute LPUSHX/RPUSH otherwise LPUSH/RPUSH The value to push.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Value |
String |
#[payload] |
|
|
Key |
String |
x |
||
Side |
Enumeration, one of:
|
x |
||
If Exists |
Boolean |
false |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Binary |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Random Member From Set
Reads a random value from the set stored at the specified key.
Key that will be used for SRANDMEMBER
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Key |
String |
x |
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Binary |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Set
Set key to hold the payload. If key already holds a value, it is overwritten, regardless of its type as long as ifNotExists is false.
The value to set. Key used to store payload Set a timeout on the specified key. After the timeout the key will be automatically deleted by the server. A key with an associated timeout is said to be volatile in Redis terminology. If true, then execute SETNX on the Redis server, otherwise execute SET
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Value |
String |
#[payload] |
|
|
Key |
String |
x |
||
Expire |
Number |
|
||
If Not Exists |
Boolean |
false |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Binary |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Set In Hash
Set the specified hash field to the message payload. If key does not exist, a new key holding a hash is created as long as ifNotExists is true.
Key that will be used for HSET Field that will be used for HSET If true execute HSETNX otherwise HSET The value to set.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Value |
String |
#[payload] |
|
|
Key |
String |
x |
||
Field |
String |
|
||
If Not Exists |
Boolean |
false |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
Output
Type |
Binary |
For Configurations.
Throws
-
REDIS:CONNECTIVITY
-
REDIS:UNKNOWN
-
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
-
REDIS:INVALID_REQUEST_DATA
-
REDIS:CONNECTIVITY
-
REDIS:RETRY_EXHAUSTED
Sources
Subscribe
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Channels |
Array of String |
A list of channel names or globbing patterns. |
x |
|
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|
||
Streaming Strategy |
Configure if repeatable streams should be used and their behaviour |
|
||
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
String |
Attributes Type |
For Configurations.
Types
Jedis Pool Config
Field | Type | Default Value |
---|---|---|
Block When Exhausted |
Boolean |
|
Eviction Policy Class Name |
String |
|
Fairness |
Boolean |
|
Jmx Enabled |
Boolean |
|
Jmx Name Base |
String |
|
Jmx Name Prefix |
String |
|
Lifo |
Boolean |
|
Max Idle |
Number |
|
Max Total |
Number |
|
Max Wait Millis |
Number |
|
Min Evictable Idle Time Millis |
Number |
|
Min Idle |
Number |
|
Num Tests Per Eviction Run |
Number |
|
Soft Min Evictable Idle Time Millis |
Number |
|
Test On Borrow |
Boolean |
|
Test On Create |
Boolean |
|
Test On Return |
Boolean |
|
Test While Idle |
Boolean |
|
Time Between Eviction Runs Millis |
Number |
Reconnect
Field | Type | Default Value |
---|---|---|
Frequency |
Number |
|
Count |
Number |
|
Blocking |
Boolean |
Reconnect Forever
Field | Type | Default Value |
---|---|---|
Frequency |
Number |
Subscribe Channel Attribtues
Field | Type | Default Value |
---|---|---|
Channel |
String |
Redelivery Policy
Field | Type | Default Value |
---|---|---|
Max Redelivery Count |
Number |
|
Use Secure Hash |
Boolean |
|
Message Digest Algorithm |
String |
|
Id Expression |
String |
|
Object Store Ref |
String |
Repeatable In Memory Stream
Field | Type | Default Value |
---|---|---|
Initial Buffer Size |
Number |
|
Buffer Size Increment |
Number |
|
Max Buffer Size |
Number |
|
Buffer Unit |
Enumeration, one of:
|
Repeatable File Store Stream
Field | Type | Default Value |
---|---|---|
Max In Memory Size |
Number |
|
Buffer Unit |
Enumeration, one of:
|