Configuration Reference

Version:1.0.1-SNAPSHOT

Microstream Cache Config Properties

🔗
Table 1. Configuration Properties for CacheConfigurationProperties
Property Type Description

microstream.cache.enabled

boolean

Whether MicroStream Cache module is enabled. Default Value: true

🔗
Table 2. Configuration Properties for MicroStreamCacheConfigurationProperties
Property Type Description

microstream.cache.*.enabled

boolean

Whether this cache is enabled. Default Value: {@value #DEFAULT_ENABLED}

microstream.cache.*.key-type

java.lang.Class

The required type of keys for the Cache.

microstream.cache.*.value-type

java.lang.Class

Determines type of values for the Cache.

microstream.cache.*.storage

java.lang.String

Name qualifier for MicroStream Storage Manager

microstream.cache.*.read-through

java.lang.Boolean

When in "read-through" mode, cache misses that occur due to cache entries not existing as a result of performing a "get" will appropriately cause the configured CacheLoader to be invoked. When you set a Storage Manager, "read-through" mode is activated.

microstream.cache.*.write-through

java.lang.Boolean

When in "write-through" mode, cache updates that occur as a result of performing "put" operations will appropriately cause the configured CacheWriter to be invoked.When you set a Storage Manager, "write-through" mode is activated.

microstream.cache.*.store-by-value

java.lang.Boolean

When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.

microstream.cache.*.statistics-enabled

java.lang.Boolean

Whether statistics collection is enabled in this cache.

microstream.cache.*.management-enabled

java.lang.Boolean

Whether management is enabled on this cache.

Microstream Config Properties

🔗
Table 3. Configuration Properties for DefaultEmbeddedStorageConfigurationProvider
Property Type Description

microstream.storage.*.storage-directory

java.lang.String

microstream.storage.*.storage-directory-in-user-home

java.lang.String

microstream.storage.*.deletion-directory

java.lang.String

microstream.storage.*.truncation-directory

java.lang.String

microstream.storage.*.backup-directory

java.lang.String

microstream.storage.*.backup-directory-in-user-home

java.lang.String

microstream.storage.*.channel-count

int

microstream.storage.*.channel-directory-prefix

java.lang.String

microstream.storage.*.data-file-prefix

java.lang.String

microstream.storage.*.data-file-suffix

java.lang.String

microstream.storage.*.transaction-file-prefix

java.lang.String

microstream.storage.*.transaction-file-suffix

java.lang.String

microstream.storage.*.type-dictionary-file-name

java.lang.String

microstream.storage.*.rescued-file-suffix

java.lang.String

microstream.storage.*.lock-file-name

java.lang.String

microstream.storage.*.housekeeping-interval

java.time.Duration

microstream.storage.*.housekeeping-time-budget

java.time.Duration

microstream.storage.*.entity-cache-threshold

long

microstream.storage.*.entity-cache-timeout

java.time.Duration

microstream.storage.*.data-file-minimum-size

one.microstream.configuration.types.ByteSize

microstream.storage.*.data-file-maximum-size

one.microstream.configuration.types.ByteSize

microstream.storage.*.data-file-minimum-use-ratio

double

microstream.storage.*.data-file-cleanup-head-file

boolean

microstream.storage.*.all

one.microstream.collections.types.XGettingCollection

microstream.storage.*.root-class

java.lang.Class

Class of the Root Instance. <a href="https://docs.microstream.one/manual/storage/root-instances.html">Root Instances</a>

🔗
Table 4. Configuration Properties for MicroStreamConfigurationProperties
Property Type Description

microstream.enabled

boolean

Whether MicroStream module is enabled. Default Value: true

Microstream Rest Config Properties

🔗
Table 5. Configuration Properties for MicroStreamRestControllerConfigurationProperties
Property Type Description

microstream.rest.enabled

boolean

Enables {@link MicroStreamRestController}. Default value false

microstream.rest.path

java.lang.String

Path to the {@link MicroStreamRestController}. Default value "microstream"