@ -48,12 +48,84 @@ redisson:
#### 2.2 Cache settings
|Setting name|Type|Description|
|------------|----|-----------|
|redisson.caches.*.max-size|java.lang.Integer|Max size of this cache. Superfluous elements are evicted using LRU algorithm. If < code > 0< / code > the cache is unbounded (default).|
|redisson.caches.*.codec|java.lang.Class|Redis data codec applied to cache entries. Default is MarshallingCodec codec.|
|redisson.caches.*.expire-after-write|java.time.Duration|Cache entry time to live duration applied after each write operation.|
|redisson.caches.*.expire-after-access|java.time.Duration|Cache entry time to live duration applied after each read operation.|
|Setting prefix | Local cache | Data< br / > partitioning | Ultra-fast read/write |
| ------------- | :-----------: | :----------:| :----------:|
|redisson.caches.*< br / > < sub > < i > open-source version< / i > < / sub > | ❌ | ❌ | ❌ |
|redisson.caches.*< br / > < sub > < i > [Redisson PRO](http://redisson.pro) version< / i > < / sub > | ❌ | ❌ | ✔️ |
|redisson.local-caches.*< br />< sub >< i > available only in [Redisson PRO ](http://redisson.pro )</ i ></ sub > | ✔️ | ❌ | ✔️ |
|redisson.clustered-caches.*< br />< sub >< i > available only in [Redisson PRO ](http://redisson.pro )</ i ></ sub > | ❌ | ✔️ | ✔️ |
|redisson.clustered-local-caches.*< br />< sub >< i > available only in [Redisson PRO ](http://redisson.pro )</ i ></ sub > | ✔️ | ✔️ | ✔️ |
< br / >
< details >
< summary > < b > Map Cache< / b > settings. Click to expand!< / summary >
< br / >
| | |
|-|-|
|Setting name| `redisson.caches.[CACHE_NAME].max-size` |
|Type| `java.lang.Integer` |
|Description| Max size of this cache. Superfluous elements are evicted using LRU algorithm. If < code > 0< / code > the cache is unbounded. |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.caches.[CACHE_NAME].codec` |
|Type| `java.lang.Class` |
|Description| Redis data codec applied to cache entries. |
|Default value| `MarshallingCodec` |
| | |
|-|-|
|Setting name| `redisson.caches.[CACHE_NAME].expire-after-write` |
|Type| `java.time.Duration` |
|Description| Cache entry time to live duration applied after each write operation. Disabled if value is < code > 0< / code > . |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.caches.[CACHE_NAME].expire-after-access` |
|Type| `java.time.Duration` |
|Description| Cache entry time to live duration applied after each read operation. Disabled if value is < code > 0< / code > . |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.caches.[CACHE_NAME].write-behind-batch-size` |
|Type| `java.lang.Integer` |
|Description| Write behind tasks batch size. During `MapWriter` methods execution all updates accumulated into a batch of specified size. |
|Default value| `50` |
| | |
|-|-|
|Setting name| `redisson.caches.[CACHE_NAME].write-behind-delay` |
|Type| `java.time.Duration` |
|Description| Write behind tasks execution delay. All updates would be applied with lag not more than specified delay. |
|Default value| `1000ms` |
| | |
|-|-|
|Setting name| `redisson.caches.[CACHE_NAME].writer` |
|Type| `java.lang.Class` |
|Description| `MapWriter` object used for write-through operations |
|Default value| `null` |
| | |
|-|-|
|Setting name| `redisson.caches.[CACHE_NAME].write-mode` |
|Type| `java.lang.String` |
|Description| Write mode. Default is `WRITE_THROUGH` |
|Default value| `null` |
| | |
|-|-|
|Setting name| `redisson.caches.[CACHE_NAME].loader` |
|Type| `java.lang.Class` |
|Description| `MapLoader` object used to load entries during read-operations execution |
|Default value| `null` |
Config example:
```yaml
@ -70,7 +142,385 @@ redisson:
expire-after-write: 200s
expire-after-access: 30s
```
< / details >
< details >
< summary > < b > Clustered Map Cache< / b > settings (< i > available only in < a href = "https://redisson.pro" > Redisson PRO< / a > < / i > ). Click to expand!< / summary >
< br / >
| | |
|-|-|
|Setting name| `redisson.clustered-caches.[CACHE_NAME].max-size` |
|Type| `java.lang.Integer` |
|Description| Max size of this cache. Superfluous elements are evicted using LRU algorithm. If < code > 0< / code > the cache is unbounded. |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.clustered-caches.[CACHE_NAME].codec` |
|Type| `java.lang.Class` |
|Description| Redis data codec applied to cache entries. |
|Default value| `MarshallingCodec` |
| | |
|-|-|
|Setting name| `redisson.clustered-caches.[CACHE_NAME].expire-after-write` |
|Type| `java.time.Duration` |
|Description| Cache entry time to live duration applied after each write operation. Disabled if value is < code > 0< / code > . |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.clustered-caches.[CACHE_NAME].expire-after-access` |
|Type| `java.time.Duration` |
|Description| Cache entry time to live duration applied after each read operation. Disabled if value is < code > 0< / code > . |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.clustered-caches.[CACHE_NAME].write-behind-batch-size` |
|Type| `java.lang.Integer` |
|Description| Write behind tasks batch size. During `MapWriter` methods execution all updates accumulated into a batch of specified size. |
|Default value| `50` |
| | |
|-|-|
|Setting name| `redisson.clustered-caches.[CACHE_NAME].write-behind-delay` |
|Type| `java.time.Duration` |
|Description| Write behind tasks execution delay. All updates would be applied with lag not more than specified delay. |
|Default value| `1000ms` |
| | |
|-|-|
|Setting name| `redisson.clustered-caches.[CACHE_NAME].writer` |
|Type| `java.lang.Class` |
|Description| `MapWriter` object used for write-through operations |
|Default value| `null` |
| | |
|-|-|
|Setting name| `redisson.clustered-caches.[CACHE_NAME].write-mode` |
|Type| `java.lang.String` |
|Description| Write mode. Default is `WRITE_THROUGH` |
|Default value| `null` |
| | |
|-|-|
|Setting name| `redisson.clustered-caches.[CACHE_NAME].loader` |
|Type| `java.lang.Class` |
|Description| `MapLoader` object used to load entries during read-operations execution |
|Default value| `null` |
Config example:
```yaml
redisson:
single-server-config:
address: "redis://127.0.0.1:6379"
clustered-caches:
my-cache1:
expire-after-write: 10s
expire-after-access: 3s
max-size: 1000
codec: org.redisson.codec.MarshallingCodec
my-cache2:
expire-after-write: 200s
expire-after-access: 30s
```
< / details >
< details >
< summary > < b > Clustered Local Cached Map Cache< / b > settings (< i > available only in < a href = "https://redisson.pro" > Redisson PRO< / a > < / i > ). Click to expand!< / summary >
< br / >
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].max-size` |
|Type| `java.lang.Integer` |
|Description| Max size of this cache. Superfluous elements are evicted using LRU algorithm. If < code > 0< / code > the cache is unbounded. |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].codec` |
|Type| `java.lang.Class` |
|Description| Redis data codec applied to cache entries. |
|Default value| `MarshallingCodec` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].expire-after-write` |
|Type| `java.time.Duration` |
|Description| Cache entry time to live duration applied after each write operation. Disabled if value is < code > 0< / code > . |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].expire-after-access` |
|Type| `java.time.Duration` |
|Description| Cache entry time to live duration applied after each read operation. Disabled if value is < code > 0< / code > . |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].write-behind-batch-size` |
|Type| `java.lang.Integer` |
|Description| Write behind tasks batch size. During `MapWriter` methods execution all updates accumulated into a batch of specified size. |
|Default value| `50` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].write-behind-delay` |
|Type| `java.time.Duration` |
|Description| Write behind tasks execution delay. All updates would be applied with lag not more than specified delay. |
|Default value| `1000ms` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].writer` |
|Type| `java.lang.Class` |
|Description| `MapWriter` object used for write-through operations |
|Default value| `null` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].write-mode` |
|Type| `java.lang.String` |
|Description| Write mode. Default is `WRITE_THROUGH` |
|Default value| `null` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].loader` |
|Type| `java.lang.Class` |
|Description| `MapLoader` object used to load entries during read-operations execution |
|Default value| `null` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].cache-size` |
|Type| `java.lang.Integer` |
|Description| Local cache size. If size is < code > 0< / code > then local cache is unbounded. |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].reconnection-strategy` |
|Type| `java.lang.String` |
|Description| Used to load missed updates during any connection failures to Redis. Since, local cache updates can't be executed in absence of connection to Redis. < br / > `CLEAR` - Clear local cache if map instance has been disconnected for a while. < br / > `LOAD` - Store invalidated entry hash in invalidation log for 10 minutes.< br / > Cache keys for stored invalidated entry hashes will be removed if LocalCachedMap instance has been disconnected less than 10 minutes or whole cache will be cleaned otherwise. < br / > `NONE` - No reconnection handling|
|Default value| `NONE` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].sync-strategy` |
|Type| `java.lang.String` |
|Description| Used to synchronize local cache changes. < br / > `INVALIDATE` - Invalidate cache entry across all LocalCachedMap instances on map entry change. < br / > `UPDATE` - Insert/update cache entry across all LocalCachedMap instances on map entry change. < br / > `NONE` - No synchronizations on map changes.|
|Default value| `NONE` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].eviction-policy` |
|Type| `java.lang.String` |
|Description| Used to synchronize local cache changes. < br / > `LRU` - uses local cache with LRU (least recently used) eviction policy. < br / > `LFU` - uses local cache with LFU (least frequently used) eviction policy. < br / > `SOFT` - uses local cache with soft references. The garbage collector will evict items from the local cache when the JVM is running out of memory. < br / > `WEAK` - uses local cache with weak references. The garbage collector will evict items from the local cache when it became weakly reachable. < br / > `NONE` - doesn't use eviction policy, but timeToLive and maxIdleTime params are still working. |
|Default value| `NONE` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].time-to-live` |
|Type| `java.lang.String` |
|Description| Time to live duration of each map entry in local cache. If value equals to < code > 0< / code > then timeout is not applied. |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].max-idle` |
|Type| `java.lang.String` |
|Description| Defines max idle time duration of each map entry in local cache. If value equals to < code > 0< / code > then timeout is not applied. |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].cache-provider` |
|Type| `java.lang.String` |
|Description| Defines Cache provider used as local cache store.< br / > `REDISSON` - uses Redisson own implementation.< br / > `CAFFEINE` - uses Caffeine implementation. |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.clustered-local-caches.[CACHE_NAME].store-с |
|Type| `java.lang.String` |
|Description| Defines whether to store a cache miss into the local cache. |
|Default value| `false` |
Config example:
```yaml
redisson:
single-server-config:
address: "redis://127.0.0.1:6379"
clustered-local-caches:
my-cache1:
expire-after-write: 10s
expire-after-access: 3s
max-size: 1000
codec: org.redisson.codec.MarshallingCodec
store-с
eviction-policy: `WEAK`
cache-size: 5000
my-cache2:
expire-after-write: 200s
expire-after-access: 30s
```
< / details >
< details >
< summary > < b > Local Cached Map Cache< / b > settings (< i > available only in < a href = "https://redisson.pro" > Redisson PRO< / a > < / i > ). Click to expand!< / summary >
< br / >
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].max-size` |
|Type| `java.lang.Integer` |
|Description| Max size of this cache. Superfluous elements are evicted using LRU algorithm. If < code > 0< / code > the cache is unbounded. |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].codec` |
|Type| `java.lang.Class` |
|Description| Redis data codec applied to cache entries. |
|Default value| `MarshallingCodec` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].expire-after-write` |
|Type| `java.time.Duration` |
|Description| Cache entry time to live duration applied after each write operation. Disabled if value is < code > 0< / code > . |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].expire-after-access` |
|Type| `java.time.Duration` |
|Description| Cache entry time to live duration applied after each read operation. Disabled if value is < code > 0< / code > . |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].write-behind-batch-size` |
|Type| `java.lang.Integer` |
|Description| Write behind tasks batch size. During `MapWriter` methods execution all updates accumulated into a batch of specified size. |
|Default value| `50` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].write-behind-delay` |
|Type| `java.time.Duration` |
|Description| Write behind tasks execution delay. All updates would be applied with lag not more than specified delay. |
|Default value| `1000ms` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].writer` |
|Type| `java.lang.Class` |
|Description| `MapWriter` object used for write-through operations |
|Default value| `null` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].write-mode` |
|Type| `java.lang.String` |
|Description| Write mode. Default is `WRITE_THROUGH` |
|Default value| `null` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].loader` |
|Type| `java.lang.Class` |
|Description| `MapLoader` object used to load entries during read-operations execution |
|Default value| `null` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].cache-size` |
|Type| `java.lang.Integer` |
|Description| Local cache size. If size is < code > 0< / code > then local cache is unbounded. |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].reconnection-strategy` |
|Type| `java.lang.String` |
|Description| Used to load missed updates during any connection failures to Redis. Since, local cache updates can't be executed in absence of connection to Redis. < br / > `CLEAR` - Clear local cache if map instance has been disconnected for a while. < br / > `LOAD` - Store invalidated entry hash in invalidation log for 10 minutes.< br / > Cache keys for stored invalidated entry hashes will be removed if LocalCachedMap instance has been disconnected less than 10 minutes or whole cache will be cleaned otherwise. < br / > `NONE` - No reconnection handling|
|Default value| `NONE` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].sync-strategy` |
|Type| `java.lang.String` |
|Description| Used to synchronize local cache changes. < br / > `INVALIDATE` - Invalidate cache entry across all LocalCachedMap instances on map entry change. < br / > `UPDATE` - Insert/update cache entry across all LocalCachedMap instances on map entry change. < br / > `NONE` - No synchronizations on map changes.|
|Default value| `NONE` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].eviction-policy` |
|Type| `java.lang.String` |
|Description| Used to synchronize local cache changes. < br / > `LRU` - uses local cache with LRU (least recently used) eviction policy. < br / > `LFU` - uses local cache with LFU (least frequently used) eviction policy. < br / > `SOFT` - uses local cache with soft references. The garbage collector will evict items from the local cache when the JVM is running out of memory. < br / > `WEAK` - uses local cache with weak references. The garbage collector will evict items from the local cache when it became weakly reachable. < br / > `NONE` - doesn't use eviction policy, but timeToLive and maxIdleTime params are still working. |
|Default value| `NONE` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].time-to-live` |
|Type| `java.lang.String` |
|Description| Time to live duration of each map entry in local cache. If value equals to < code > 0< / code > then timeout is not applied. |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].max-idle` |
|Type| `java.lang.String` |
|Description| Defines max idle time duration of each map entry in local cache. If value equals to < code > 0< / code > then timeout is not applied. |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].cache-provider` |
|Type| `java.lang.String` |
|Description| Defines Cache provider used as local cache store.< br / > `REDISSON` - uses Redisson own implementation.< br / > `CAFFEINE` - uses Caffeine implementation. |
|Default value| `0` |
| | |
|-|-|
|Setting name| `redisson.local-caches.[CACHE_NAME].store-с |
|Type| `java.lang.String` |
|Description| Defines whether to store a cache miss into the local cache. |
|Default value| `false` |
Config example:
```yaml
redisson:
single-server-config:
address: "redis://127.0.0.1:6379"
local-caches:
my-cache1:
expire-after-write: 10s
expire-after-access: 3s
max-size: 1000
codec: org.redisson.codec.MarshallingCodec
store-с
eviction-policy: `WEAK`
cache-size: 5000
my-cache2:
expire-after-write: 200s
expire-after-access: 30s
```
< / details >
#### 2.3 Session settings
[Session ](https://docs.micronaut.io/latest/api/io/micronaut/session/Session.html ) store implementation.
@ -128,5 +578,3 @@ public class CarsService {
}
}
```
Consider __ [Redisson PRO ](https://redisson.pro )__ version for **ultra-fast performance** and **support by SLA** .
Nikita Koksharov
4 years ago