Class StandardLockingSupports

java.lang.Object

org.hibernate.dialect.lock.spi.StandardLockingSupports

@Incubating(since="7.1",
            group="dialect-locking")
@SPI(USE)
public final class StandardLockingSupports
extends Object

Creates standard pessimistic-locking profiles for a custom Dialect.

Prefer a named database-family factory when extending a maintained Dialect. The named factories preserve Hibernate's version boundaries and coordinated metadata, renderers, timeout handling, and follow-on policy. Use simple(PessimisticLockStyle, RowLockStrategy, LockTimeoutType, OuterJoinLockingType, ConnectionLockTimeoutStrategy) or parameterized(PessimisticLockStyle, RowLockStrategy, LockTimeoutType, LockTimeoutType, LockTimeoutType, OuterJoinLockingType, TransactionConcurrencyResolver) only when defining a distinct provider profile.

Returned profiles are immutable or thread-safe and may be retained for the lifetime of the Dialect. Their concrete implementation is intentionally not part of the provider contract.

Since:

8.0

See Also:

• Dialect.getLockingSupport()

Method Summary

Modifier and Type	Method	Description
static LockingSupport	cockroach(DatabaseVersion version)	The CockroachDB profile selected for the given database version.
static LockingSupport	db2(DatabaseVersion version)	The DB2 LUW profile, including skip-locked support beginning with 11.5.
static LockingSupport	db2i()	The DB2 for i profile.
static LockingSupport	db2z()	The DB2 for z/OS profile.
static LockingSupport	h2(DatabaseVersion version)	The H2 profile selected for the given database version.
static LockingSupport	hana(DatabaseVersion version)	The HANA profile selected for the given database version.
static LockingSupport	hsql(DatabaseVersion version)	The HSQLDB profile selected for the given database version.
static LockingSupport	legacyDb2i()	The historical DB2 for i profile inherited from DB2 LUW.
static LockingSupport	legacySybaseAse()	The historical Sybase ASE profile.
static LockingSupport	mariaDb(DatabaseVersion version)	The MariaDB profile selected for the given database version.
static LockingSupport	mysql(DatabaseVersion version)	The MySQL profile selected for the given database version.
static LockingSupport	none()	A profile for a database which does not support pessimistic locking.
static LockingSupport	oracle(DatabaseVersion version)	The Oracle profile selected for the given database version.
static LockingSupport	parameterized(PessimisticLockStyle pessimisticLockStyle, RowLockStrategy rowLockStrategy, LockTimeoutType waitType, LockTimeoutType noWaitType, LockTimeoutType skipLockedType, OuterJoinLockingType outerJoinLockingType)	Creates a statement-clause profile with independent timeout classifications.
static LockingSupport	parameterized(PessimisticLockStyle pessimisticLockStyle, RowLockStrategy rowLockStrategy, LockTimeoutType waitType, LockTimeoutType noWaitType, LockTimeoutType skipLockedType, OuterJoinLockingType outerJoinLockingType, boolean readsWaitForUncommittedWrites)	Deprecated, for removal: This API element is subject to removal in a future version. Use the overload accepting TransactionConcurrencyResolver.
static LockingSupport	parameterized(PessimisticLockStyle style, RowLockStrategy rowLockStrategy, LockTimeoutType waitType, LockTimeoutType noWaitType, LockTimeoutType skipLockedType, OuterJoinLockingType outerJoinType, TransactionConcurrencyResolver resolver)	Creates a parameterized SQL strategy with an explicit concurrency resolver.
static LockingSupport	postgresql(DatabaseVersion version)	The PostgreSQL profile selected for the given database version.
static LockingSupport	simple(PessimisticLockStyle pessimisticLockStyle, RowLockStrategy rowLockStrategy, LockTimeoutType lockTimeoutType, OuterJoinLockingType outerJoinLockingType, ConnectionLockTimeoutStrategy connectionLockTimeoutStrategy)	Creates a profile using one timeout classification for every timeout value.
static LockingSupport	simple(PessimisticLockStyle pessimisticLockStyle, RowLockStrategy rowLockStrategy, LockTimeoutType lockTimeoutType, OuterJoinLockingType outerJoinLockingType, ConnectionLockTimeoutStrategy connectionLockTimeoutStrategy, boolean readsWaitForUncommittedWrites)	Deprecated, for removal: This API element is subject to removal in a future version. Use the overload accepting TransactionConcurrencyResolver.
static LockingSupport	simple(PessimisticLockStyle style, RowLockStrategy rowLockStrategy, LockTimeoutType timeoutType, OuterJoinLockingType outerJoinType, ConnectionLockTimeoutStrategy timeoutStrategy, TransactionConcurrencyResolver resolver)	Creates a simple SQL strategy with an explicit concurrency resolver.
static LockingSupport	sqlServer(DatabaseVersion version)	The SQL Server profile selected for the given database version.
static LockingSupport	standard()	The standard statement-clause profile inherited by Dialect.
static LockingSupport	standardWithoutOuterJoinLocking()	The standard statement-clause profile without outer-join locking.
static LockingSupport	sybase()	The Sybase profile.
static LockingSupport	sybaseAnywhere(DatabaseVersion version)	The Sybase Anywhere profile selected for the given database version.
static LockingSupport	sybaseAse()	The Sybase ASE profile.
static LockingSupport	timesTen()	The TimesTen profile.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

