HHH-19551 - Address deficiencies in pessimistic locking

Author: sebersole

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

@@ -19,7 +19,7 @@
 import org.hibernate.dialect.OracleDialect;
 import org.hibernate.dialect.function.CommonFunctionFactory;
 import org.hibernate.dialect.function.OracleTruncFunction;
-import org.hibernate.dialect.lock.internal.NoLockingSupport;
+import org.hibernate.dialect.lock.internal.LockingSupportSimple;
 import org.hibernate.dialect.lock.spi.LockingSupport;
 import org.hibernate.dialect.pagination.LimitHandler;
 import org.hibernate.dialect.sequence.SequenceSupport;
@@ -587,7 +587,7 @@ public boolean supportsFromClauseInUpdate() {
 
 	@Override
 	public LockingSupport getLockingSupport() {
-		return NoLockingSupport.NO_LOCKING_SUPPORT;
+		return LockingSupportSimple.NO_OUTER_JOIN;
 	}
 
 	@Override

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

@@ -14,6 +14,7 @@
 import org.hibernate.community.dialect.pagination.DerbyLimitHandler;
 import org.hibernate.community.dialect.sequence.DerbySequenceSupport;
 import org.hibernate.community.dialect.sequence.SequenceInformationExtractorDerbyDatabaseImpl;
+import org.hibernate.community.dialect.temptable.DerbyLocalTemporaryTableStrategy;
 import org.hibernate.dialect.DB2Dialect;
 import org.hibernate.dialect.DatabaseVersion;
 import org.hibernate.dialect.Dialect;
@@ -28,11 +29,10 @@
 import org.hibernate.dialect.function.InsertSubstringOverlayEmulation;
 import org.hibernate.dialect.identity.DB2IdentityColumnSupport;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
-import org.hibernate.dialect.lock.internal.NoLockingSupport;
+import org.hibernate.dialect.lock.internal.LockingSupportSimple;
 import org.hibernate.dialect.lock.spi.LockingSupport;
 import org.hibernate.dialect.pagination.LimitHandler;
 import org.hibernate.dialect.sequence.SequenceSupport;
-import org.hibernate.community.dialect.temptable.DerbyLocalTemporaryTableStrategy;
 import org.hibernate.dialect.temptable.TemporaryTableKind;
 import org.hibernate.dialect.temptable.TemporaryTableStrategy;
 import org.hibernate.dialect.unique.CreateTableUniqueDelegate;
@@ -53,9 +53,9 @@
 import org.hibernate.query.common.TemporalUnit;
 import org.hibernate.query.sqm.CastType;
 import org.hibernate.query.sqm.IntervalType;
-import org.hibernate.query.sqm.mutation.spi.BeforeUseAction;
 import org.hibernate.query.sqm.mutation.internal.temptable.LocalTemporaryTableInsertStrategy;
 import org.hibernate.query.sqm.mutation.internal.temptable.LocalTemporaryTableMutationStrategy;
+import org.hibernate.query.sqm.mutation.spi.BeforeUseAction;
 import org.hibernate.query.sqm.mutation.spi.SqmMultiTableInsertStrategy;
 import org.hibernate.query.sqm.mutation.spi.SqmMultiTableMutationStrategy;
 import org.hibernate.service.ServiceRegistry;
@@ -577,7 +577,7 @@ public boolean supportsCommentOn() {
 
 	@Override
 	public LockingSupport getLockingSupport() {
-		return NoLockingSupport.NO_LOCKING_SUPPORT;
+		return LockingSupportSimple.NO_OUTER_JOIN;
 	}
 
 	@Override

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

@@ -14,6 +14,7 @@
 import org.hibernate.community.dialect.pagination.DerbyLimitHandler;
 import org.hibernate.community.dialect.sequence.DerbySequenceSupport;
 import org.hibernate.community.dialect.sequence.SequenceInformationExtractorDerbyDatabaseImpl;
+import org.hibernate.community.dialect.temptable.DerbyLocalTemporaryTableStrategy;
 import org.hibernate.dialect.DB2Dialect;
 import org.hibernate.dialect.DatabaseVersion;
 import org.hibernate.dialect.Dialect;
@@ -28,12 +29,11 @@
 import org.hibernate.dialect.function.InsertSubstringOverlayEmulation;
 import org.hibernate.dialect.identity.DB2IdentityColumnSupport;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
-import org.hibernate.dialect.lock.internal.NoLockingSupport;
+import org.hibernate.dialect.lock.internal.LockingSupportSimple;
 import org.hibernate.dialect.lock.spi.LockingSupport;
 import org.hibernate.dialect.pagination.AbstractLimitHandler;
 import org.hibernate.dialect.pagination.LimitHandler;
 import org.hibernate.dialect.sequence.SequenceSupport;
-import org.hibernate.community.dialect.temptable.DerbyLocalTemporaryTableStrategy;
 import org.hibernate.dialect.temptable.TemporaryTableKind;
 import org.hibernate.dialect.temptable.TemporaryTableStrategy;
 import org.hibernate.engine.jdbc.Size;
@@ -52,9 +52,9 @@
 import org.hibernate.query.common.TemporalUnit;
 import org.hibernate.query.sqm.CastType;
 import org.hibernate.query.sqm.IntervalType;
-import org.hibernate.query.sqm.mutation.spi.BeforeUseAction;
 import org.hibernate.query.sqm.mutation.internal.temptable.LocalTemporaryTableInsertStrategy;
 import org.hibernate.query.sqm.mutation.internal.temptable.LocalTemporaryTableMutationStrategy;
+import org.hibernate.query.sqm.mutation.spi.BeforeUseAction;
 import org.hibernate.query.sqm.mutation.spi.SqmMultiTableInsertStrategy;
 import org.hibernate.query.sqm.mutation.spi.SqmMultiTableMutationStrategy;
 import org.hibernate.service.ServiceRegistry;
@@ -618,7 +618,7 @@ public String getReadLockString(int timeout) {
 
 	@Override
 	public LockingSupport getLockingSupport() {
-		return NoLockingSupport.NO_LOCKING_SUPPORT;
+		return LockingSupportSimple.NO_OUTER_JOIN;
 	}
 
 	@Override

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

@@ -4,23 +4,7 @@
  */
 package org.hibernate.community.dialect;
 
-import java.sql.DatabaseMetaData;
-import java.sql.SQLException;
-import java.sql.Types;
-import java.time.Instant;
-import java.time.format.DateTimeFormatter;
-import java.time.format.DateTimeFormatterBuilder;
-import java.time.temporal.ChronoField;
-import java.time.temporal.TemporalAccessor;
-import java.util.Arrays;
-import java.util.Calendar;
-import java.util.Date;
-import java.util.Locale;
-import java.util.TimeZone;
-import java.util.UUID;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
+import jakarta.persistence.TemporalType;
 import org.hibernate.boot.Metadata;
 import org.hibernate.boot.model.FunctionContributions;
 import org.hibernate.boot.model.TypeContributions;
@@ -35,11 +19,12 @@
 import org.hibernate.dialect.Dialect;
 import org.hibernate.dialect.DmlTargetColumnQualifierSupport;
 import org.hibernate.dialect.NationalizationSupport;
+import org.hibernate.dialect.NullOrdering;
 import org.hibernate.dialect.TimeZoneSupport;
 import org.hibernate.dialect.function.CommonFunctionFactory;
 import org.hibernate.dialect.function.HypotheticalSetWindowEmulation;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
-import org.hibernate.dialect.lock.internal.NoLockingSupport;
+import org.hibernate.dialect.lock.internal.LockingSupportSimple;
 import org.hibernate.dialect.lock.spi.LockingSupport;
 import org.hibernate.dialect.pagination.LimitHandler;
 import org.hibernate.dialect.pagination.OffsetFetchLimitHandler;
@@ -61,11 +46,10 @@
 import org.hibernate.mapping.Index;
 import org.hibernate.metamodel.mapping.EntityMappingType;
 import org.hibernate.metamodel.spi.RuntimeModelCreationContext;
-import org.hibernate.query.sqm.CastType;
 import org.hibernate.query.common.FetchClauseType;
-import org.hibernate.query.sqm.IntervalType;
-import org.hibernate.dialect.NullOrdering;
 import org.hibernate.query.common.TemporalUnit;
+import org.hibernate.query.sqm.CastType;
+import org.hibernate.query.sqm.IntervalType;
 import org.hibernate.query.sqm.function.SqmFunctionRegistry;
 import org.hibernate.query.sqm.mutation.internal.temptable.GlobalTemporaryTableInsertStrategy;
 import org.hibernate.query.sqm.mutation.internal.temptable.GlobalTemporaryTableMutationStrategy;
@@ -91,10 +75,25 @@
 import org.hibernate.type.descriptor.jdbc.spi.JdbcTypeRegistry;
 import org.hibernate.type.descriptor.sql.internal.BinaryFloatDdlType;
 import org.hibernate.type.descriptor.sql.spi.DdlTypeRegistry;
-
-import jakarta.persistence.TemporalType;
 import org.hibernate.type.spi.TypeConfiguration;
 
+import java.sql.DatabaseMetaData;
+import java.sql.SQLException;
+import java.sql.Types;
+import java.time.Instant;
+import java.time.format.DateTimeFormatter;
+import java.time.format.DateTimeFormatterBuilder;
+import java.time.temporal.ChronoField;
+import java.time.temporal.TemporalAccessor;
+import java.util.Arrays;
+import java.util.Calendar;
+import java.util.Date;
+import java.util.Locale;
+import java.util.TimeZone;
+import java.util.UUID;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
 import static org.hibernate.query.sqm.produce.function.FunctionParameterType.INTEGER;
 import static org.hibernate.query.sqm.produce.function.FunctionParameterType.STRING;
 import static org.hibernate.type.SqlTypes.BINARY;
@@ -726,7 +725,7 @@ public String getSelectGUIDString() {
 
 	@Override
 	public LockingSupport getLockingSupport() {
-		return NoLockingSupport.NO_LOCKING_SUPPORT;
+		return LockingSupportSimple.NO_OUTER_JOIN;
 	}
 
 	@Override

hibernate-core/src/main/java/org/hibernate/Locking.java

@@ -20,6 +20,7 @@
  *
  * @author Steve Ebersole
  */
+@Incubating
 public interface Locking {
 	/**
 	 * When pessimistic locking is requested, this enum defines

hibernate-core/src/main/java/org/hibernate/dialect/lock/internal/SqlAstBasedLockingStrategy.java

@@ -47,6 +47,9 @@
 import java.util.Locale;
 
 /**
+ * LockingStrategy implementation which uses Hibernate's SQL AST
+ * mechanism for applying pessimistic locks.
+ *
  * @author Steve Ebersole
  */
 public class SqlAstBasedLockingStrategy implements LockingStrategy {

hibernate-core/src/main/java/org/hibernate/dialect/lock/package-info.java

@@ -7,5 +7,10 @@
  * Support for {@link org.hibernate.dialect.Dialect}-specific locking strategies.
  *
  * @see org.hibernate.dialect.lock.LockingStrategy
+ *
+ * @apiNote Marked incubating as major refactoring and reorganizing expected here during 7.x development.
  */
+@Incubating
 package org.hibernate.dialect.lock;
+
+import org.hibernate.Incubating;

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

@@ -5,10 +5,23 @@
 package org.hibernate.dialect.lock.spi;
 
 /**
+ * The way, if any, that a Dialect supports specifying lock timeouts.
+ *
  * @author Steve Ebersole
  */
 public enum LockTimeoutType {
+	/**
+	 * Lock timeouts are simply not supported.
+	 */
 	NONE,
+	/**
+	 * Lock timeouts are supported as part of the query; e.g. {@code for update ... wait 1000}.
+	 */
 	QUERY,
+	/**
+	 * Lock timeouts are supported on the JDBC Connection, typically through an {@code alter session} command.
+	 *
+	 * @see ConnectionLockTimeoutStrategy
+	 */
 	CONNECTION
 }

hibernate-testing/src/main/java/org/hibernate/testing/orm/AsyncExecutor.java

@@ -14,31 +14,33 @@
  */
 public class AsyncExecutor {
 	public static void executeAsync(Runnable action) {
-		final ExecutorService executorService = Executors.newSingleThreadExecutor();
-		try {
-			executorService.submit( action ).get();
-		}
-		catch (InterruptedException e) {
-			throw new RuntimeException( "Thread interruption", e );
-		}
-		catch (ExecutionException e) {
-			throw new RuntimeException( "Async execution error", e );
+		try (ExecutorService executorService = Executors.newSingleThreadExecutor()) {
+			try {
+				executorService.submit( action ).get();
+			}
+			catch (InterruptedException e) {
+				throw new RuntimeException( "Thread interruption", e );
+			}
+			catch (ExecutionException e) {
+				throw new RuntimeException( "Async execution error", e );
+			}
 		}
 	}
 
 	public static void executeAsync(int timeout, TimeUnit timeoutUnit, Runnable action) {
-		final ExecutorService executorService = Executors.newSingleThreadExecutor();
-		try {
-			executorService.submit( action ).get( timeout, timeoutUnit );
-		}
-		catch (InterruptedException e) {
-			throw new TimeoutException( "Thread interruption", e );
-		}
-		catch (java.util.concurrent.TimeoutException e) {
-			throw new TimeoutException( "Thread timeout exceeded", e );
-		}
-		catch (ExecutionException e) {
-			throw new RuntimeException( "Async execution error", e.getCause() );
+		try (ExecutorService executorService = Executors.newSingleThreadExecutor()) {
+			try {
+				executorService.submit( action ).get( timeout, timeoutUnit );
+			}
+			catch (InterruptedException e) {
+				throw new TimeoutException( "Thread interruption", e );
+			}
+			catch (java.util.concurrent.TimeoutException e) {
+				throw new TimeoutException( "Thread timeout exceeded", e );
+			}
+			catch (ExecutionException e) {
+				throw new RuntimeException( "Async execution error", e.getCause() );
+			}
 		}
 	}
 

migration-guide.adoc

@@ -21,6 +21,47 @@ earlier versions, see any other pertinent migration guides as well.
 
 This section describes changes to contracts (classes, interfaces, methods, etc.) which are considered https://hibernate.org/community/compatibility-policy/#api[API].
 
+[[lock-options]]
+=== LockOptions
+
+7.0 begins the process of reducing the visibility of `org.hibernate.LockOptions`.
+This class was originally exposed as an API, even though it is more properly an SPI.
+From an API perspective, `FindOption`, `LockOption` and `RefreshOption` are much better ways to specify that information.
+The class itself, as well as API methods which expose it, have been deprecated.
+
+However, 2 aspects of `LockOptions` have been completely removed.
+First, `LockOptions` previously defined a number of constants which have been removed.
+Secondly, the ability to define different LockModes for individual aliases has been removed.
+
+[NOTE]
+----
+ALias-specific LockModes was a very misleading feature, as Hibernate would only ever use the "greatest" LockMode.
+We plan to add the ability to specify a list of aliases to be locked in a later release.
+See https://hibernate.atlassian.net/browse/HHH-19664 for details.
+----
+
+Application code using `org.hibernate.LockOptions` should migrate to using `FindOption`,
+`LockOption` and `RefreshOption` to control the various aspects of locking.  E.g.
+
+[source,java]
+----
+LockOptions lockOptions = new LockOptions();
+lockOptions.setLockMode(PESSIMISTIC_WRITE);
+lockOptions.setTimeout(1000);
+session.refresh(book, lockOptions);
+----
+
+can instead be written as
+
+[source,java]
+----
+session.refresh(book,
+    PESSIMISTIC_WRITE,
+    Timeout.milliseconds(1000));
+----
+
+
+
 [[session-getLobHelper]]
 === Session#getLobHelper