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

http://www.mulesoft.org/schema/mule/redis: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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Value

String

The value to set.

#[payload]

 

Key

String

Key that will be used for SADD

x 

Must Succeed

Boolean

If true, ensures that adding to the set was successful (ie no pre-existing identical value in the set)

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

http://www.mulesoft.org/schema/mule/redis: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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Value

String

The value to set.

#[payload]

 

Key

String

Key that will be used for ZADD

x 

Score

Number

Score to use for the value

x 

Must Succeed

Boolean

If true, ensures that adding to the sorted set was successful (ie no pre-existing identical value in the set)

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

http://www.mulesoft.org/schema/mule/redis: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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

Key that will be used for DECR.

x 

Step

Number

Step used for the increment.

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

http://www.mulesoft.org/schema/mule/redis:del

Remove the specified key. A key is ignored if it does not exist.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

Key that will be used for DEL

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

http://www.mulesoft.org/schema/mule/redis:exists

Test if the specified key exists.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

Key that will be used for EXISTS

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

http://www.mulesoft.org/schema/mule/redis:expire

Set a timeout on the specified key.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

the key in the sorted set.

x 

Seconds

Number

the time to live in seconds.

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

http://www.mulesoft.org/schema/mule/redis:expire-at

Set a timeout in the form of a UNIX timestamp (Number of seconds elapsed since 1 Jan 1970) on the specified key.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

the key in the sorted set.

x 

Unix Time

Number

the UNIX timestamp in seconds.

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

http://www.mulesoft.org/schema/mule/redis:get

Get the value of the specified key. If the key does not exist null is returned.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

Key that will be used for GET

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

http://www.mulesoft.org/schema/mule/redis:get-all-from-hash

Get all fields and values of the hash stored at the specified key. If the field or the hash don't exist, null is returned.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

Key that will be used for HGETALL

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

http://www.mulesoft.org/schema/mule/redis: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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

Key that will be used for HGET

x 

Field

String

Field that will be used for HGET

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

http://www.mulesoft.org/schema/mule/redis: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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

Key that will be used for ZRANGE/ZREVRANGE

x 

Start

Number

Range start index

x 

End

Number

Range end index

x 

Order

Enumeration, one of:

  • ASCENDING

  • DESCENDING

Index order for sorting the range, either ASCENDING or DESCENDING

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

http://www.mulesoft.org/schema/mule/redis: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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

Key that will be used for ZRANGEBYSCORE/ZREVRANGEBYSCORE

x 

Min

Number

Range start score

x 

Max

Number

Range end score

x 

Order

Enumeration, one of:

  • ASCENDING

  • DESCENDING

Score order for sorting the range, either ASCENDING or DESCENDING

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

http://www.mulesoft.org/schema/mule/redis:get-ttl

Get the remaining time to live in seconds of a volatile key.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

the key in the sorted set.

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

http://www.mulesoft.org/schema/mule/redis: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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

Key that will be used for INCR.

x 

Step

Number

Step used for the increment.

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

http://www.mulesoft.org/schema/mule/redis: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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

Key that will be used for HGET

x 

Field

String

Field that will be used for HGET

x 

Step

Number

Step used for the increment.

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

http://www.mulesoft.org/schema/mule/redis: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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Value

String

The value to set.

#[payload]

 

Key

String

the key in the sorted set.

x 

Step

Number

the step to use to increment the score.

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

http://www.mulesoft.org/schema/mule/redis:persist

Undo an expire or expireAt ; turning the volatile key into a normal key.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

the key in the sorted set.

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

http://www.mulesoft.org/schema/mule/redis:pop-from-list

Pop a value from the desired side of the list stored at the specified key.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

Key that will be used for LPOP/RPOP

x 

Side

Enumeration, one of:

  • LEFT

  • RIGHT

The side where to pop the value from, either LEFT or RIGHT

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

http://www.mulesoft.org/schema/mule/redis:pop-from-set

Pops a random value from the set stored at the specified key.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

Key that will be used for SPOP

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

http://www.mulesoft.org/schema/mule/redis:publish

Publish the message payload to the specified channel.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Channel

String

Destination of the published message

x 

Message

String

The message to publish.

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

http://www.mulesoft.org/schema/mule/redis: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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Value

String

The value to push.

#[payload]

 

Key

String

Key that will be used for LPUSH/RPUSH/LPUSHX/RPUSH

x 

Side

Enumeration, one of:

  • LEFT

  • RIGHT

The side where to push the payload, either LEFT or RIGHT

x 

If Exists

Boolean

If true execute LPUSHX/RPUSH otherwise LPUSH/RPUSH

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

http://www.mulesoft.org/schema/mule/redis:random-member-from-set

Reads a random value from the set stored at the specified key.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Key

String

Key that will be used for SRANDMEMBER

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

http://www.mulesoft.org/schema/mule/redis: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.

in Redis terminology.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Value

String

The value to set.

#[payload]

 

Key

String

Key used to store payload

x 

Expire

Number

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

 

If Not Exists

Boolean

If true, then execute SETNX on the Redis server, otherwise execute SET

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

http://www.mulesoft.org/schema/mule/redis: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.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Value

String

The value to set.

#[payload]

 

Key

String

Key that will be used for HSET

x 

Field

String

Field that will be used for HSET

 

If Not Exists

Boolean

If true execute HSETNX otherwise HSET

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

http://www.mulesoft.org/schema/mule/redis: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:

  • BYTE

  • KB

  • MB

  • GB

Repeatable File Store Stream

Field Type Default Value

Max In Memory Size

Number

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB