--- schema_version: "1" id: f5a59662792f2763a87f92f4eba3ec7ebc306f83601efaec1c84edc9a72c376c title: Redis Connector 5.6 Reference collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/redis-connector/5.6/redis-connector-reference.md canonical_url: https://docs.mulesoft.com/redis-connector/5.6/redis-connector-reference source_site: docs.mulesoft.com content_type: documentation content_hash: e2f3c74ae3827a46551c758e639bccd4802b6a9b7f4391cc54cb15b89e255301 description: MuleSoft Documentation Site release: "5.6" latest: false --- --- product: Redis Connector version: 5.6 --- # Redis Connector 5.6 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt > [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality. > We maintained certain terms to avoid any effect on customer implementations. > [!NOTE] You can set configurations in Expression mode, except when Redis Connector is used in > conjunction with Object Store Connector, which does not support Expression mode. Starting with Redis Connector 5.4.5, Mule apps that use an Object Store **Entry TTL** exceeding 24 days now observe that the TTL for new keys is set to the correct values. ## Redis Configuration

Name	Type	Description	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.	x
Connection	Clustered NonClustered Sentinel	The connection types to provide to this configuration.	x
Expiration Policy	Expiration Policy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

## Connection Types > [!NOTE] Redis Connector supports only password-based authentication. Redis Connector does not > currently support Role-Based Access Control (RBAC). ### Clustered > [!NOTE] Redis Connector does not support clustered connections on Redis Enterprise Active-Active > databases. To connect to one of the Redis Enterprise active-active clusters, non-clustered > connection should be used in the connector. However, the connection is only made to the specified > node. > > Redis Connector does not support clustered sharded connections. #### Parameters

Name	Type	Description	Default Value	Required
Endpoint identification algorithm	Enumeration, one of: HTTPS LDAPS DISABLED	The endpoint identification algorithm used by clients to validate the server hostname. The default value is an empty string, which means that this functionality is disabled. Clients, including client connections created by the broker for inter-broker communication, verify that the broker hostname matches the hostname in the broker’s certificate.	DISABLED
TLS Configuration	TLS	Configures TLS. If you are running the Mule app securely by using the HTTPS protocol, you must configure TLS in the connector.
Max Total	Number	Maximum number of connections that can be in the pool at a given time	8
Max Idle	Number	Maximum number of idle connections allowed in a pool before the connections are closed	8
Min Idle	Number	Minimum number of idle connections in the pool that are ready for immediate use	0
Lifo	Boolean	If set to `true`, the queue is last-in first-out	true
Fairness	Boolean	If set to `true`, the thread that waited for the longest amount of time to connect acquires the next available connection	false
Max Wait Millis	Number	Maximum number of milliseconds the client can wait before a connection is available	-1
Min Evictable Idle Time Millis	Number	Minimum amount of time a connection can be idle in the pool before it is evicted	1800000
Soft Min Evictable Idle Time Millis	Number	Minimum amount of time a connection can be idle in pool before it is evicted	1800000
Num Tests Per Eviction Run	Number	Number of connections to test per eviction attempt	3
Test On Create	Boolean	Whether to test the validity of the connection	false
Test On Borrow	Boolean	Whether to test the validity of the connection before it is borrowed from the pool	false
Test On Return	Boolean	Whether to test the validity of the connection before it is returned from the pool	false
Test While Idle	Boolean	Whether to enable idle resource detection	false
Time Between Eviction Runs Millis	Number	Cycle of time for idle resources detection	-1
Block When Exhausted	Boolean	Whether the client waits when the resource pool is exhausted	true
Jmx Enabled	Boolean	Enables JMX monitoring when set to `true`	true
Jmx Name Prefix	String	JMX name prefix used as part of the name assigned to the JMX-enabled pool	pool
Jmx Name Base	String	JMX name base used as part of the name assigned to the JMX-enabled pool
Connection Timeout	Number	Redis instance Connection timeout value.	2000
Connection Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for Redis instance connection timeout.	MILLISECONDS
Password	String	Redis password. Set if the server requires authentication.
Entry TTL	Number	The default time to live to set on keys stored for the connector.
Cluster Hosts	String	Redis cluster hosts separated by commas and having the format `host:port`. Use this field when you want to access your Redis cluster through the connector.		x
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to `true`, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

### NonClustered #### Parameters

