Skip to content

Commit

Permalink
docs: Updated for key prefix change
Browse files Browse the repository at this point in the history
  • Loading branch information
Julien Ruaux committed Mar 30, 2023
1 parent 3e09d46 commit f06e65f
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
:property-prefix: smartcache
:grafana-dir: demo/redis-smart-cache-demo/grafana
:imagesdir: src/media
:toc:
:toc-placement!:

++++
<p align="center">
Expand All @@ -32,14 +34,7 @@ Implemented as a wrapper around your backend database's JDBC driver, {product-na
slow, repeated SQL queries in Redis, bypassing expensive database calls and greatly
improving response times.

== Table of Contents

* <<Background>>
* <<Quick start>>
* <<Installation>>
* <<Usage>>
* <<Support>>
* <<License>>
toc::[]

== Background

Expand Down Expand Up @@ -157,6 +152,18 @@ Next step is providing bootstrap configuration.

Refer to the <<property_types>> section for details on different property types.

==== Application

===== `{property-prefix}.name`

* Type: <<property_type_string>>
* Default value: `{property-prefix}`

Name used to uniquely identify an application.
This is the prefix for all Redis keys used by {product-name}, such as cache entries, ruleset configuration, metrics, etc.

NOTE: This property should be the same across all instances of an application.

==== Backend database

===== `{property-prefix}.driver.class-name`
Expand All @@ -182,14 +189,7 @@ These will be passed to the backend JDBC driver as is.

To further configure how {product-name} interacts with Redis, set the following properties:

===== `{property-prefix}.redis.key.prefix`

* Type: <<property_type_string>>
* Default value: `{property-prefix}`

Prefix for all Redis keys used by {product-name}, such as cache entries, configuration, and metrics.

===== `{property-prefix}.redis.key.separator`
===== `{property-prefix}.redis.key-separator`

* Type: <<property_type_string>>
* Default value: `:`
Expand Down

0 comments on commit f06e65f

Please sign in to comment.