HHH-19336 - Proper implementation for JPA extended locking scope

HHH-19459 - LockScope, FollowOnLocking
HHH-19501 - Session#lock w/ pessimistic locks for scopes
HHH-19502 - Disallow SKIP_LOCKED with Session#lock
HHH-19503 - Track a Dialect's level of support for locking joined tables

Author: sebersole

gradle.properties

@@ -1,4 +1,4 @@
-db=h2
+db=db2_ci
 
 # Keep all these properties in sync unless you know what you are doing!
 # We set '-Dlog4j2.disableJmx=true' to prevent classloader leaks triggered by the logger.

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

@@ -18,6 +18,7 @@
 import org.hibernate.dialect.TimeZoneSupport;
 import org.hibernate.dialect.function.CommonFunctionFactory;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
+import org.hibernate.dialect.lock.spi.OuterJoinLockingLevel;
 import org.hibernate.dialect.pagination.LimitHandler;
 import org.hibernate.dialect.sequence.ANSISequenceSupport;
 import org.hibernate.dialect.sequence.SequenceSupport;
@@ -420,6 +421,11 @@ public LockingClauseStrategy getLockingClauseStrategy(QuerySpec querySpec, LockO
 		return NON_CLAUSE_STRATEGY;
 	}
 
+	@Override
+	public OuterJoinLockingLevel getOuterJoinLockingLevel() {
+		return OuterJoinLockingLevel.UNSUPPORTED;
+	}
+
 	/**
 	 * {@code FOR UPDATE} only supported for cursors
 	 *

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

@@ -14,6 +14,7 @@
 import org.hibernate.dialect.identity.AbstractTransactSQLIdentityColumnSupport;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
 import org.hibernate.dialect.lock.PessimisticLockStyle;
+import org.hibernate.dialect.lock.spi.OuterJoinLockingLevel;
 import org.hibernate.dialect.temptable.TemporaryTable;
 import org.hibernate.dialect.temptable.TemporaryTableKind;
 import org.hibernate.engine.jdbc.dialect.spi.DialectResolutionInfo;
@@ -204,6 +205,11 @@ public PessimisticLockStyle getPessimisticLockStyle() {
 		return PessimisticLockStyle.TABLE_HINT;
 	}
 
+	@Override
+	public OuterJoinLockingLevel getOuterJoinLockingLevel() {
+		return OuterJoinLockingLevel.IDENTIFIED;
+	}
+
 	@Override
 	public LockingClauseStrategy getLockingClauseStrategy(QuerySpec querySpec, LockOptions lockOptions) {
 		// T-SQL uses table-based lock hints and thus does not support FOR UPDATE clause

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

@@ -20,7 +20,6 @@
 import org.hibernate.dialect.function.TrimFunction;
 import org.hibernate.dialect.identity.DB2IdentityColumnSupport;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
-import org.hibernate.dialect.lock.spi.OuterJoinLockingLevel;
 import org.hibernate.dialect.pagination.DB2LimitHandler;
 import org.hibernate.dialect.pagination.LegacyDB2LimitHandler;
 import org.hibernate.dialect.pagination.LimitHandler;
@@ -892,11 +891,6 @@ public String getReadLockString(int timeout) {
 				: FOR_SHARE_SQL;
 	}
 
-	@Override
-	public OuterJoinLockingLevel getOuterJoinLockingLevel() {
-		return OuterJoinLockingLevel.UNSUPPORTED;
-	}
-
 	@Override
 	public boolean supportsExistsInSelect() {
 		return false;

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

@@ -21,6 +21,7 @@
 import org.hibernate.dialect.function.IntegralTimestampaddFunction;
 import org.hibernate.dialect.identity.HANAIdentityColumnSupport;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
+import org.hibernate.dialect.lock.spi.OuterJoinLockingLevel;
 import org.hibernate.dialect.pagination.LimitHandler;
 import org.hibernate.dialect.pagination.LimitOffsetLimitHandler;
 import org.hibernate.dialect.sequence.HANASequenceSupport;
@@ -653,6 +654,11 @@ public RowLockStrategy getWriteRowLockStrategy() {
 		return RowLockStrategy.COLUMN;
 	}
 
+	@Override
+	public OuterJoinLockingLevel getOuterJoinLockingLevel() {
+		return OuterJoinLockingLevel.IDENTIFIED;
+	}
+
 	@Override
 	public String getCreateTableString() {
 		return isDefaultTableTypeColumn() ? "create column table" : "create row table";

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

@@ -19,6 +19,7 @@
 import org.hibernate.dialect.function.CommonFunctionFactory;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
 import org.hibernate.dialect.identity.MySQLIdentityColumnSupport;
+import org.hibernate.dialect.lock.spi.OuterJoinLockingLevel;
 import org.hibernate.dialect.pagination.LimitHandler;
 import org.hibernate.dialect.pagination.LimitLimitHandler;
 import org.hibernate.dialect.sequence.NoSequenceSupport;
@@ -1581,6 +1582,11 @@ public RowLockStrategy getWriteRowLockStrategy() {
 		return supportsAliasLocks() ? RowLockStrategy.TABLE : RowLockStrategy.NONE;
 	}
 
+	@Override
+	public OuterJoinLockingLevel getOuterJoinLockingLevel() {
+		return supportsAliasLocks() ? OuterJoinLockingLevel.IDENTIFIED : OuterJoinLockingLevel.FULL;
+	}
+
 	@Override
 	protected void registerDefaultKeywords() {
 		super.registerDefaultKeywords();

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

@@ -19,6 +19,7 @@
 import org.hibernate.dialect.function.OracleTruncFunction;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
 import org.hibernate.dialect.identity.Oracle12cIdentityColumnSupport;
+import org.hibernate.dialect.lock.spi.OuterJoinLockingLevel;
 import org.hibernate.dialect.pagination.LimitHandler;
 import org.hibernate.dialect.pagination.Oracle12LimitHandler;
 import org.hibernate.dialect.sequence.OracleSequenceSupport;
@@ -1436,6 +1437,11 @@ public boolean supportsSkipLocked() {
 		return true;
 	}
 
+	@Override
+	public OuterJoinLockingLevel getOuterJoinLockingLevel() {
+		return OuterJoinLockingLevel.IDENTIFIED;
+	}
+
 	@Override
 	public RowLockStrategy getWriteRowLockStrategy() {
 		return RowLockStrategy.COLUMN;

hibernate-core/src/main/java/org/hibernate/dialect/lock/spi/OuterJoinLockingLevel.java

@@ -40,5 +40,15 @@ public enum OuterJoinLockingLevel {
 	 * Applying locks to joins is fully supported, acquiring locks
 	 * on all tables.
 	 */
