Enum Class JdbcLockingApplication

java.lang.Object

java.lang.Enum<JdbcLockingApplication>

org.hibernate.sql.exec.spi.JdbcLockingApplication

All Implemented Interfaces:

Serializable, Comparable<JdbcLockingApplication>, Constable

@SPI
@Incubating(since="6.0",
            group="sql-execution")
public enum JdbcLockingApplication
extends Enum<JdbcLockingApplication>

Records which stage owns pessimistic locking for a JDBC select plan.

Exactly one stage must own a requested lock. Execution finalization uses this value to avoid applying raw-SQL or follow-on locking to a plan whose SQL AST translator already rendered locking syntax.

Since:

8.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FOLLOW_ON	Locking is performed by follow-on actions after the primary select.
NONE	The select does not request pessimistic locking.
RAW_SQL	Locking must still be attempted against the completed SQL string before execution.
RENDERED	Locking syntax was rendered while translating the SQL AST.

Method Summary

Modifier and Type	Method	Description
static JdbcLockingApplication	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JdbcLockingApplication[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final JdbcLockingApplication NONE

The select does not request pessimistic locking.

RENDERED

public static final JdbcLockingApplication RENDERED

Locking syntax was rendered while translating the SQL AST.

RAW_SQL

public static final JdbcLockingApplication RAW_SQL

Locking must still be attempted against the completed SQL string before execution.

FOLLOW_ON

public static final JdbcLockingApplication FOLLOW_ON

Locking is performed by follow-on actions after the primary select.

Method Details

values

public static JdbcLockingApplication[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static JdbcLockingApplication valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null