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.

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

Conversation

domids
Copy link

@domids domids commented Feb 27, 2025

Adapts the javadoc of QuerySettings.QUERY_PLAN_CACHE_ENABLED as it doesn't reflect how it is used in org.hibernate.query.internal.QueryEngineImpl.buildInterpretationCache.

https://hibernate.atlassian.net/jira/software/c/projects/HHH/boards/31?selectedIssue=HHH-19208


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license
and can be relicensed under the terms of the LGPL v2.1 license in the future at the maintainers' discretion.
For more information on licensing, please check here.


* 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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants