Redis Module Documentation Reference

Configurations

Redis

Parameters

Name	Type	Description	Default Value	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.		x
Connection	Clustered NonClustered	The connection types that can be provided to this configuration.		x

Name

Type

Description

Default Value

Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

Connection

Clustered
NonClustered

The connection types that can be provided to this configuration.

Connection Types

Clustered

Parameters

Name	Type	Description	Default Value
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.
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy
Max Total	Number		8
Max Idle	Number		8
Min Idle	Number		0
Lifo	Boolean		true
Fairness	Boolean		false
Max Wait Millis	Number		-1
Min Evictable Idle Time Millis	Number		1800000
Soft Min Evictable Idle Time Millis	Number		1800000
Num Tests Per Eviction Run	Number		3
Test On Create	Boolean		false
Test On Borrow	Boolean		false
Test On Return	Boolean		false
Test While Idle	Boolean		false
Time Between Eviction Runs Millis	Number		-1
Block When Exhausted	Boolean		true
Jmx Enabled	Boolean		true
Jmx Name Prefix	String		pool
Jmx Name Base	String

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.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

Max Total

Number

Max Idle

Number

Min Idle

Number

Lifo

Boolean

true

Fairness

Boolean

false

Max Wait Millis

Number

-1

Min Evictable Idle Time Millis

Number

1800000

Soft Min Evictable Idle Time Millis

Number

1800000

Num Tests Per Eviction Run

Number

Test On Create

Boolean

false

Test On Borrow

Boolean

false

Test On Return

Boolean

false

Test While Idle

Boolean

false

Time Between Eviction Runs Millis

Number

-1

Block When Exhausted

Boolean

true

Jmx Enabled

Boolean

true

Jmx Name Prefix

String

pool

Jmx Name Base

String

NonClustered

Parameters

Name	Type	Description	Default Value
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.
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy
Max Total	Number		8
Max Idle	Number		8
Min Idle	Number		0
Lifo	Boolean		true
Fairness	Boolean		false
Max Wait Millis	Number		-1
Min Evictable Idle Time Millis	Number		1800000
Soft Min Evictable Idle Time Millis	Number		1800000
Num Tests Per Eviction Run	Number		3
Test On Create	Boolean		false
Test On Borrow	Boolean		false
Test On Return	Boolean		false
Test While Idle	Boolean		false
Time Between Eviction Runs Millis	Number		-1
Block When Exhausted	Boolean		true
Jmx Enabled	Boolean		true
Jmx Name Prefix	String		pool
Jmx Name Base	String

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.

Reconnection

Max Total

Number

Max Idle

Number

Min Idle

Number

Lifo

Boolean

true

Fairness

Boolean

false

Max Wait Millis

Number

-1

Min Evictable Idle Time Millis

Number

1800000

Soft Min Evictable Idle Time Millis

Number

1800000

Num Tests Per Eviction Run

Number

Test On Create

Boolean

false

Test On Borrow

Boolean

false

Test On Return

Boolean

false

Test While Idle

Boolean

false

Time Between Eviction Runs Millis

Number

-1

Block When Exhausted

Boolean

true

Jmx Enabled

Boolean

true

Jmx Name Prefix

String

pool

Jmx Name Base

String

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
Key	String	Key that will be used for SADD		x
Value	String	The value to set.	#[payload]
Must Succeed	Boolean	If true, ensures that adding to the set was successful (ie no pre-existing identical value in the set)	false
Output Mime Type	String	The mime type of the payload that this operation outputs.
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for SADD

Value

String

The value to set.

#[payload]

Must Succeed

Boolean

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

false

Output Mime Type

String

The mime type of the payload that this operation outputs.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Key	String	Key that will be used for ZADD		x
Value	String	The value to set.	#[payload]
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
Output Mime Type	String	The mime type of the payload that this operation outputs.
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for ZADD

Value

String

The value to set.

#[payload]

Score

Number

Score to use for the value

Must Succeed

Boolean

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

false

Output Mime Type

String

The mime type of the payload that this operation outputs.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for DECR.

Step

Number

Step used for the increment.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Number

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for DEL

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Number

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for EXISTS

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Boolean

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

the key in the sorted set.

Seconds

Number

the time to live in seconds.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Boolean

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

the key in the sorted set.

Unix Time

Number

