Interface LockingSupport.Metadata

Enclosing interface:

LockingSupport

@SPI({USE,IMPLEMENT,SUPPLY})
public static interface LockingSupport.Metadata

Immutable description of the locking syntax and timeout capabilities of a Dialect.

Since:

8.0

See Also:

• LockingSupport.getMetadata()

Method Summary

Modifier and Type	Method	Description
default LockTimeoutType	getLockTimeoutType(Timeout timeout)	Reports how 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 RowLockStrategy for indicating which rows to lock as part of a for share of style clause.
default RowLockStrategy	getWriteRowLockStrategy()	The RowLockStrategy for indicating which rows to lock as part of a for update of style clause.
default boolean	readsWaitForUncommittedWrites()	Deprecated, for removal: This API element is subject to removal in a future version. Inspect ReadGuarantees.isCurrentRead() on the factory's TransactionConcurrency instead.
default boolean	supportsInnerJoins()	Whether inner joins are supported with pessimistic locking.
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 [Timeouts#isRealTimeout 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)

Reports how this Dialect supports the given timeout value.

See Also:

• getPessimisticLockStyle()

getReadRowLockStrategy

default RowLockStrategy getReadRowLockStrategy()

The RowLockStrategy for indicating which rows to lock as part of a for share of style clause. By default, this uses getWriteRowLockStrategy().

getWriteRowLockStrategy

default RowLockStrategy getWriteRowLockStrategy()

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

readsWaitForUncommittedWrites

@Deprecated(since="8.0",
            forRemoval=true)
default boolean readsWaitForUncommittedWrites()

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

Inspect ReadGuarantees.isCurrentRead() on the factory's TransactionConcurrency instead.

Legacy dialect-wide assumption, unused by concurrency resolution and current-read rendering.

getOuterJoinLockingType

OuterJoinLockingType getOuterJoinLockingType()

The type of support for outer joins with pessimistic locking.

supportsInnerJoins

default boolean supportsInnerJoins()

Whether inner joins are supported with pessimistic locking.

supportsWait

@Deprecated
default boolean supportsWait()

Deprecated.

Use getPessimisticLockStyle() with a [Timeouts#isRealTimeout real timeout value] instead.

Whether the Dialect supports supplying a specific lock-timeout wait period through query options, for example for update (of).

See Also:

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

API Note:

This exists temporarily while the legacy locking-clause rendering overloads are migrated.

supportsNoWait

@Deprecated
default boolean supportsNoWait()

Deprecated.

Use getPessimisticLockStyle() with Timeouts.NO_WAIT instead.

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

See Also:

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

API Note:

This exists temporarily while the legacy locking-clause rendering overloads are migrated.

supportsSkipLocked

@Deprecated
default boolean supportsSkipLocked()

Deprecated.

Use getPessimisticLockStyle() with Timeouts.SKIP_LOCKED instead.

Whether the Dialect supports specifying skip-locked through query options.

See Also:

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

API Note:

This exists temporarily while the legacy locking-clause rendering overloads are migrated.