Skip to content

Documentation is confusing when it comes to the application/Hibernate caching split #42781

Open

Description

Describe the bug

Caching using Infinispan is documented in https://quarkus.io/guides/cache-infinispan-reference
That caching is limited to application caching, and not compatible with Hibernate caching... but that limitation is not mentioned anywhere. That's confusing for people coming e.g. from WildFly and expecting Hibernate caching using Infinispan.

Using Hibernate ORM and Jakarta Persistence / Automatic integration / Second Level Cache contains this:

As explained earlier in the Caching section, you don’t need to pick an implementation. A suitable implementation based on technologies from Infinispan and Caffeine is included as a transitive dependency of the Hibernate ORM extension, and automatically integrated during the build.

... but the corresponding cache doesn't use Infinispan at all, it just borrows some code from the hibernate-infinispan library 😞

See also #42541, and we've seen other confusions e.g. here.

Expected behavior

  1. Each piece of documentation should make it obvious whether it's about application (method) caching or whether it's about Hibernate (second-level) caching.
  2. The documentation of each advertised integration (Caffeine, Infinispan) should make it obvious whether application (method) caching is supported, and whether Hibernate (second-level) caching is supported.

Actual behavior

Documentation is confusing regarding what's application caching and what's Hibernate caching, and which integration is supported where.

How to Reproduce?

No response

Output of uname -a or ver

No response

Output of java -version

No response

Quarkus version or git rev

No response

Build tool (ie. output of mvnw --version or gradlew --version)

No response

Additional information

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions