<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>RedisConnectionPoolService</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">RedisConnectionPoolService</h1><h2>Description: </h2><p>A service that provides connections to Redis.</p><h3>Tags: </h3><p>redis, cache</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Redis Mode</strong></td><td>Redis Mode</td><td id="default-value">Standalone</td><td id="allowable-values"><ul><li>Standalone <img src="../../../../../html/images/iconInfo.png" alt="A single standalone Redis instance." title="A single standalone Redis instance."></img></li><li>Sentinel <img src="../../../../../html/images/iconInfo.png" alt="Redis Sentinel which provides high-availability. Described further at https://redis.io/topics/sentinel" title="Redis Sentinel which provides high-availability. Described further at https://redis.io/topics/sentinel"></img></li><li>Cluster <img src="../../../../../html/images/iconInfo.png" alt="Clustered Redis which provides sharding and replication. Described further at https://redis.io/topics/cluster-spec" title="Clustered Redis which provides sharding and replication. Described further at https://redis.io/topics/cluster-spec"></img></li></ul></td><td id="description">The type of Redis being communicated with - standalone, sentinel, or clustered.</td></tr><tr><td id="name"><strong>Connection String</strong></td><td>Connection String</td><td></td><td id="allowable-values"></td><td id="description">The connection string for Redis. In a standalone instance this value will be of the form hostname:port. In a sentinel instance this value will be the comma-separated list of sentinels, such as host1:port1,host2:port2,host3:port3. In a clustered instance this value will be the comma-separated list of cluster masters, such as host1:port,host2:port,host3:port.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Database Index</strong></td><td>Database Index</td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">The database index to be used by connections created from this connection pool. See the databases property in redis.conf, by default databases 0-15 will be available.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Communication Timeout</strong></td><td>Communication Timeout</td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The timeout to use when attempting to communicate with Redis.</td></tr><tr><td id="name"><strong>Cluster Max Redirects</strong></td><td>Cluster Max Redirects</td><td id="default-value">5</td><td id="allowable-values"></td><td id="description">The maximum number of redirects that can be performed when clustered.</td></tr><tr><td id="name">Sentinel Master</td><td>Sentinel Master</td><td></td><td id="allowable-values"></td><td id="description">The name of the sentinel master, require when Mode is set to Sentinel<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Password</td><td>Password</td><td></td><td id="allowable-values"></td><td id="description">The password used to authenticate to the Redis server. See the requirepass property in redis.conf.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">SSL Context Service</td><td>SSL Context Service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">If specified, this service will be used to create an SSL Context that will be used to secure communications; if not specified, communications will not be secure</td></tr><tr><td id="name"><strong>Pool - Max Total</strong></td><td>Pool - Max Total</td><td id="default-value">8</td><td id="allowable-values"></td><td id="description">The maximum number of connections that can be allocated by the pool (checked out to clients, or idle awaiting checkout). A negative value indicates that there is no limit.</td></tr><tr><td id="name"><strong>Pool - Max Idle</strong></td><td>Pool - Max Idle</td><td id="default-value">8</td><td id="allowable-values"></td><td id="description">The maximum number of idle connections that can be held in the pool, or a negative value if there is no limit.</td></tr><tr><td id="name"><strong>Pool - Min Idle</strong></td><td>Pool - Min Idle</td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">The target for the minimum number of idle connections to maintain in the pool. If the configured value of Min Idle is greater than the configured value for Max Idle, then the value of Max Idle will be used instead.</td></tr><tr><td id="name"><strong>Pool - Block When Exhausted</strong></td><td>Pool - Block When Exhausted</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not clients should block and wait when trying to obtain a connection from the pool when the pool has no available connections. Setting this to false means an error will occur immediately when a client requests a connection and none are available.</td></tr><tr><td id="name"><strong>Pool - Max Wait Time</strong></td><td>Pool - Max Wait Time</td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait for an available connection when Block When Exhausted is set to true.</td></tr><tr><td id="name"><strong>Pool - Min Evictable Idle Time</strong></td><td>Pool - Min Evictable Idle Time</td><td id="default-value">60 seconds</td><td id="allowable-values"></td><td id="description">The minimum amount of time an object may sit idle in the pool before it is eligible for eviction.</td></tr><tr><td id="name"><strong>Pool - Time Between Eviction Runs</strong></td><td>Pool - Time Between Eviction Runs</td><td id="default-value">30 seconds</td><td id="allowable-values"></td><td id="description">The amount of time between attempting to evict idle connections from the pool.</td></tr><tr><td id="name"><strong>Pool - Num Tests Per Eviction Run</strong></td><td>Pool - Num Tests Per Eviction Run</td><td id="default-value">-1</td><td id="allowable-values"></td><td id="description">The number of connections to tests per eviction attempt. A negative value indicates to test all connections.</td></tr><tr><td id="name"><strong>Pool - Test On Create</strong></td><td>Pool - Test On Create</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not connections should be tested upon creation.</td></tr><tr><td id="name"><strong>Pool - Test On Borrow</strong></td><td>Pool - Test On Borrow</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not connections should be tested upon borrowing from the pool.</td></tr><tr><td id="name"><strong>Pool - Test On Return</strong></td><td>Pool - Test On Return</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not connections should be tested upon returning to the pool.</td></tr><tr><td id="name"><strong>Pool - Test While Idle</strong></td><td>Pool - Test While Idle</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not connections should be tested while idle.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>