Name	Type	Description	Default Value
Endpoint identification algorithm	Enumeration, one of: HTTPS LDAPS DISABLED	The endpoint identification algorithm used by clients to validate the server hostname. The default value is an empty string, which means that this functionality is disabled. Clients, including client connections created by the broker for inter-broker communication, verify that the broker hostname matches the hostname in the broker’s certificate.	DISABLED
TLS Configuration	TLS	Configures TLS. If you are running the Mule app securely by using the HTTPS protocol, you must configure TLS in the connector.
Max Total	Number	Maximum number of connections that can be in the pool at a given time	8
Max Idle	Number	Maximum number of idle connections allowed in a pool before the connections are closed	8
Min Idle	Number	Minimum number of idle connections in the pool that are ready for immediate use	0
Lifo	Boolean	If set to `true`, the queue is last-in first-out	true
Fairness	Boolean	If set to `true`, the thread that waited for the longest amount of time to connect acquires the next available connection	false
Max Wait Millis	Number	Maximum number of milliseconds the client can wait before a connection is available	-1
Min Evictable Idle Time Millis	Number	Minimum amount of time a connection can be idle in the pool before it is evicted	1800000
Soft Min Evictable Idle Time Millis	Number	Minimum amount of time a connection can be idle in pool before it is evicted	1800000
Num Tests Per Eviction Run	Number	Number of connections to test per eviction attempt	3
Test On Create	Boolean	Whether to test the validity of the connection	false
Test On Borrow	Boolean	Whether to test the validity of the connection before it is borrowed from the pool	false
Test On Return	Boolean	Whether to test the validity of the connection before it is returned from the pool	false
Test While Idle	Boolean	Whether to enable idle resource detection	false
Time Between Eviction Runs Millis	Number	Cycle of time for idle resources detection	-1
Block When Exhausted	Boolean	Whether the client waits when the resource pool is exhausted	true
Jmx Enabled	Boolean	Enables JMX monitoring when set to `true`	true
Jmx Name Prefix	String	JMX name prefix used as part of the name assigned to the JMX-enabled pool	pool
Jmx Name Base	String	JMX name base used as part of the name assigned to the JMX-enabled pool
Connection Timeout	Number	Redis instance Connection timeout value.	2000
Connection Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for Redis instance connection timeout.	MILLISECONDS
Password	String	Redis password. Set this if the server requires authentication.
Entry TTL	Number	The default time to live to be set on keys stored for the connector.
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
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to `true`, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

### Sentinel Sentinel provides a high-availability solution in case of failure on your Redis cluster. #### Parameters

Name	Type	Description	Default Value	Required
Endpoint identification algorithm	Enumeration, one of: HTTPS LDAPS DISABLED	The endpoint identification algorithm used by clients to validate the server hostname. The default value is an empty string, which means that this functionality is disabled. Clients, including client connections created by the broker for inter-broker communication, verify that the broker hostname matches the hostname in the broker’s certificate.	DISABLED
TLS Configuration	TLS	Configures TLS. If you are running the Mule app securely by using the HTTPS protocol, you must configure TLS in the connector.
Max Total	Number	Maximum number of connections that can be in the pool at a given time	8
Max Idle	Number	Maximum number of idle connections allowed in a pool before the connections are closed	8
Min Idle	Number	Minimum number of idle connections in the pool that are ready for immediate use	0
Lifo	Boolean	If set to `true`, the queue is last-in first-out	true
Fairness	Boolean	If set to `true`, the thread that waited for the longest amount of time to connect acquires the next available connection	false
Max Wait Millis	Number	Maximum number of milliseconds the client can wait before a connection is available	-1
Min Evictable Idle Time Millis	Number	Minimum amount of time a connection can be idle in the pool before it is evicted	1800000
Soft Min Evictable Idle Time Millis	Number	Minimum amount of time a connection can be idle in pool before it is evicted	1800000
Num Tests Per Eviction Run	Number	Number of connections to test per eviction attempt	3
Test On Create	Boolean	Whether to test the validity of the connection	false
Test On Borrow	Boolean	Whether to test the validity of the connection before it is borrowed from the pool	false
Test On Return	Boolean	Whether to test the validity of the connection before it is returned from the pool	false
Test While Idle	Boolean	Whether to enable idle resource detection	false
Time Between Eviction Runs Millis	Number	Cycle of time for idle resources detection	-1
Block When Exhausted	Boolean	Whether the client waits when the resource pool is exhausted	true
Jmx Enabled	Boolean	Enables JMX monitoring when set to `true`	true
Jmx Name Prefix	String	JMX name prefix used as part of the name assigned to the JMX-enabled pool	pool
Jmx Name Base	String	JMX name base used as part of the name assigned to the JMX-enabled pool
Connection Timeout	Number	Redis instance connection timeout value.	2000
Connection Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for Redis instance connection timeout.	MILLISECONDS
Password	String	Redis password. Set this if the server requires authentication.
Entry TTL	Number	The default time to live to be set on keys stored for the connector.
Sentinels Hosts	String	Set of sentinel addresses that are monitoring the master host to which the connector will connect.		x
Master Name	String	Redis master name. The name of the master for which the sentinels will return the current address.
Sentinel Password	String	Sentinel password. Set this if the sentinel servers require authentication.
Index	Number	The index of the database that the pool will use.
Sentinel Connection Timeout	Number	Sentinel connection timeout value.	2000
Sentinel Connection Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for sentinel connection timeout.	MILLISECONDS
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to `true`, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

