Package io.vertx.config.redis

=== Redis Configuration Store The Redis Configuration Store extends the Vert.x Configuration Retriever and provides the way to retrieve configuration from a Redis server.

See: Description

Class Summary

Class	Description
RedisConfigStore	An implementation of configuration store reading hash from Redis.
RedisConfigStoreFactory	Factory to create RedisConfigStore instances.

Package io.vertx.config.redis Description

=== Redis Configuration Store The Redis Configuration Store extends the Vert.x Configuration Retriever and provides the way to retrieve configuration from a Redis server. ==== Using the Redis Configuration Store To use the Redis Configuration Store, add the following dependency to the _dependencies_ section of your build descriptor: * Maven (in your `pom.xml`): [source,xml,subs="+attributes"] ---- ${maven.groupId} ${maven.artifactId} ${maven.version} ${maven.groupId} vertx-config ${maven.version} ---- * Gradle (in your `build.gradle` file): [source,groovy,subs="+attributes"] ---- compile '${maven.groupId}:vertx-config:${maven.version}' compile '${maven.groupId}:${maven.artifactId}:${maven.version}' ---- ==== Configuring the store Once added to your classpath or dependencies, you need to configure the ConfigRetriever to use this store: [source, $lang] ---- examples.Examples#example1(io.vertx.core.Vertx) ---- The store configuration is used to create an instance of RedisClient. check the documentation of the Vert.x Redis Client for further details. In addition, you can set the `key` instructing the store in which _field_ the configuration is stored. `configuration` is used by default. The created Redis client retrieves the configuration using the `HGETALL` configuration.