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/OracleLegacyDialect.java

@@ -1383,7 +1383,7 @@ public boolean supportsSkipLocked() {
 
 	@Override
 	public RowLockStrategy getWriteRowLockStrategy() {
-		return RowLockStrategy.COLUMN;
+		return RowLockStrategy.COLUMN_NAME;
 	}
 
 	@Override

hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java

@@ -1437,7 +1437,7 @@ public boolean supportsSkipLocked() {
 
 	@Override
 	public RowLockStrategy getWriteRowLockStrategy() {
-		return RowLockStrategy.COLUMN;
+		return RowLockStrategy.COLUMN_NAME;
 	}
 
 	@Override

hibernate-core/src/main/java/org/hibernate/dialect/RowLockStrategy.java

@@ -8,14 +8,19 @@
  * The strategy for rendering which row to lock with the {@code FOR UPDATE OF} clause.
  *
  * @author Christian Beikov
+ * @author Steve Ebersole
  */
 public enum RowLockStrategy {
 	/**
-	 * Use a column name.
+	 * Use the column reference (column name qualified by the table alias).
 	 */
 	COLUMN,
 	/**
-	 * Use a table alias.
+	 * Use the column name.
+	 */
+	COLUMN_NAME,
+	/**
+	 * Use the table alias.
 	 */
 	TABLE,
 	/**

hibernate-core/src/main/java/org/hibernate/sql/ast/internal/StandardForUpdateClauseStrategy.java

@@ -4,6 +4,7 @@
  */
 package org.hibernate.sql.ast.internal;
 
+import org.hibernate.HibernateException;
 import org.hibernate.LockMode;
 import org.hibernate.LockOptions;
 import org.hibernate.Locking;
@@ -146,7 +147,7 @@ protected void renderRowLocking(RowLockStrategy rowLockStrategy, Set<TableGroup>
 	}
 
 	protected void renderResultSetOptions(Dialect dialect, SqlAppender sqlAppender) {
-		// todo : hook for derby
+		// hook for Derby
 	}
 
 	protected void renderLockedRowHandling(int timeout, SqlAppender sqlAppender) {
@@ -175,10 +176,9 @@ private void collectLockItems(TableGroup tableGroup, List<String> lockItems) {
 		else if ( rowLockStrategy == RowLockStrategy.COLUMN ) {
 			addColumnRefs( tableGroup, lockItems );
 		}
-	}
-
-	private void addColumnRefs(TableGroup tableGroup, List<String> lockItems) {
-		Collections.addAll( lockItems, determineKeyColumnRefs( tableGroup ) );
+		else if ( rowLockStrategy == RowLockStrategy.COLUMN_NAME ) {
+			addColumnNames( tableGroup, lockItems );
+		}
 	}
 
 	private void addTableAliases(TableGroup tableGroup, List<String> lockItems) {
@@ -193,6 +193,10 @@ private void addTableAliases(TableGroup tableGroup, List<String> lockItems) {
 		}
 	}
 
+	private void addColumnRefs(TableGroup tableGroup, List<String> lockItems) {
+		Collections.addAll( lockItems, determineKeyColumnRefs( tableGroup ) );
+	}
+
 	private String[] determineKeyColumnRefs(TableGroup tableGroup) {
 		final String[] result = determineKeyColumnNames( tableGroup.getModelPart() );
 		final String tableAlias = tableGroup.getPrimaryTableReference().getIdentificationVariable();
@@ -207,6 +211,8 @@ private String[] determineKeyColumnNames(ModelPart modelPart) {
 			return entityPersister.getIdentifierColumnNames();
 		}
 		else if ( modelPart instanceof PluralAttributeMapping pluralAttributeMapping ) {
+			// todo : seems like this ought to return the column name(s)
+			//  	to then be qualified with the table alias
 			return pluralAttributeMapping.getCollectionDescriptor().getKeyColumnAliases( null );
 		}
 		else if ( modelPart instanceof EntityAssociationMapping entityAssociationMapping ) {
@@ -217,6 +223,33 @@ else if ( modelPart instanceof EntityAssociationMapping entityAssociationMapping
 		}
 	}
 
+	private void addColumnNames(TableGroup tableGroup, List<String> lockItems) {
+		final ModelPart keyColumnPart = determineKeyPart( tableGroup.getModelPart() );
+		if ( keyColumnPart == null ) {
+			throw new HibernateException( "Could not determine ModelPart defining key columns - " + tableGroup.getModelPart() );
+		}
+		keyColumnPart.forEachSelectable( (selectionIndex, selectableMapping) -> {
+			if ( !selectableMapping.isFormula() ) {
+				lockItems.add( selectableMapping.getSelectableName() );
+			}
+		} );
+	}
+
+	private ModelPart determineKeyPart(ModelPart modelPart) {
+		if ( modelPart instanceof EntityPersister entityPersister ) {
+			return entityPersister.getIdentifierMapping();
+		}
+		else if ( modelPart instanceof PluralAttributeMapping pluralAttributeMapping ) {
+			return pluralAttributeMapping.getKeyDescriptor();
+		}
+		else if ( modelPart instanceof EntityAssociationMapping entityAssociationMapping ) {
+			return entityAssociationMapping.getForeignKeyDescriptor();
+		}
+		else {
+			return null;
+		}
+	}
+
 	public static ForUpdateClauseStrategy strategy(Dialect dialect, QuerySpec querySpec, LockOptions lockOptions) {
 		return strategy(
 				dialect,

hibernate-core/src/test/java/org/hibernate/orm/test/locking/scope/Helper.java

@@ -84,6 +84,15 @@ public String getTableAlias() {
 			};
 		}
 
+		public String[] getKeyColumnNames() {
+			return switch ( this ) {
+				case BOOKS -> new String[] {"id"};
+				case BOOK_TAGS -> new String[] {"book_fk"};
+				case BOOK_AUTHORS -> new String[] {"book_fk"};
+				case PUBLISHER -> new String[] {"id"};
+			};
+		}
+
 		public String[] getKeyColumnAliases() {
 			return switch ( this ) {
 				case BOOKS -> new String[] {"b1_0.id"};
@@ -116,6 +125,20 @@ else if ( rowLockStrategy == RowLockStrategy.TABLE ) {
 				}
 				aliases = buffer.toString();
 			}
+			else if ( rowLockStrategy == RowLockStrategy.COLUMN_NAME ) {
+				final StringBuilder buffer = new StringBuilder();
+				boolean firstPass = true;
+				for ( Table table : tablesFetched ) {
+					if ( firstPass ) {
+						firstPass = false;
+					}
+					else {
+						buffer.append( "," );
+					}
+					buffer.append( StringHelper.join( ",", table.getKeyColumnNames() ) );
+				}
+				aliases = buffer.toString();
+			}
 			else {
 				final StringBuilder buffer = new StringBuilder();
 				boolean firstPass = true;