Page tree
Skip to end of metadata
Go to start of metadata

The Aspire Redis Connection opens a connection to a Redis database. When requesting a connection, one is returned from the connection pool if it exists. If there are no available connections in the pool, then a new one will be allocated.

When used as a pipeline stage, the stage will fetch a connection from the connection pool and will store it as a job variable with a custom name defined at initialization time so it can be used by pipeline modules down-stream. It also puts a connection handler so that when the job is closed, the connection will be automatically returned back to the connection pool.

Redis Connection
Factory Namecom.searchtechnologies.aspire:aspire-redis-connection


OutputsJob variable (when used as a pipeline stage), holds a Redis connection.


redisServerstringlocalhostHostname of the Redis server
redisPortInteger6379Port where the Redis server is hosted.
redisTimeoutInteger10000Redis Connection timeout.
databasestringaspire_database1Name of the database to use.
variablestringredisConnName of the job variable that will hold the redis connection.
maxRetriesInteger3If there is a connection failure, the number of times to retry before failing the action.
metaDBInteger-1Database number in Redis to store a mapping of database names and the corresponding Redis database number. If -1, uses the HASH storing approach in Redis.

Example Configuration

  <component factoryName="aspire-redis-connection" name="RedisAllDocuments" subType="default">

Example Use Within A Pipeline

  <pipeline name="process-patent" default="true">
      <stage component="FetchUrl" />
      <stage component="LoadXML" />
      <stage component="RedisAllDocuments"/>

      <!-- Now that the connection has been opened and attached to the job, you can
           use the connection inside of Groovy scripts with the "redisAllDocuments" variable.

           In the future, there may be other components which will use it as well.

Example Use from Within a Groovy scripting component

<component name="TestRedis" subType="default" factoryName="aspire-groovy">
     def documentTotal = redisAllDocuments.dbSize();

     redisAllDocuments.set("myKey", "myValue");

Available methods

  • set(): Single key/value set.
  • get(): Single key get.
  • mset(): Multivalue set
  • mget(): Multivalue get
  • dbSize(): Database size
  • close(): Close connection
  • No labels