Package org.hibernate.dialect.lock.spi

Interface LockingSupport.Metadata

All Known Implementing Classes:

CockroachLockingSupport, DB2LockingSupport, H2LockingSupport, HANALockingSupport, HSQLLockingSupport, LockingSupportParameterized, LockingSupportSimple, MariaDBLockingSupport, MySQLLockingSupport, NoLockingSupport, OracleLockingSupport, PostgreSQLLockingSupport, TimesTenLockingSupport, TransactSQLLockingSupport

Enclosing interface:

LockingSupport

public static interface LockingSupport.Metadata

Describes the locking capabilities of a Dialect.

Method Summary

Modifier and Type	Method	Description
default LockTimeoutType	getLockTimeoutType(Timeout timeout)	How (if) this Dialect supports the given timeout value.
OuterJoinLockingType	getOuterJoinLockingType()	The type of support for outer joins with pessimistic locking.
default PessimisticLockStyle	getPessimisticLockStyle()	The PessimisticLockStyle supported by this Dialect.
default RowLockStrategy	getReadRowLockStrategy()	The strategy for indicating which rows to lock as part of a for share of style clause.
default RowLockStrategy	getWriteRowLockStrategy()	The strategy for indicating which rows to lock as part of a for update of style clause.
default boolean	supportsForUpdate()	Deprecated. Use getPessimisticLockStyle(), passing the necessary lock timeout instead.
default boolean	supportsNoWait()	Deprecated. Use getPessimisticLockStyle(), with Timeouts.NO_WAIT instead.
default boolean	supportsSkipLocked()	Deprecated. Use getPessimisticLockStyle(), with Timeouts.SKIP_LOCKED instead.
default boolean	supportsWait()	Deprecated. Use getPessimisticLockStyle(), with a real timeout value instead.

Method Details

getPessimisticLockStyle

default PessimisticLockStyle getPessimisticLockStyle()

The PessimisticLockStyle supported by this Dialect.

See Also:

• getLockTimeoutType(Timeout)

getLockTimeoutType

default LockTimeoutType getLockTimeoutType(Timeout timeout)

How (if) this Dialect supports the given timeout value.

See Also:

• getPessimisticLockStyle()

getReadRowLockStrategy

default RowLockStrategy getReadRowLockStrategy()

The strategy for indicating which rows to lock as part of a for share of style clause.

By default, simply uses getWriteRowLockStrategy().

getWriteRowLockStrategy

default RowLockStrategy getWriteRowLockStrategy()

The strategy for indicating which rows to lock as part of a for update of style clause.

getOuterJoinLockingType

OuterJoinLockingType getOuterJoinLockingType()

The type of support for outer joins with pessimistic locking.

supportsForUpdate

@Deprecated
default boolean supportsForUpdate()

Deprecated.

Use getPessimisticLockStyle(), passing the necessary lock timeout instead.

Whether the Dialect supports for update (of) style syntax.

API Note:

This exists, temporarily, to migrate Dialect.supportsForUpdate().

supportsWait

@Deprecated
default boolean supportsWait()

Deprecated.

Use getPessimisticLockStyle(), with a real timeout value instead.

Whether the Dialect supports supplying specific lock timeout wait period via query options (e.g. for update (of)

See Also:

• getPessimisticLockStyle()
• PessimisticLockStyle.CLAUSE
• PessimisticLockStyle.TABLE_HINT

API Note:

This exists, temporarily, to migrate Dialect.supportsWait().

supportsNoWait

@Deprecated
default boolean supportsNoWait()

Deprecated.

Use getPessimisticLockStyle(), with Timeouts.NO_WAIT instead.

Whether the Dialect supports specifying no-wait via query options.

See Also:

• getPessimisticLockStyle()
• PessimisticLockStyle.CLAUSE
• PessimisticLockStyle.TABLE_HINT

API Note:

This exists, temporarily, to migrate Dialect.supportsNoWait().

supportsSkipLocked

@Deprecated
default boolean supportsSkipLocked()

Deprecated.

Use getPessimisticLockStyle(), with Timeouts.SKIP_LOCKED instead.

Whether the Dialect supports specifying a skip-locked via query options.

See Also:

• getPessimisticLockStyle()
• PessimisticLockStyle.CLAUSE
• PessimisticLockStyle.TABLE_HINT

API Note:

This exists, temporarily, to migrate Dialect.supportsSkipLocked().