the UNIX timestamp in seconds.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Boolean

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Output Mime Type	String	The mime type of the payload that this operation outputs.
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for GET

Output Mime Type

String

The mime type of the payload that this operation outputs.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for HGETALL

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Object

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Output Mime Type	String	The mime type of the payload that this operation outputs.
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for HGET

Field

String

Field that will be used for HGET

Output Mime Type

String

The mime type of the payload that this operation outputs.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for ZRANGE/ZREVRANGE

Start

Number

Range start index

End

Number

Range end index

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

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Array of String

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for ZRANGEBYSCORE/ZREVRANGEBYSCORE

Min

Number

Range start score

Max

Number

Range end score

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

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Array of String

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

the key in the sorted set.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Number

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for INCR.

Step

Number

Step used for the increment.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Number

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for HGET

Field

String

Field that will be used for HGET

Step

Number

Step used for the increment.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Number

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Key	String	the key in the sorted set.		x
Value	String	The value to set.	#[payload]
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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

the key in the sorted set.

Value

String

The value to set.

#[payload]

Step

Number

the step to use to increment the score.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Number

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

the key in the sorted set.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Boolean

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Output Mime Type	String	The mime type of the payload that this operation outputs.
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for LPOP/RPOP

Side

Enumeration, one of:

LEFT
RIGHT

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

Output Mime Type

String

The mime type of the payload that this operation outputs.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Output Mime Type	String	The mime type of the payload that this operation outputs.
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for SPOP

Output Mime Type

String

The mime type of the payload that this operation outputs.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Channel

String

Destination of the published message

Message

String

The message to publish.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Boolean

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Key	String	Key that will be used for LPUSH/RPUSH/LPUSHX/RPUSH		x
Value	String	The value to push.	#[payload]
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
Output Mime Type	String	The mime type of the payload that this operation outputs.
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

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

Value

String

The value to push.

#[payload]

Side

Enumeration, one of:

LEFT
RIGHT

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

If Exists

Boolean

If true execute LPUSHX/RPUSH otherwise LPUSH/RPUSH

false

Output Mime Type

String

The mime type of the payload that this operation outputs.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Output Mime Type	String	The mime type of the payload that this operation outputs.
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for SRANDMEMBER

Output Mime Type

String

The mime type of the payload that this operation outputs.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Key	String	Key used to store payload		x
Value	String	The value to set.	#[payload]
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
Output Mime Type	String	The mime type of the payload that this operation outputs.
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key used to store payload

Value

String

The value to set.

#[payload]

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

Output Mime Type

String

The mime type of the payload that this operation outputs.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

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
Key	String	Key that will be used for HSET		x
Value	String	The value to set.	#[payload]
Field	String	Field that will be used for HSET
If Not Exists	Boolean	If true execute HSETNX otherwise HSET	false
Output Mime Type	String	The mime type of the payload that this operation outputs.
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Key

String

Key that will be used for HSET

Value

String

The value to set.

#[payload]

Field

String

Field that will be used for HSET

If Not Exists

Boolean

If true execute HSETNX otherwise HSET

false

Output Mime Type

String

The mime type of the payload that this operation outputs.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations.

Redis

Throws

REDIS:UNKNOWN
REDIS:CONNECTIVITY
REDIS:INVALID_REQUEST_DATA
REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA
REDIS:RETRY_EXHAUSTED
REDIS:CONNECTIVITY

Sources

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

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Channels

Array of String

A list of channel names or globbing patterns.

Output Mime Type

String

The mime type of the payload that this operation outputs.

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
[non-repeatable-stream]

Configure if repeatable streams should be used and their behaviour

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Subscribe Channel Attribtues

For Configurations.

Redis

Types

Reconnection

Field

Type

Description

Default Value

Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

Reconnect
Reconnect Forever

The reconnection strategy to use

Reconnect

Field

Type

Description

Default Value

Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field

Type

Description

Default Value

Required

Frequency

Number

How often (in ms) to reconnect

Subscribe Channel Attribtues

Field

Type

Description

Default Value

Required

Channel

String

Redelivery Policy

Field

Type

Description

Default Value

Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

[ObjectStore]

The object store where the redelivery counter for each message is going to be stored.

Repeatable In Memory Stream

Field

Type

Description

Default Value

Required

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field

Type

Description

Default Value

Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

The unit in which maxInMemorySize is expressed