Hibernate Second Level Cache

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

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

https://docs.microstream.one/

MicroStream offers a Hibernate cache region factory, which can be found in the cache.hibernate module.

pom.xml

<repositories>
    <repository>
        <id>microstream-releases</id>
        <url>https://repo.microstream.one/repository/maven-public/</url>
    </repository>
</repositories>
<dependencies>
    <dependency>
        <groupId>one.microstream</groupId>
        <artifactId>cache.hibernate</artifactId>
        <version>04.01.00-MS-GA</version>
    </dependency>
</dependencies>

The region factory's class name is one.microstream.cache.hibernate.CacheRegionFactory. It is configured via the property hibernate.cache.region.factory_class.

Depending on your environment it can be configured in different ways.

If you use a good old persistence.xml, set the property there:

persistence.xml

<?xml version="1.0" encoding="UTF-8"?>
<persistence version="2.1"
	xmlns="http://xmlns.jcp.org/xml/ns/persistence"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/persistence http://xmlns.jcp.org/xml/ns/persistence/persistence_2_1.xsd">
	<persistence-unit name="...">
		<provider>org.hibernate.jpa.HibernatePersistenceProvider</provider>
		...
		<properties>
			...
			<property name="hibernate.cache.region.factory_class"
				value="one.microstream.cache.hibernate.CacheRegionFactory" />
			...
		</properties>
	</persistence-unit>
</persistence>

Or for Spring applications:

application.properties

spring.jpa.properties.hibernate.cache.microstream.missing_cache_strategy=create
spring.jpa.properties.hibernate.cache.region.factory_class=one.microstream.cache.hibernate.CacheRegionFactory
spring.jpa.properties.hibernate.cache.use_query_cache=true
spring.jpa.properties.hibernate.cache.use_second_level_cache=true
spring.jpa.properties.javax.persistence.sharedCache.mode=ALL

application.yml

spring:
    jpa:
        properties:
            hibernate:
                cache:
                    microstream:
                        missing_cache_strategy: create
                    region:
                        factory_class: one.microstream.cache.hibernate.CacheRegionFactory
                    use_query_cache: true
                    use_second_level_cache: true
            javax:
                persistence:
                    sharedCache:
                        mode: ALL