You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
Redis Key-Value Store Component
Prerequisites
An instance of Redis server needs to running on a node and to be accessible from the Blueriq Runtime.
Depending on the linux distribution, a Redis package may be available from the repository in any case consult their official documentation here.
Redis does not officially support Windows. However, the Microsoft Open Tech group develops and maintains this Windows port targeting Win64. More information here.
Enable/Disable
In order to enable the component, the profile "keyvalue-redis-store" profile must be added in the bootstrap.properties
spring.profiles.active=native,keyvalue-redis-store
Properties
Property | Description | Required | Default Value |
---|---|---|---|
blueriq.keyvalue-redis-store.connection.host-name | The DNS name or IP address of the Redis server | TRUE | |
blueriq.keyvalue-redis-store.connection.port | The port on which to connect to Redis | FALSE | 6379 |
blueriq.keyvalue-redis-store.connection.password | The password used to connect to Redis. Can be left empty if no password is required. | FALSE | |
blueriq.keyvalue-redis-store.connection.test-while-idle | Whether connections in the Redis connection pool should be tested while idle | FALSE | FALSE |
blueriq.keyvalue-redis-store.min-evictable-idle-time-millis | Minimum amount of time a Redis connection may sit idle in the connection pool before being eligible for eviction | FALSE | 60000 |
blueriq.keyvalue-redis-store.time-between-eviction-runs-millis | Amount of time between eviction runs. If set to a non-positive value, no eviction runs will occur. | FALSE | 30000 |
blueriq.keyvalue-redis-store.num-tests-per-eviction-run | The maximum number of connections to examine during an evicition run. If the value negative, roughtly 1/abs(value) connections will be examined. | FALSE | -1 |
The following example configuration connects the Runtime to a Redis instance running on localhost on the default port and using a password:
blueriq.keyvalue-redis-store.connection.host-name=localhost blueriq.keyvalue-redis-store.connection.password=example
Custom implementation plug-in
Blueriq provides an IKeyValueStore interface which can be used to interact with a generic key-value store. In order to use this interface, add blueriq-component-api to your project's dependencies:
<dependency> <groupId>com.blueriq</groupId> <artifactId>blueriq-component-api</artifactId> <version>${blueriq.version}</version> </dependency>