HHH-19208 Adapt javadoc of QuerySettings.QUERY_PLAN_CACHE_ENABLED #9813
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gavinking
reviewed
Feb 27, 2025
| * 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. |
There was a problem hiding this comment.
Please also add a @settingDefault.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
LGTM, thanks.
I don't think it's superfluous, we use that to generate documentation.
|
Thanks for your pull request! This pull request appears to follow the contribution rules. › This message was automatically generated. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adapts the javadoc of
QuerySettings.QUERY_PLAN_CACHE_ENABLEDas it doesn't reflect how it is used inorg.hibernate.query.internal.QueryEngineImpl.buildInterpretationCache.https://hibernate.atlassian.net/browse/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.