## Sources Supported source: - [Subscribe](#subscribe) ### Subscribe `` #### Parameters

Name	Type	Description	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.	x
Channels	Array of String	A list of channel names or globbing patterns.	x
Output Mime Type	String	The MIME type of the payload that this source outputs.
Primary Node Only	Boolean	Whether this source should be executed on the primary node only when running in a cluster.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream Non-repeatable Stream	Configures how Mule processes streams. Repeatable streams are the default behavior.
Redelivery Policy	Redelivery Policy	Defines a policy for processing the redelivery of the same message.
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	String
Attributes Type	Subscribe Channel Attributes

### For Configurations - [Redis Configuration](#redis) ## Operations Supported operations: - [Add To Set](#addToSet) - [Add To Sorted Set](#addToSortedSet) - [Decrement](#decrement) - [Del](#del) - [Exists](#exists) - [Expire](#expire) - [Expire At](#expireAt) - [Get](#get) - [Get All From Hash](#getAllFromHash) - [Get From Hash](#getFromHash) - [Get Range By Index](#getRangeByIndex) - [Get Range By Score](#getRangeByScore) - [Get TTL](#getTtl) - [Increment](#increment) - [Increment Hash](#incrementHash) - [Increment Sorted Set](#incrementSortedSet) - [Persist](#persist) - [Pop From List](#popFromList) - [Pop From Set](#popFromSet) - [Publish](#publish) - [Push To List](#pushToList) - [Random Member From Set](#randomMemberFromSet) - [Range From List](#rangeFromList) - [Set](#set) - [Set In Hash](#setInHash) - [Trim From List](#trimFromList) ### Add To Set `` Add the message payload to the set stored at the specified key. If the key does not exist, a new key holding a set is created. #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for SADD		x
Value	String	The value to set.	`#[payload]`
Must Succeed	Boolean	If `true`, ensures that adding to the set is successful (that is, no pre-existing identical value is in the set)	false
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	An expression that evaluates against the operation’s output. The outcome of the expression is 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 Configuration](#redis) #### Throws - REDIS:CONNECTIVITY - REDIS:INVALID\_CONFIGURATION - REDIS:INVALID\_REQUEST\_DATA - REDIS:INVALID\_STRUCTURE\_FOR\_INPUT\_DATA - REDIS:RETRY\_EXHAUSTED - REDIS:UNKNOWN - REDIS:UNABLE\_TO\_UNSUBSCRIBE ### Add To Sorted Set `` Add the message payload with the desired score to the sorted set stored at the specified key. If the key does not exist, a new key holding a sorted set is created. #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use 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 set is successful (that is, no pre-existing identical value is in the set)	false
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is 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 Configuration](#redis) #### Throws - REDIS: - REDIS:INVALID\_CONFIGURATION - REDIS:INVALID\_REQUEST\_DATA - REDIS:INVALID\_STRUCTURE\_FOR\_INPUT\_DATA - REDIS:RETRY\_EXHAUSTED - REDIS:UNKNOWN - REDIS:UNABLE\_TO\_UNSUBSCRIBE ### 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 cannot be represented as integer. #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for DECR.		x
Step	Number	Step used for the increment.	1
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type

Number

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for DEL		x
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type

Number

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for EXISTS		x
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type

Boolean

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	The key in the sorted set.		x
Seconds	Number	The time to live in seconds.		x
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type

Boolean

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	The key in the sorted set.		x
Unix Time	Number	The UNIX timestamp in seconds.		x
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type

Boolean

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for GET		x
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is 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 Configuration](#redis) #### Throws - REDIS:CONNECTIVITY - REDIS:INVALID\_CONFIGURATION - REDIS:INVALID\_REQUEST\_DATA - REDIS:INVALID\_STRUCTURE\_FOR\_INPUT\_DATA - REDIS:RETRY\_EXHAUSTED - REDIS:UNKNOWN - REDIS:UNABLE\_TO\_UNSUBSCRIBE ### 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, a null value is returned. #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for HGETALL		x
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is 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 Configuration](#redis) #### Throws - REDIS:CONNECTIVITY - REDIS:INVALID\_CONFIGURATION - REDIS:INVALID\_REQUEST\_DATA - REDIS:INVALID\_STRUCTURE\_FOR\_INPUT\_DATA - REDIS:RETRY\_EXHAUSTED - REDIS:UNKNOWN - REDIS:UNABLE\_TO\_UNSUBSCRIBE ### 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, a null value is returned. #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for HGET		x
Field	String	Field to use for HGET		x
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is 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 Configuration](#redis) #### Throws - REDIS:CONNECTIVITY - REDIS:INVALID\_CONFIGURATION - REDIS:INVALID\_REQUEST\_DATA - REDIS:INVALID\_STRUCTURE\_FOR\_INPUT\_DATA - REDIS:RETRY\_EXHAUSTED - REDIS:UNKNOWN - REDIS:UNABLE\_TO\_UNSUBSCRIBE ### 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	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for ZRANGE/ZREVRANGE		x
Start	Number	Range start index		x
End	Number	Range end index		x
Ascending Order	Boolean	Index order for sorting the range. If the parameter is set to `true`, the range is sorted in ascending order. If the parameter is set to `false`, the range is sorted in descending order.	true
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is 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 Configuration](#redis) #### Throws - REDIS:CONNECTIVITY - REDIS:INVALID\_CONFIGURATION - REDIS:INVALID\_REQUEST\_DATA - REDIS:INVALID\_STRUCTURE\_FOR\_INPUT\_DATA - REDIS:RETRY\_EXHAUSTED - REDIS:UNKNOWN - REDIS:UNABLE\_TO\_UNSUBSCRIBE ### 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	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for ZRANGEBYSCORE and ZREVRANGEBYSCORE		x
Min	Number	Range start score		x
Max	Number	Range end score		x
Ascending Order	Boolean	Score order for sorting the range. If the parameter is set to `true`, the range is sorted in ascending order. If the parameter is set to `false`, the range is sorted in descending order.	true
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Array of String

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	The key in the sorted set.		x
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is 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 Configuration](#redis) #### Throws - REDIS:CONNECTIVITY - REDIS:INVALID\_CONFIGURATION - REDIS:INVALID\_REQUEST\_DATA - REDIS:INVALID\_STRUCTURE\_FOR\_INPUT\_DATA - REDIS:RETRY\_EXHAUSTED - REDIS:UNKNOWN - REDIS:UNABLE\_TO\_UNSUBSCRIBE ### 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	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for INCR.		x
Step	Number	Step used for the increment.	1
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is 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 Configuration](#redis) #### Throws - REDIS:CONNECTIVITY - REDIS:INVALID\_CONFIGURATION - REDIS:INVALID\_REQUEST\_DATA - REDIS:INVALID\_STRUCTURE\_FOR\_INPUT\_DATA - REDIS:RETRY\_EXHAUSTED - REDIS:UNKNOWN - REDIS:UNABLE\_TO\_UNSUBSCRIBE ### Increment Hash `` Increments the number stored at field in the hash stored at key by increment. If the 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	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for HGET		x
Field	String	Field to use for HGET		x
Step	Number	Step used for the increment.	1
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is 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 Configuration](#redis) #### Throws - REDIS:CONNECTIVITY - REDIS:INVALID\_CONFIGURATION - REDIS:INVALID\_REQUEST\_DATA - REDIS:INVALID\_STRUCTURE\_FOR\_INPUT\_DATA - REDIS:RETRY\_EXHAUSTED - REDIS:UNKNOWN - REDIS:UNABLE\_TO\_UNSUBSCRIBE ### 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 the 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	Name for this configuration. Connectors reference the configuration with this name.		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	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type

Number

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	The key in the sorted set.		x
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type

Boolean

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for LPOP/RPOP		x
Pop Left	boolean	The side from which to pop the value. If the parameter is `true`, the value is popped from the left side. If the parameter is `false`, the value is popped from the right side.	false
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type

String

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for SPOP		x
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type

String

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Channel	String	Destination of the published message		x
Message	String	The message to publish.		x
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is 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 Configuration](#redis) #### Throws - REDIS:CONNECTIVITY - REDIS:INVALID\_CONFIGURATION - REDIS:INVALID\_REQUEST\_DATA - REDIS:INVALID\_STRUCTURE\_FOR\_INPUT\_DATA - REDIS:RETRY\_EXHAUSTED - REDIS:UNKNOWN - REDIS:UNABLE\_TO\_UNSUBSCRIBE ### Push To List `` Push the message payload to the desired side (LEFT or RIGHT) of the list stored at the specified key. If the key does not exist, a new key holding a list is created as long as ifExists is `false`. #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for LPUSH or RPUSH, or LPUSHX or RPUSHX.		x
Value	String	The value to push.	`#[payload]`
Push Left	Boolean	Side that receives the pushed payload. If the parameter is true, push the payload on the left side. If the parameter is `false`, push the payload on the right side.	false
If Exists	Boolean	If the parameter is `true`, execute LPUSHX or RPUSHX. If the parameter is `false`, execute LPUSH or RPUSH.	false
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type

String

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for SRANDMEMBER		x
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type

String

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key of the list from which to return elements		x
start	String	Zero-based index at which the range starts. A negative value indicates that the offset starts at the end of the list.		x
stop	String	Zero-based index at which the range ends. A negative value indicates that the offset starts at the end of the list.		x
Target Variable	String	Name of a variable that stores the operation’s output.
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is 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 Configuration](#redis) #### Throws - REDIS:CONNECTIVITY - REDIS:INVALID\_REQUEST\_DATA - REDIS:INVALID\_CONFIGURATION - REDIS:INVALID\_STRUCTURE\_FOR\_INPUT\_DATA - REDIS:RETRY\_EXHAUSTED - REDIS:UNKNOWN - REDIS:UNABLE\_TO\_UNSUBSCRIBE ### Set `` Set the key to hold the payload. If the key already holds a value, it is overwritten, regardless of its type as long as ifNotExists is `false`. #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		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 in seconds. After the timeout the key is automatically deleted by the server. A key with an associated timeout is said to be volatile in Redis terminology.
If Not Exists	Boolean	If `true`, then execute SETNX on the Redis server, otherwise execute SET.	false
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	Expression that evaluates against the operation’s output. The expression outcome is 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 Configuration](#redis) #### Throws - REDIS:CONNECTIVITY - REDIS:INVALID\_CONFIGURATION - REDIS:INVALID\_REQUEST\_DATA - REDIS:INVALID\_STRUCTURE\_FOR\_INPUT\_DATA - REDIS:RETRY\_EXHAUSTED - REDIS:UNKNOWN - REDIS:UNABLE\_TO\_UNSUBSCRIBE ### Set In Hash `` Set the specified hash field to the message payload. If the 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	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key to use for HSET		x
Value	String	The value to set.	`#[payload]`
Field	String	Field to use for HSET
If Not Exists	Boolean	If `true` execute HSETNX, otherwise HSET.	false
Target Variable	String	Name of a variable that stores the operation’s output
Target Value	String	An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type

String

Name	Type	Description	Default Value	Required
Configuration	String	Name for this configuration. Connectors reference the configuration with this name.		x
Key	String	Key of the list to modify		x
start	String	Zero-based index at which the range starts. A negative value indicates that the offset starts at the end of the list.		x
stop	String	Zero-based index at which the range ends. A negative value indicates that the offset starts at the end of the list.		x
Target Variable	String	Name of a variable that stores the operation’s output.
Target Value	String	Expression that evaluates against the operation’s output. The outcome of the expression is 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 Configuration](#redis) #### Throws - REDIS:CONNECTIVITY - REDIS:INVALID\_REQUEST\_DATA - REDIS:INVALID\_CONFIGURATION - REDIS:INVALID\_STRUCTURE\_FOR\_INPUT\_DATA - REDIS:RETRY\_EXHAUSTED - REDIS:UNKNOWN - REDIS:UNABLE\_TO\_UNSUBSCRIBE ## Types ### TLS Configures TLS to provide secure communications for the Mule app.

Field	Type	Description
Enabled Protocols	String	A comma-separated list of protocols enabled for this context.
Enabled Cipher Suites	String	A comma-separated list of cipher suites enabled for this context.
Trust Store	Truststore	Configures the TLS truststore.
Key Store	Keystore	Configures the TLS keystore.
Revocation Check	Standard Revocation Check Custom OCSP Responder CRL File

### Truststore Configures the truststore for TLS.

Field	Type	Description
Path	String	Path to the truststore. Mule resolves the path relative to the current classpath and file system.
Password	String	Password used to protect the truststore.
Type	String	Type of store.
Algorithm	String	Encryption algorithm that the truststore uses.
Insecure	Boolean	If `true`, Mule stops performing certificate validations. Setting this to `true` can make connections vulnerable to attacks.

### Keystore Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field	Type	Description
Path	String	Path to the keystore. Mule resolves the path relative to the current classpath and file system.
Type	String	Type of store.
Alias	String	Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.
Key Password	String	Password used to protect the private key.
Password	String	Password used to protect the keystore.
Algorithm	String	Encryption algorithm that the keystore uses.

### Standard Revocation Check Configures standard revocation checks for TLS certificates.

Field	Type	Description
Only End Entities	Boolean	Which elements to verify in the certificate chain: * `true` Verify only the last element in the certificate chain. * `false` Verify all elements in the certificate chain.
Prefer Crls	Boolean	How to check certificate validity: * `true` Check the Certification Revocation List (CRL) for certificate validity. * `false` Use the Online Certificate Status Protocol (OCSP) to check certificate validity.
No Fallback	Boolean	Whether to use the secondary method to check certificate validity: * `true` Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity. * `false` Do not use the secondary method to check certificate validity.
Soft Fail	Boolean	What to do if the revocation server can’t be reached or is busy: * `true` Avoid verification failure. * `false` Allow the verification to fail.

### Custom OCSP Responder Configures a custom OCSP responder for certification revocation checks.

Field	Type	Description	Default Value	Required
Url	String	URL of the OCSP responder.
Cert Alias	String	Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

### CRL File Specifies the location of the certification revocation list (CRL) file.

Field	Type	Description	Default Value	Required
Path	String	Path to the CRL file.

### Reconnection Configures a reconnection strategy for an operation.

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 fails if the test doesn’t pass after exhausting the associated reconnection strategy.
Reconnection Strategy	Reconnect Reconnect Forever	Reconnection strategy to use.

### Reconnect

Field	Type	Description	Default Value	Required
Frequency	Number	How often in milliseconds to reconnect.
Count	Number	How many reconnection attempts to make.

### Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often in milliseconds to reconnect.

### Expiration Policy Configures an expiration policy strategy.

Field	Type	Description	Default Value	Required
Max Idle Time	Number	Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.
Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Max Idle Time field.

### Subscribe Channel Attributes

Field	Type	Description	Default Value	Required
Channel	String

### Repeatable In Memory Stream Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field	Type	Description
Initial Buffer Size	Number	Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.
Buffer Size Increment	Number	This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.
Max Buffer Size	Number	Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a `STREAM_MAXIMUM_SIZE_EXCEEDED` error. A value of less than or equal to `0` means no limit.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

### Repeatable File Store Stream Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field

Type

Description

Default Value

Required

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

* Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

* Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

Unit for the In Memory Size field.

### Non-repeatable Stream Disables the repeatable stream functionality and use non-repeatable streams to have less performance overhead, memory use, and cost. ### Redelivery Policy Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.

Field	Type	Description
Max Redelivery Count	Number	Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.
Use Secure Hash	Boolean	If `true`, Mule uses a secure hash algorithm to identify a redelivered message.
Message Digest Algorithm	String	Secure hashing algorithm to use if the Use Secure Hash field is `true`. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s `hashCode()` returned.
Id Expression	String	One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is `false`.
Object Store	Object Store	Configures the object store that stores the redelivery counter for each message.

## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com)