Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.CacheMode

Controls how the session interacts with the second-level cache or query cache. An instance of CacheMode may be viewed as packaging a JPA-defined CacheStoreMode with a CacheRetrieveMode. For example, CacheMode#PUT represents the combination (BYPASS, USE).

However, this enumeration recognizes only five such combinations. In Hibernate, CacheStoreMode#REFRESH always implies CacheRetrieveMode#BYPASS, so there's no CacheMode representing the combination (REFRESH, USE).

Field Summary

Modifier and Type	Field and Description
public static final CacheMode	GET The session may read items from the cache, but will not add items, except to invalidate items when updates occur.
public static final CacheMode	IGNORE The session will never interact with the cache, except to invalidate cached items when updates occur.
public static final CacheMode	NORMAL The session may read items from the cache, and add items to the cache as it reads them from the database.
public static final CacheMode	PUT The session will never read items from the cache, but will add items to the cache as it reads them from the database.
public static final CacheMode	REFRESH As with to `PUT`, the session will never read items from the cache, but will add items to the cache as it reads them from the database.
private final CacheRetrieveMode	retrieveMode
private final CacheStoreMode	storeMode

Constructor Summary

Access	Constructor and Description
private	CacheMode(CacheStoreMode storeMode, CacheRetrieveMode retrieveMode)

Method Summary

Modifier and Type	Method and Description
public static CacheMode	fromJpaModes(CacheRetrieveMode retrieveMode, CacheStoreMode storeMode) Interpret the given JPA modes as an instance of this enumeration.
public CacheRetrieveMode	Returns: the JPA-defined `CacheRetrieveMode` implied by this cache mode getJpaRetrieveMode()
public CacheStoreMode	Returns: the JPA-defined `CacheStoreMode` implied by this cache mode getJpaStoreMode()
public static CacheMode	Returns: The matching enum value. interpretExternalSetting(String The externalized form. setting) Interpret externalized form as an instance of this enumeration.
public boolean	Returns: `true` if cache reads are allowed; `false` otherwise. isGetEnabled() Does this cache mode indicate that reads are allowed?
public boolean	Returns: `true` if cache writes are allowed; `false` otherwise. isPutEnabled() Does this cache mode indicate that writes are allowed?
public static CacheMode	valueOf(String name)
public static CacheMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

GET	back to summary
public static final CacheMode GET The session may read items from the cache, but will not add items, except to invalidate items when updates occur.

IGNORE	back to summary
public static final CacheMode IGNORE The session will never interact with the cache, except to invalidate cached items when updates occur.

NORMAL	back to summary
public static final CacheMode NORMAL The session may read items from the cache, and add items to the cache as it reads them from the database.

PUT back to summary

PUT	back to summary
public static final CacheMode PUT The session will never read items from the cache, but will add items to the cache as it reads them from the database. In this mode, the value of the configuration setting hibernate.cache.use_minimal_puts determines whether an item is written to the cache when the cache already contains an entry with the same key. Minimal puts should be: disabled for a cache where writes and reads carry a similar cost, as is usually the case for a local in-memory cache, and enabled for a cache where writes are much more expensive than reads, which is usually the case for a distributed cache. It's not usually necessary to specify this setting 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)`

public static final CacheMode PUT

The session will never read items from the cache, but will add items to the cache as it reads them from the database. In this mode, the value of the configuration setting hibernate.cache.use_minimal_puts determines whether an item is written to the cache when the cache already contains an entry with the same key. Minimal puts should be:

disabled for a cache where writes and reads carry a similar cost, as is usually the case for a local in-memory cache, and
enabled for a cache where writes are much more expensive than reads, which is usually the case for a distributed cache.

It's not usually necessary to specify this setting 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)

REFRESH back to summary

REFRESH	back to summary
public static final CacheMode REFRESH As with to `PUT`, the session will never read items from the cache, but will add items to the cache as it reads them from the database. But in this mode, the effect of the configuration setting hibernate.cache.use_minimal_puts is bypassed, in order to force a refresh of a cached item, even when an entry with the same key already exists in the cache. See Also `org.hibernate.boot.SessionFactoryBuilder#applyMinimalPutsForCaching(boolean)`

public static final CacheMode REFRESH

As with to PUT, the session will never read items from the cache, but will add items to the cache as it reads them from the database. But in this mode, the effect of the configuration setting hibernate.cache.use_minimal_puts is bypassed, in order to force a refresh of a cached item, even when an entry with the same key already exists in the cache.

See Also: org.hibernate.boot.SessionFactoryBuilder#applyMinimalPutsForCaching(boolean)

retrieveMode	back to summary
private final CacheRetrieveMode retrieveMode

storeMode	back to summary
private final CacheStoreMode storeMode

Constructor Detail

CacheMode	back to summary
private CacheMode(CacheStoreMode storeMode, CacheRetrieveMode retrieveMode)

Method Detail

fromJpaModes	back to summary
public static CacheMode fromJpaModes(CacheRetrieveMode retrieveMode, CacheStoreMode storeMode) Interpret the given JPA modes as an instance of this enumeration.

getJpaRetrieveMode	back to summary
public CacheRetrieveMode getJpaRetrieveMode() Returns:CacheRetrieveMode the JPA-defined `CacheRetrieveMode` implied by this cache mode

getJpaStoreMode	back to summary
public CacheStoreMode getJpaStoreMode() Returns:CacheStoreMode the JPA-defined `CacheStoreMode` implied by this cache mode

interpretExternalSetting	back to summary
public static CacheMode interpretExternalSetting(String setting) Interpret externalized form as an instance of this enumeration. Parameters setting:String The externalized form. Returns:CacheMode The matching enum value. Exceptions MappingException: Indicates the external form was not recognized as a valid enum value.

interpretExternalSetting

back to summary

public static CacheMode interpretExternalSetting(String setting)

Interpret externalized form as an instance of this enumeration.

Parameters

setting:String: The externalized form.

Returns:CacheMode

The matching enum value.

Exceptions

MappingException:: Indicates the external form was not recognized as a valid enum value.

isGetEnabled back to summary

isGetEnabled	back to summary
public boolean isGetEnabled() Does this cache mode indicate that reads are allowed? Returns:boolean `true` if cache reads are allowed; `false` otherwise.

public boolean isGetEnabled()

Does this cache mode indicate that reads are allowed?

Returns:boolean: true if cache reads are allowed; false otherwise.

isPutEnabled back to summary

isPutEnabled	back to summary
public boolean isPutEnabled() Does this cache mode indicate that writes are allowed? Returns:boolean `true` if cache writes are allowed; `false` otherwise.

public boolean isPutEnabled()

Does this cache mode indicate that writes are allowed?

Returns:boolean: true if cache writes are allowed; false otherwise.

valueOf	back to summary
public static CacheMode valueOf(String name)