Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HHH-19208 Adapt javadoc of QuerySettings.QUERY_PLAN_CACHE_ENABLED #9813

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+4 −3
Open

HHH-19208 Adapt javadoc of QuerySettings.QUERY_PLAN_CACHE_ENABLED #9813

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f08ce85
HHH-19208 Adapt javadoc of QuerySettings.QUERY_PLAN_CACHE_ENABLED
domids Feb 27, 2025
cb23f84
HHH-19208 Add `@settingDefault`
domids Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions hibernate-core/src/main/java/org/hibernate/cfg/QuerySettings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,9 +252,10 @@ public interface QuerySettings {
* When enabled, specifies that {@linkplain QueryPlan query plans} should be
* {@linkplain org.hibernate.query.spi.QueryInterpretationCache cached}.
* <p>
* By default, the query plan cache is disabled, unless one of the configuration
* properties {@value #QUERY_PLAN_CACHE_MAX_SIZE} or
* {@value #QUERY_PLAN_CACHE_PARAMETER_METADATA_MAX_SIZE} is set.
* By default, the query plan cache is enabled. It is also enabled if the configuration
* property {@value #QUERY_PLAN_CACHE_MAX_SIZE} is set.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also add a @settingDefault.

Copy link
Author

@domids domids Feb 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Has been added. Is the description ok or should I just add @settingDefault {@code true} (enabled)
I copied it from https://github.com/domids/hibernate-orm/blob/cb23f84ffbc701e5b91eadb6863f2e9fc7bb586a/hibernate-core/src/main/java/org/hibernate/cfg/QuerySettings.java#L79-L79 but IMHO here it's superfluous?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks.

I don't think it's superfluous, we use that to generate documentation.

*
* @settingDefault {@code true} (enabled) - query plan cache is enabled.
*/
String QUERY_PLAN_CACHE_ENABLED = "hibernate.query.plan_cache_enabled";

Expand Down