HHH-19336 - Proper implementation for JPA extended locking scope

HHH-19459 - LockScope, FollowOnLocking

Author: sebersole

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/CacheDialect.java

@@ -10,6 +10,7 @@
 import java.sql.Types;
 
 import org.hibernate.LockMode;
+import org.hibernate.LockOptions;
 import org.hibernate.boot.model.FunctionContributions;
 import org.hibernate.cfg.Environment;
 import org.hibernate.community.dialect.identity.CacheIdentityColumnSupport;
@@ -43,9 +44,12 @@
 import org.hibernate.query.common.TemporalUnit;
 import org.hibernate.sql.ast.SqlAstTranslator;
 import org.hibernate.sql.ast.SqlAstTranslatorFactory;
+import org.hibernate.sql.ast.internal.NoOpForUpdateClauseStrategy;
+import org.hibernate.sql.ast.spi.ForUpdateClauseStrategy;
 import org.hibernate.sql.ast.spi.SqlAppender;
 import org.hibernate.sql.ast.spi.StandardSqlAstTranslatorFactory;
 import org.hibernate.sql.ast.tree.Statement;
+import org.hibernate.sql.ast.tree.select.QuerySpec;
 import org.hibernate.sql.exec.spi.JdbcOperation;
 import org.hibernate.type.StandardBasicTypes;
 import org.hibernate.type.descriptor.jdbc.JdbcType;
