Package org.hibernate.cfg

Interface CacheSettings

All Known Subinterfaces:

AvailableSettings

All Known Implementing Classes:

Environment

public interface CacheSettings

Settings for Hibernate's second-level caching

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTO_EVICT_COLLECTION_CACHE	Enables the automatic eviction of a bidirectional association's collection cache when an element in the ManyToOne collection is added, updated, or removed without properly managing the change on the OneToMany side.
static final String	CACHE_KEYS_FACTORY	Deprecated. this is only honored for hibernate-infinispan
static final String	CACHE_REGION_FACTORY	The RegionFactory implementation, either: a short strategy name, for example, jcache or infinispan, an instance of RegionFactory, a Class object representing a class that implements RegionFactory, or the name of a class implementing RegionFactory.
static final String	CACHE_REGION_PREFIX	The CacheProvider region name prefix
static final String	CLASS_CACHE_PREFIX	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
static final String	COLLECTION_CACHE_PREFIX	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
static final String	DEFAULT_CACHE_CONCURRENCY_STRATEGY	Specifies the CacheConcurrencyStrategy to use by default when an entity is marked @Cacheable, but no concurrency strategy is explicitly specified via the Cache annotation.
static final String	JAKARTA_SHARED_CACHE_MODE	Specifies the SharedCacheMode.
static final String	JAKARTA_SHARED_CACHE_RETRIEVE_MODE	Set a default value for SpecHints.HINT_SPEC_CACHE_RETRIEVE_MODE, used when the hint is not explicitly specified.
static final String	JAKARTA_SHARED_CACHE_STORE_MODE	Set a default value for SpecHints.HINT_SPEC_CACHE_STORE_MODE, used when the hint is not explicitly specified.
static final String	JPA_SHARED_CACHE_MODE	Deprecated. Use JAKARTA_SHARED_CACHE_MODE instead
static final String	JPA_SHARED_CACHE_RETRIEVE_MODE	Deprecated. Use JAKARTA_SHARED_CACHE_RETRIEVE_MODE instead
static final String	JPA_SHARED_CACHE_STORE_MODE	Deprecated. Use JAKARTA_SHARED_CACHE_STORE_MODE instead
static final String	QUERY_CACHE_FACTORY	Specifies the TimestampsCacheFactory to use.
static final String	QUERY_CACHE_LAYOUT	Specifies the default CacheLayout to use for the query cache.
static final String	USE_DIRECT_REFERENCE_CACHE_ENTRIES	Enable direct storage of entity references into the second level cache when applicable.
static final String	USE_MINIMAL_PUTS	Optimize interaction with the second-level cache to minimize writes, at the cost of an additional read before each write.
static final String	USE_QUERY_CACHE	Enable the query results cache
static final String	USE_SECOND_LEVEL_CACHE	When enabled, specifies that the second-level cache may be used.
static final String	USE_STRUCTURED_CACHE	Enables the use of structured second-level cache entries.

Field Details

JAKARTA_SHARED_CACHE_MODE

static final String JAKARTA_SHARED_CACHE_MODE

Specifies the SharedCacheMode.

Hibernate is designed to be used with ENABLE_SELECTIVE, and we strongly discourage the use of ALL or DISABLE_SELECTIVE, since in any multiuser system a cache is always a potential source of bugs which are difficult to isolate and reproduce. Caching should never be turned on "by accident".

Setting the shared cache mode to SharedCacheMode.NONE has very nearly the same effect as disabling the second-level cache, globally suppressing every occurrence of the Cacheable and Cache annotations.

See Also:

• SharedCacheMode
• Constant Field Values

Default Value:

ENABLE_SELECTIVE

JAKARTA_SHARED_CACHE_RETRIEVE_MODE

static final String JAKARTA_SHARED_CACHE_RETRIEVE_MODE

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 CacheRetrieveMode.USE.

See Also:

• SpecHints.HINT_SPEC_CACHE_RETRIEVE_MODE
• Constant Field Values

Default Value:

USE

JAKARTA_SHARED_CACHE_STORE_MODE

static final String JAKARTA_SHARED_CACHE_STORE_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 CacheStoreMode.USE.

See Also:

• SpecHints.HINT_SPEC_CACHE_RETRIEVE_MODE
• Constant Field Values

Default Value:

USE

USE_SECOND_LEVEL_CACHE

static final String USE_SECOND_LEVEL_CACHE

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

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

See Also:

• CACHE_REGION_FACTORY
• SessionFactoryBuilder.applySecondLevelCacheSupport(boolean)
• Constant Field Values

