Clarify the @Lock on String-based queries #2008
Closed
Conversation
This file contains hidden or 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
Signed-off-by: mipo256 <[email protected]>
mipo256
force-pushed
the
DATAJDBC-Locking
branch
from
9be3228 to
3d99565
Compare
spring-projects-issues
added
the
status: waiting-for-triage
mp911de
added
type: documentation
schauder
pushed a commit
that referenced
this pull request
Mar 10, 2025
Original pull request #2008 Signed-off-by: mipo256 <[email protected]> Commit message edited.
schauder
added a commit
that referenced
this pull request
Mar 10, 2025
Refining documentation. Original pull request #2008
|
Thanks. That's merged. And I agree on the error message. Do you want to prepare a PR for the 4.0.x branch? |
|
@schauder eah, sure. So we want to throw an exception since version 4.0.x, am I correct? If so, then I'll provide the corresponding PR |
|
Exactly. Thanks. |
mp911de
reviewed
Mar 10, 2025
| @@ -78,6 +80,8 @@ | |||
| public class StringBasedJdbcQuery extends AbstractJdbcQuery { | |||
|
|
|||
| private static final String PARAMETER_NEEDS_TO_BE_NAMED = "For queries with named parameters you need to provide names for method parameters; Use @Param for query method parameters, or use the javac flag -parameters"; | |||
| private final static String LOCKING_IS_NOT_SUPPORTED = "Currently, @Lock is supported only on derived queries. In other words, for queries created with @Query, the locking condition specified with @Lock does nothing"; | |||
There was a problem hiding this comment.
Would it make sense to reword the second part from a repetition to something actionable? I.e. "…include the database-specific locking hints in your query…"?
There was a problem hiding this comment.
That makes sense, I agree with you, @mp911de. I'll provide the PR with exception thrown for 4th major release shortly, and I'll apply your suggestion, what do you think?
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.
Currently, the reference documentation states, that
@Lockcan be used with derived queries. But our documentation does not mention anywhere, that we do not support@Lockon string-based queries. I want to address this issue by altering the corresponding doc + issuing the warning logP.S: @mp911de @schauder Maybe we can throw an exception? By the way, we're already actively doing so, check here.
My concern is that this will be a breaking change, although. Nevertheless, this is a fail fast approach, which is generally better. In addition, Spring Data JDBC 4 major release is coming, so, I think it is worth considering this option.