@@ -309,6 +313,11 @@ public String getQuerySequencesString() {
 
 	// lock acquisition support ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+	@Override
+	public ForUpdateClauseStrategy getForUpdateClauseStrategy(QuerySpec querySpec, LockOptions lockOptions) {
+		return NoOpForUpdateClauseStrategy.NO_OP_STRATEGY;
+	}
+
 	@Override
 	public boolean supportsOuterJoinForUpdate() {
 		return false;

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/CacheSqlAstTranslator.java

@@ -6,6 +6,7 @@
 
 import java.util.List;
 
+import org.hibernate.Locking;
 import org.hibernate.engine.spi.SessionFactoryImplementor;
 import org.hibernate.query.sqm.ComparisonOperator;
 import org.hibernate.sql.ast.spi.AbstractSqlAstTranslator;
@@ -34,16 +35,10 @@ public CacheSqlAstTranslator(SessionFactoryImplementor sessionFactory, Statement
 	@Override
 	protected LockStrategy determineLockingStrategy(
 			QuerySpec querySpec,
-			ForUpdateClause forUpdateClause,
-			Boolean followOnLocking) {
+			Locking.FollowOn followOnLocking) {
 		return LockStrategy.NONE;
 	}
 
-	@Override
-	protected void renderForUpdateClause(QuerySpec querySpec, ForUpdateClause forUpdateClause) {
-		// Cache does not support the FOR UPDATE clause
-	}
-
 	@Override
 	protected boolean needsRowsToSkip() {
 		return true;

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/CockroachLegacyDialect.java

@@ -92,7 +92,6 @@
 import java.time.temporal.TemporalAccessor;
 import java.util.Calendar;
 import java.util.Date;
-import java.util.Map;
 import java.util.TimeZone;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -994,25 +993,10 @@ public String getForUpdateString(String aliases, LockOptions lockOptions) {
 		if ( getVersion().isBefore( 20, 1 ) ) {
 			return "";
 		}
-		/*
-		 * Parent's implementation for (aliases, lockOptions) ignores aliases.
-		 */
-		if ( aliases.isEmpty() ) {
-			LockMode lockMode = lockOptions.getLockMode();
-			for ( Map.Entry<String, LockMode> entry : lockOptions.getAliasSpecificLocks() ) {
-				// seek the highest lock mode
-				if ( entry.getValue().greaterThan(lockMode) ) {
-					aliases = entry.getKey();
-				}
-			}
-		}
-		LockMode lockMode = lockOptions.getAliasSpecificLockMode( aliases );
-		if (lockMode == null ) {
-			lockMode = lockOptions.getLockMode();
-		}
+		final LockMode lockMode = lockOptions.getLockMode();
 		return switch ( lockMode ) {
-			case PESSIMISTIC_READ -> getReadLockString( aliases, lockOptions.getTimeOut() );
-			case PESSIMISTIC_WRITE -> getWriteLockString( aliases, lockOptions.getTimeOut() );
+			case PESSIMISTIC_READ -> getReadLockString( aliases, lockOptions.getTimeout() );
+			case PESSIMISTIC_WRITE -> getWriteLockString( aliases, lockOptions.getTimeout() );
 			case UPGRADE_NOWAIT, PESSIMISTIC_FORCE_INCREMENT -> getForUpdateNowaitString( aliases );
 			case UPGRADE_SKIPLOCKED -> getForUpdateSkipLockedString( aliases );
 			default -> "";

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/CockroachLegacySqlAstTranslator.java

@@ -4,6 +4,7 @@
  */
 package org.hibernate.community.dialect;
 
+import org.hibernate.Locking;
 import org.hibernate.engine.spi.SessionFactoryImplementor;
 import org.hibernate.sql.ast.Clause;
 import org.hibernate.sql.ast.spi.AbstractSqlAstTranslator;
@@ -129,35 +130,15 @@ protected void renderMaterializationHint(CteMaterialization materialization) {
 		}
 	}
 
-	@Override
-	protected String getForShare(int timeoutMillis) {
-		return " for share";
-	}
-
-	@Override
-	protected String getForUpdate() {
-		return getDialect().getVersion().isBefore( 20, 1 ) ? "" : " for update";
-	}
-
 	@Override
 	protected LockStrategy determineLockingStrategy(
 			QuerySpec querySpec,
-			ForUpdateClause forUpdateClause,
-			Boolean followOnLocking) {
+			Locking.FollowOn followOnLocking) {
 		// Support was added in 20.1: https://www.cockroachlabs.com/docs/v20.1/select-for-update.html
 		if ( getDialect().getVersion().isBefore( 20, 1 ) ) {
 			return LockStrategy.NONE;
 		}
-		return super.determineLockingStrategy( querySpec, forUpdateClause, followOnLocking );
-	}
-
-	@Override
-	protected void renderForUpdateClause(QuerySpec querySpec, ForUpdateClause forUpdateClause) {
-		// Support was added in 20.1: https://www.cockroachlabs.com/docs/v20.1/select-for-update.html
-		if ( getDialect().getVersion().isBefore( 20, 1 ) ) {
-			return;
-		}
-		super.renderForUpdateClause( querySpec, forUpdateClause );
+		return super.determineLockingStrategy( querySpec, followOnLocking );
 	}
 
 	protected boolean shouldEmulateFetchClause(QueryPart queryPart) {

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DB2LegacySqlAstTranslator.java

@@ -212,21 +212,6 @@ protected void visitAnsiCaseSimpleExpression(
 		}
 	}
 
-	@Override
-	protected String getForUpdate() {
-		return " for read only with rs use and keep update locks";
-	}
-
-	@Override
-	protected String getForShare(int timeoutMillis) {
-		return " for read only with rs use and keep share locks";
-	}
-
-	@Override
-	protected String getSkipLocked() {
-		return " skip locked data";
-	}
-
 	protected boolean shouldEmulateFetchClause(QueryPart queryPart) {
 		// Check if current query part is already row numbering to avoid infinite recursion
 		if ( getQueryPartForRowNumbering() == queryPart ) {

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DerbyDialect.java

@@ -10,6 +10,7 @@
 import java.util.Locale;
 
 import jakarta.persistence.Timeout;
+import org.hibernate.LockOptions;
 import org.hibernate.boot.model.FunctionContributions;
 import org.hibernate.boot.model.TypeContributions;
 import org.hibernate.dialect.DB2Dialect;
@@ -62,9 +63,11 @@
 import org.hibernate.sql.ast.SqlAstNodeRenderingMode;
 import org.hibernate.sql.ast.SqlAstTranslator;
 import org.hibernate.sql.ast.SqlAstTranslatorFactory;
+import org.hibernate.sql.ast.spi.ForUpdateClauseStrategy;
 import org.hibernate.sql.ast.spi.SqlAppender;
 import org.hibernate.sql.ast.spi.StandardSqlAstTranslatorFactory;
 import org.hibernate.sql.ast.tree.Statement;
+import org.hibernate.sql.ast.tree.select.QuerySpec;
 import org.hibernate.sql.exec.spi.JdbcOperation;
 import org.hibernate.community.dialect.sequence.SequenceInformationExtractorDerbyDatabaseImpl;
 import org.hibernate.tool.schema.extract.spi.SequenceInformationExtractor;
@@ -568,6 +571,11 @@ public boolean supportsCommentOn() {
 		return false;
 	}
 
+	@Override
+	public ForUpdateClauseStrategy getForUpdateClauseStrategy(QuerySpec querySpec, LockOptions lockOptions) {
+		return DerbyForUpdateStrategy.strategy( this, querySpec, lockOptions );
+	}
+
 	@Override
 	public RowLockStrategy getReadRowLockStrategy() {
 		return RowLockStrategy.NONE;

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DerbyForUpdateStrategy.java

@@ -0,0 +1,54 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.community.dialect;
+
+import org.hibernate.LockMode;
+import org.hibernate.LockOptions;
+import org.hibernate.Locking;
+import org.hibernate.dialect.Dialect;
+import org.hibernate.dialect.RowLockStrategy;
+import org.hibernate.sql.ast.internal.PessimisticLockKind;
+import org.hibernate.sql.ast.internal.StandardForUpdateClauseStrategy;
+import org.hibernate.sql.ast.spi.SqlAppender;
+import org.hibernate.sql.ast.tree.select.QuerySpec;
+
+/**
+ * @author Steve Ebersole
+ */
+public class DerbyForUpdateStrategy extends StandardForUpdateClauseStrategy {
+	public DerbyForUpdateStrategy(
+			Dialect dialect,
+			RowLockStrategy rowLockStrategy,
+			LockMode lockMode,
+			PessimisticLockKind lockKind,
+			Locking.Scope lockingScope,
+			int timeout) {
+		super( dialect, rowLockStrategy, lockMode, lockKind, lockingScope, timeout );
+	}
+
+	@Override
+	protected void renderResultSetOptions(Dialect dialect, SqlAppender sqlAppender) {
+		sqlAppender.append( " with rs" );
+	}
+
+	public static DerbyForUpdateStrategy strategy(
+			Dialect dialect,
+			QuerySpec querySpec,
+			LockOptions lockOptions) {
+		return (DerbyForUpdateStrategy) StandardForUpdateClauseStrategy.strategy(
+				dialect,
+				querySpec,
+				lockOptions,
+				(dialect1, rowLockStrategy, lockMode, lockKind, lockScope, timeout) -> new StandardForUpdateClauseStrategy(
+						dialect,
+						rowLockStrategy,
+						lockMode,
+						lockKind,
+						lockScope,
+						timeout
+				)
+		);
+	}
+}

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DerbyLegacyDialect.java

@@ -9,6 +9,7 @@
 import java.sql.Types;
 
 import jakarta.persistence.Timeout;
+import org.hibernate.LockOptions;
 import org.hibernate.boot.model.FunctionContributions;
 import org.hibernate.boot.model.TypeContributions;
 import org.hibernate.dialect.DB2Dialect;
@@ -60,9 +61,11 @@
 import org.hibernate.sql.ast.SqlAstNodeRenderingMode;
 import org.hibernate.sql.ast.SqlAstTranslator;
 import org.hibernate.sql.ast.SqlAstTranslatorFactory;
+import org.hibernate.sql.ast.spi.ForUpdateClauseStrategy;
 import org.hibernate.sql.ast.spi.SqlAppender;
 import org.hibernate.sql.ast.spi.StandardSqlAstTranslatorFactory;
 import org.hibernate.sql.ast.tree.Statement;
+import org.hibernate.sql.ast.tree.select.QuerySpec;
 import org.hibernate.sql.exec.spi.JdbcOperation;
 import org.hibernate.community.dialect.sequence.SequenceInformationExtractorDerbyDatabaseImpl;
 import org.hibernate.tool.schema.extract.internal.SequenceInformationExtractorNoOpImpl;
@@ -579,6 +582,11 @@ public boolean supportsCommentOn() {
 		return false;
 	}
 
+	@Override
+	public ForUpdateClauseStrategy getForUpdateClauseStrategy(QuerySpec querySpec, LockOptions lockOptions) {
+		return DerbyForUpdateStrategy.strategy( this, querySpec, lockOptions );
+	}
+
 	@Override
 	public RowLockStrategy getWriteRowLockStrategy() {
 		return RowLockStrategy.NONE;

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DerbyLegacySqlAstTranslator.java

@@ -174,21 +174,6 @@ protected void visitAnsiCaseSimpleExpression(
 		}
 	}
 
-	@Override
-	protected String getForUpdate() {
-		return " for update";
-	}
-
-	@Override
-	protected String getForShare(int timeoutMillis) {
-		return " for read only";
-	}
-
-	@Override
-	protected String getForUpdateWithClause() {
-		return " with rs";
-	}
-
 	@Override
 	public void visitOffsetFetchClause(QueryPart queryPart) {
 		// Derby only supports the OFFSET and FETCH clause with ROWS

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DerbySqlAstTranslator.java

@@ -174,16 +174,6 @@ protected void visitAnsiCaseSimpleExpression(
 		}
 	}
 
-	@Override
-	protected String getForShare(int timeoutMillis) {
-		return " for read only";
-	}
-
-	@Override
-	protected String getForUpdateWithClause() {
-		return " with rs";
-	}
-
 	@Override
 	public void visitOffsetFetchClause(QueryPart queryPart) {
 		// Derby only supports the OFFSET and FETCH clause with ROWS