Default Value:

true when a provider is specified; false otherwise.

USE_QUERY_CACHE

static final String USE_QUERY_CACHE

Enable the query results cache

See Also:

• SessionFactoryBuilder.applyQueryCacheSupport(boolean)
• Constant Field Values

Default Value:

false

QUERY_CACHE_LAYOUT

@Incubating
static final String QUERY_CACHE_LAYOUT

Specifies the default CacheLayout to use for the query cache.

Since:

6.5

See Also:

• SessionFactoryBuilder.applyQueryCacheLayout(CacheLayout)
• QueryCacheLayout
• Constant Field Values

CACHE_REGION_FACTORY

static final String CACHE_REGION_FACTORY

The RegionFactory implementation, either:

• a short strategy name, for example, jcache or infinispan,
• an instance of RegionFactory,
• a Class object representing a class that implements RegionFactory, or
• the name of a class implementing RegionFactory.

See Also:

• USE_SECOND_LEVEL_CACHE
• Constant Field Values

API Note:

The term "class" appears in the setting name due to legacy reasons; however it can accept instances.

Default Value:

NoCachingRegionFactory, so that caching is disabled.

QUERY_CACHE_FACTORY

static final String QUERY_CACHE_FACTORY

Specifies the TimestampsCacheFactory to use.

See Also:

• SessionFactoryBuilder.applyTimestampsCacheFactory(TimestampsCacheFactory)
• Constant Field Values

CACHE_REGION_PREFIX

static final String CACHE_REGION_PREFIX

The CacheProvider region name prefix

See Also:

• SessionFactoryBuilder.applyCacheRegionPrefix(String)
• Constant Field Values

DEFAULT_CACHE_CONCURRENCY_STRATEGY

static final String DEFAULT_CACHE_CONCURRENCY_STRATEGY

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

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

See Also:

• MetadataBuilder.applyAccessType(org.hibernate.cache.spi.access.AccessType)
• RegionFactory.getDefaultAccessType()
• Constant Field Values

Default Value:

The cache provider's default strategy

USE_MINIMAL_PUTS

static final String USE_MINIMAL_PUTS

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:

• SessionFactoryBuilder.applyMinimalPutsForCaching(boolean)
• RegionFactory.isMinimalPutsEnabledByDefault()
• Constant Field Values

Default Value:

The cache provider's default

USE_STRUCTURED_CACHE

static final String USE_STRUCTURED_CACHE

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

See Also:

• SessionFactoryBuilder.applyStructuredCacheEntries(boolean)
• Constant Field Values

Default Value:

false

AUTO_EVICT_COLLECTION_CACHE

static final String AUTO_EVICT_COLLECTION_CACHE

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

See Also:

• SessionFactoryBuilder.applyAutomaticEvictionOfCollectionCaches(boolean)
• Constant Field Values

Default Value:

false

USE_DIRECT_REFERENCE_CACHE_ENTRIES

static final String USE_DIRECT_REFERENCE_CACHE_ENTRIES

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:

• SessionFactoryBuilder.applyDirectReferenceCaching(boolean)
• Constant Field Values

Default Value:

false

CACHE_KEYS_FACTORY

@Deprecated
static final String CACHE_KEYS_FACTORY

Deprecated.

this is only honored for hibernate-infinispan

Specifies the CacheKeysFactory to use, either:

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

Since:

5.2

See Also:

• Constant Field Values

CLASS_CACHE_PREFIX

static final String CLASS_CACHE_PREFIX

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

See Also:

• Constant Field Values

COLLECTION_CACHE_PREFIX

static final String COLLECTION_CACHE_PREFIX

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

See Also:

• Constant Field Values

JPA_SHARED_CACHE_MODE

@Deprecated
static final String JPA_SHARED_CACHE_MODE

Deprecated.

Use JAKARTA_SHARED_CACHE_MODE instead

See Also:

• SharedCacheMode
• Constant Field Values

JPA_SHARED_CACHE_RETRIEVE_MODE

@Deprecated
static final String JPA_SHARED_CACHE_RETRIEVE_MODE

Deprecated.

Use JAKARTA_SHARED_CACHE_RETRIEVE_MODE instead

See Also:

• Constant Field Values

JPA_SHARED_CACHE_STORE_MODE

@Deprecated
static final String JPA_SHARED_CACHE_STORE_MODE

Deprecated.

Use JAKARTA_SHARED_CACHE_STORE_MODE instead

See Also:

• Constant Field Values