-	FULL
+	FULL,
+
+	/**
+	 * The joined rows to lock can be controlled per table reference,
+	 * generally via one of:<ul>
+	 *     <li>{@linkplain org.hibernate.dialect.RowLockStrategy#TABLE}
+	 *     <li>{@linkplain org.hibernate.dialect.RowLockStrategy#COLUMN}
+	 *     <li>{@linkplain org.hibernate.dialect.lock.PessimisticLockStyle#TABLE_HINT}
+	 * </ul>
+	 */
+	IDENTIFIED
 }

hibernate-core/src/test/java/org/hibernate/orm/test/locking/options/ScopeTests.java

@@ -13,7 +13,6 @@
 import org.hibernate.dialect.Dialect;
 import org.hibernate.dialect.H2Dialect;
 import org.hibernate.dialect.HSQLDialect;
-import org.hibernate.dialect.RowLockStrategy;
 import org.hibernate.dialect.lock.PessimisticLockStyle;
 import org.hibernate.dialect.lock.spi.OuterJoinLockingLevel;
 import org.hibernate.testing.jdbc.SQLStatementInspector;
@@ -263,18 +262,7 @@ private boolean willAggressivelyLockJoinedTables(Dialect dialect) {
 		//
 		// todo : this is something we should consider and disallow the situation
 
-		final OuterJoinLockingLevel outerJoinLockingLevel = dialect.getOuterJoinLockingLevel();
-		if ( outerJoinLockingLevel == OuterJoinLockingLevel.FULL ) {
-			// there will be a join with some form of locking
-			final PessimisticLockStyle pessimisticLockStyle = dialect.getPessimisticLockStyle();
-			if ( pessimisticLockStyle == PessimisticLockStyle.CLAUSE ) {
-				final RowLockStrategy rowLockStrategy = dialect.getWriteRowLockStrategy();
-				if ( rowLockStrategy == RowLockStrategy.NONE ) {
-					return true;
-				}
-			}
-		}
-		return false;
+		return dialect.getOuterJoinLockingLevel() == OuterJoinLockingLevel.FULL;
 	}
 
 	@Test