Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document `hibernate.cache.keys_factory`

This commit is contained in:
Radim Vansa 2016-11-22 12:59:40 +01:00 committed by Gail Badner
parent 7daab773ce
commit 789724f4e4
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
documentation/src/main/asciidoc/userguide/chapters/caching/Caching.adoc
View File

@ -64,6 +64,16 @@ Besides specific provider configuration, there are a number of configurations op
the alternative is to have stale data in that collection cache.
`hibernate.cache.use_reference_entries`::
Enable direct storage of entity references into the second level cache for read-only or immutable entities.
`hibernate.cache.keys_factory`::
When storing entries into second-level cache as key-value pair, the identifiers can be wrapped into tuples
<entity type, tenant, identifier> to guarantee uniqueness in case that second-level cache stores all entities
in single space. These tuples are then used as keys in the cache. When the second-level cache implementation
(incl. its configuration) guarantees that different entity types are stored separately and multi-tenancy is not
used, you can omit this wrapping to achieve better performance. This hint can be ignored by the second-level
cache implementation, though. Valid values are:
* `default` (wraps identitifers in the tuple)
* `simple` (uses identifiers as keys without any wrapping)
* fully qualified class name that implements `org.hibernate.cache.spi.CacheKeysFactory`
[[caching-mappings]]
=== Configuring second-level cache mappings

2
hibernate-core/src/main/java/org/hibernate/cfg/AvailableSettings.java
View File

@ -700,6 +700,8 @@ public interface AvailableSettings {
* <li>an Object implementing {@link org.hibernate.cache.spi.CacheKeysFactory}</li>
* <li>a Class implementing {@link org.hibernate.cache.spi.CacheKeysFactory}</li>
* <li>FQN of a Class implementing {@link org.hibernate.cache.spi.CacheKeysFactory}</li>
* <li>'default' as a short name for {@link org.hibernate.cache.internal.DefaultCacheKeysFactory}</li>
* <li>'simple' as a short name for {@link org.hibernate.cache.internal.SimpleCacheKeysFactory}</li>
* </ul>
*
* @since 5.0.10, 5.1.1 - note that currently this is only honored for hibernate-infinispan