MicroStream Reference Manual
MicroStream HomeAPI Docs
3.0
3.0
  • Preface
  • System Requirements
  • License
  • Changelog
  • Installation
  • Data-Store
    • Overview
    • Getting Started
    • Root Instances
    • Configuration
      • Properties
      • Storage Files and Directories
      • Using Channels
      • Housekeeping
      • Backup
      • Lock File
    • Storing Data
      • Convenience Methods and Explicit Storing (Transactions)
      • Lazy and Eager Storing
      • Transient Fields
      • Best Practice
    • Loading Data
      • Lazy Loading
        • Touched Timestamp, Null-Safe Variant
        • Clearing Lazy References
    • Deleting Data
    • Queries
    • Application Life-Cycle
    • Legacy Type Mapping
      • User Interaction
    • Backup Strategies
    • Import / Export
    • Housekeeping
    • Customizing
      • Custom Type Handler
      • Custom Legacy Type Handler
      • Custom Class Loader
      • Custom Storing Behavior
      • Optional Storage Manager Reference in Entities
    • REST Interface
      • Setup
      • REST API
      • Client GUI
    • FAQ
      • Data Model
      • Data Management
      • File Storage
      • Java Features
      • Miscellaneous
    • Addendum
      • Supported Java Features
      • Specialized Type Handlers
      • Examples and Demo Projects
  • Cache
    • Overview
    • Getting Started
    • Configuration
      • Properties
      • Storage
    • Use Cases
      • Hibernate Second Level Cache
      • Spring Cache
  • Basic Concepts
    • Layered Entities
      • Configuration
      • Defining Entities
      • Creating Entities
      • Updating Entities
      • Versioning
      • Logging
      • Multiple Layers
    • Wrapping
      • Configuration
      • Usage
Powered by GitBook
On this page
Export as PDF
  1. Cache
  2. Configuration

Properties

PreviousConfigurationNextStorage

Last updated 3 years ago

This is the manual for older MicroStream versions (Version < 5.0).

The new documentation (Version >= 5.0) is located at:

These are the available properties of the CacheConfiguration type. The names are used accordingly in the external configuration files. They can be found as constants in CacheConfigurationPropertyNames.

Property

Description

keyType

Determines the required type of keys for the Cache.

valueType

Determines the required type of values for the Cache.

storageConfigurationResourceName

Path for the for the backing store.

cacheLoaderFactory

A CacheLoader should be configured for "Read Through" caches to load values when a cache miss occurs.

cacheWriterFactory

A CacheWriter is used for write-through to an external resource.

expiryPolicyFactory

Determines when cache entries will expire based oncreation, access and modification operations.

evictionManagerFactory

Clears cache entries using a policy. Works interval-based or on entry creation.

readThrough

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.

writeThrough

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.

storeByValue

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

statisticsEnabled

Checks whether statistics collection is enabled in this cache.

managementEnabled

Checks whether management is enabled on this cache.

https://docs.microstream.one/
storage configuration