public Interface CacheSettings

Enables the automatic eviction of a bidirectional association's collection cache when an element in the jakarta.persistence.ManyToOne collection is added, updated, or removed without properly managing the change on the jakarta.persistence.OneToMany side.

See Also

org.hibernate.boot.SessionFactoryBuilder#applyAutomaticEvictionOfCollectionCaches(boolean)

Specifies the org.hibernate.cache.spi.CacheKeysFactory to use, either:

• an instance of org.hibernate.cache.spi.CacheKeysFactory,
• a Class implementing org.hibernate.cache.spi.CacheKeysFactory,
• the name of a class implementing org.hibernate.cache.spi.CacheKeysFactory,
• "default" as a short name for org.hibernate.cache.internal.DefaultCacheKeysFactory, or
• "simple" as a short name for org.hibernate.cache.internal.SimpleCacheKeysFactory.

The RegionFactory implementation, either:

• an instance of RegionFactory,
• a Class implementing RegionFactory, or
• he name of a class implementing RegionFactory.

Defaults to NoCachingRegionFactory, so that caching is disabled.

See Also

USE_SECOND_LEVEL_CACHE

The CacheProvider region name prefix

See Also

org.hibernate.boot.SessionFactoryBuilder#applyCacheRegionPrefix(String)

Entity cache configuration properties follow the pattern hibernate.classcache.packagename.ClassName usage[, region] where usage is the cache strategy used and region the cache region name

Collection cache configuration properties follow the pattern hibernate.collectioncache.packagename.ClassName.role usage[, region] where usage is the cache strategy used and region the cache region name

Specifies the org.hibernate.annotations.CacheConcurrencyStrategy to use by default when an entity is marked @Cacheable, but no concurrency strategy is explicitly specified via the org.hibernate.annotations.Cache annotation.

An explicit strategy may be specified using @Cache(usage=...).

See Also

org.hibernate.boot.MetadataBuilder#applyAccessType(org.hibernate.cache.spi.access.AccessType), RegionFactory#getDefaultAccessType

When enabled, specifies that the second-level cache (which JPA calls the "shared" cache) may be used, as per the rules defined in JPA 2 section 3.1.7.

See JPA 2 sections 9.4.3 and 8.2.1.7

See Also

jakarta.persistence.SharedCacheMode

Set a default value for SpecHints#HINT_SPEC_CACHE_RETRIEVE_MODE, used when the hint is not explicitly specified.

It does not usually make sense to change the default from jakarta.persistence.CacheRetrieveMode#USE.

See Also

SpecHints#HINT_SPEC_CACHE_RETRIEVE_MODE

Set a default value for SpecHints#HINT_SPEC_CACHE_STORE_MODE, used when the hint is not explicitly specified.

It does not usually make sense to change the default from jakarta.persistence.CacheStoreMode#USE.

See Also

SpecHints#HINT_SPEC_CACHE_RETRIEVE_MODE

Used to indicate whether second-level (what JPA terms shared cache) caching is enabled as per the rules defined in JPA 2 section 3.1.7.

See JPA 2 sections 9.4.3 and 8.2.1.7

Specifies the org.hibernate.cache.spi.TimestampsCacheFactory to use.

See Also

org.hibernate.boot.SessionFactoryBuilder#applyTimestampsCacheFactory(TimestampsCacheFactory)

Enable direct storage of entity references into the second level cache when applicable. This is appropriate only for immutable entities.

By default, entities are always stored in a "disassembled" form, that is, as a tuple of attribute values.

See Also

org.hibernate.boot.SessionFactoryBuilder#applyDirectReferenceCaching(boolean)

Optimize interaction with the second-level cache to minimize writes, at the cost of an additional read before each write. This setting is useful if writes to the cache are much more expensive than reads from the cache, for example, if the cache is a distributed cache.

It's not usually necessary to set this explicitly because, by default, it's set to a sensible value by the second-level cache implementation.

See Also

org.hibernate.boot.SessionFactoryBuilder#applyMinimalPutsForCaching(boolean), RegionFactory#isMinimalPutsEnabledByDefault()

Enable the query results cache

See Also

org.hibernate.boot.SessionFactoryBuilder#applyQueryCacheSupport(boolean)

When enabled, specifies that the second-level cache may be used.

By default, if the configured RegionFactory is not the org.hibernate.cache.internal.NoCachingRegionFactory, then the second-level cache is enabled. Otherwise, the second-level cache is disabled.

See Also

CACHE_REGION_FACTORY, org.hibernate.boot.SessionFactoryBuilder#applySecondLevelCacheSupport(boolean)

Enables the use of structured second-level cache entries. This makes the cache entries human-readable, but carries a performance cost.

See Also

org.hibernate.boot.SessionFactoryBuilder#applyStructuredCacheEntries(boolean)