none

public static LockingSupport none()

A profile for a database which does not support pessimistic locking.

standard

public static LockingSupport standard()

The standard statement-clause profile inherited by Dialect.

standardWithoutOuterJoinLocking

public static LockingSupport standardWithoutOuterJoinLocking()

The standard statement-clause profile without outer-join locking.

simple

public static LockingSupport simple(PessimisticLockStyle pessimisticLockStyle,
 RowLockStrategy rowLockStrategy,
 LockTimeoutType lockTimeoutType,
 OuterJoinLockingType outerJoinLockingType,
 ConnectionLockTimeoutStrategy connectionLockTimeoutStrategy)

Creates a profile using one timeout classification for every timeout value.

simple

@Deprecated(since="8.0",
            forRemoval=true)
public static LockingSupport simple(PessimisticLockStyle pessimisticLockStyle,
 RowLockStrategy rowLockStrategy,
 LockTimeoutType lockTimeoutType,
 OuterJoinLockingType outerJoinLockingType,
 ConnectionLockTimeoutStrategy connectionLockTimeoutStrategy,
 boolean readsWaitForUncommittedWrites)

Deprecated, for removal: This API element is subject to removal in a future version.

Use the overload accepting TransactionConcurrencyResolver.

Legacy profile factory retaining the old read-blocking metadata. The boolean is not used for concurrency resolution or current-read rendering.

simple

public static LockingSupport simple(PessimisticLockStyle style,
 RowLockStrategy rowLockStrategy,
 LockTimeoutType timeoutType,
 OuterJoinLockingType outerJoinType,
 ConnectionLockTimeoutStrategy timeoutStrategy,
 TransactionConcurrencyResolver resolver)

Creates a simple SQL strategy with an explicit concurrency resolver.

Since:

8.0

parameterized

public static LockingSupport parameterized(PessimisticLockStyle style,
 RowLockStrategy rowLockStrategy,
 LockTimeoutType waitType,
 LockTimeoutType noWaitType,
 LockTimeoutType skipLockedType,
 OuterJoinLockingType outerJoinType,
 TransactionConcurrencyResolver resolver)

Creates a parameterized SQL strategy with an explicit concurrency resolver.

Since:

8.0

parameterized

public static LockingSupport parameterized(PessimisticLockStyle pessimisticLockStyle,
 RowLockStrategy rowLockStrategy,
 LockTimeoutType waitType,
 LockTimeoutType noWaitType,
 LockTimeoutType skipLockedType,
 OuterJoinLockingType outerJoinLockingType)

Creates a statement-clause profile with independent timeout classifications.

parameterized

@Deprecated(since="8.0",
            forRemoval=true)
public static LockingSupport parameterized(PessimisticLockStyle pessimisticLockStyle,
 RowLockStrategy rowLockStrategy,
 LockTimeoutType waitType,
 LockTimeoutType noWaitType,
 LockTimeoutType skipLockedType,
 OuterJoinLockingType outerJoinLockingType,
 boolean readsWaitForUncommittedWrites)

Deprecated, for removal: This API element is subject to removal in a future version.

Use the overload accepting TransactionConcurrencyResolver.

Legacy profile factory retaining the old read-blocking metadata. The boolean is not used for concurrency resolution or current-read rendering.

db2

public static LockingSupport db2(DatabaseVersion version)

The DB2 LUW profile, including skip-locked support beginning with 11.5.

db2i

public static LockingSupport db2i()

The DB2 for i profile.

legacyDb2i

public static LockingSupport legacyDb2i()

The historical DB2 for i profile inherited from DB2 LUW.

db2z

public static LockingSupport db2z()

The DB2 for z/OS profile.

h2

public static LockingSupport h2(DatabaseVersion version)

The H2 profile selected for the given database version.

hana

public static LockingSupport hana(DatabaseVersion version)

The HANA profile selected for the given database version.

hsql

public static LockingSupport hsql(DatabaseVersion version)

The HSQLDB profile selected for the given database version.

mysql

public static LockingSupport mysql(DatabaseVersion version)

The MySQL profile selected for the given database version.

mariaDb

public static LockingSupport mariaDb(DatabaseVersion version)

The MariaDB profile selected for the given database version.

oracle

public static LockingSupport oracle(DatabaseVersion version)

The Oracle profile selected for the given database version.

postgresql

public static LockingSupport postgresql(DatabaseVersion version)

The PostgreSQL profile selected for the given database version.

cockroach

public static LockingSupport cockroach(DatabaseVersion version)

The CockroachDB profile selected for the given database version.

timesTen

public static LockingSupport timesTen()

The TimesTen profile.

sqlServer

public static LockingSupport sqlServer(DatabaseVersion version)

The SQL Server profile selected for the given database version.

sybase

public static LockingSupport sybase()

The Sybase profile.

sybaseAse

public static LockingSupport sybaseAse()

The Sybase ASE profile.

legacySybaseAse

public static LockingSupport legacySybaseAse()

The historical Sybase ASE profile.

sybaseAnywhere

public static LockingSupport sybaseAnywhere(DatabaseVersion version)

The Sybase Anywhere profile selected for the given database version.