Enum Class IdentityValueRetrieval

java.lang.Object

java.lang.Enum<IdentityValueRetrieval>

org.hibernate.dialect.identity.spi.IdentityValueRetrieval

All Implemented Interfaces:

Serializable, Comparable<IdentityValueRetrieval>, Constable

@SPI
public enum IdentityValueRetrieval
extends Enum<IdentityValueRetrieval>

Selects how Hibernate retrieves an identifier generated by an identity column when generated-key retrieval is enabled.

This choice applies only to identity-generated identifiers. It does not describe retrieval of arbitrary generated columns or the generic post-mutation select performed when Hibernate already knows how to locate the affected row.

Since:

8.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPENDED_SELECT	Apply IdentityColumnSupport.appendIdentitySelectToInsert(String, String) and execute the completed SQL for a result set.
INFERRED_GENERATED_KEYS	Prepare the insert using the JDBC generated-keys flag and let the driver infer which generated columns to return.
NAMED_GENERATED_KEYS	Prepare the insert with the generated identity column name supplied to JDBC explicitly.

Method Summary

Modifier and Type	Method	Description
static IdentityValueRetrieval	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IdentityValueRetrieval[]	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

INFERRED_GENERATED_KEYS

public static final IdentityValueRetrieval INFERRED_GENERATED_KEYS

Prepare the insert using the JDBC generated-keys flag and let the driver infer which generated columns to return.

NAMED_GENERATED_KEYS

public static final IdentityValueRetrieval NAMED_GENERATED_KEYS

Prepare the insert with the generated identity column name supplied to JDBC explicitly.

APPENDED_SELECT

public static final IdentityValueRetrieval APPENDED_SELECT

Apply IdentityColumnSupport.appendIdentitySelectToInsert(String, String) and execute the completed SQL for a result set.

This is not a later execution of IdentityColumnSupport.getIdentitySelectString(String, String, int).

Method Details

values

public static IdentityValueRetrieval[] 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 IdentityValueRetrieval 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