Class GeneratedValuesSupport

java.lang.Object

org.hibernate.dialect.generated.spi.GeneratedValuesSupport

@SPI({USE,SUPPLY})
public final class GeneratedValuesSupport
extends Object

Immutable description of the mechanisms a Dialect supports for retrieving arbitrary database-generated values during mutation execution.

Providers supply a stable profile through Dialect.getGeneratedValuesSupport(). Native mutation returning and JDBC generated keys are independent mechanisms. Identity-only generated-key behavior belongs to IdentityColumnSupport, while an ordinary select after a mutation is a Hibernate fallback determined from mapping and execution state rather than a Dialect capability.

Since:

8.0

See Also:

• Dialect.getGeneratedValuesSupport()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GeneratedValuesSupport.Builder	Build an immutable generated-values profile.
static enum	GeneratedValuesSupport.Capability	Independently variable generated-value retrieval capabilities.

Field Summary

Fields

Modifier and Type	Field	Description
static final GeneratedValuesSupport	STANDARD	The base-Dialect profile, which advertises no immediate generated-value retrieval mechanism.

Method Summary

Modifier and Type	Method	Description
static GeneratedValuesSupport.Builder	builder()	Create a builder initialized from STANDARD.
static GeneratedValuesSupport.Builder	builder(GeneratedValuesSupport base)	Create a builder initialized with every value from the given profile.
Set<GeneratedValuesSupport.Capability>	getCapabilities()	The immutable set of supported immediate retrieval capabilities.
boolean	supports(GeneratedValuesSupport.Capability capability)	Whether the given immediate retrieval capability is supported.
boolean	unquoteGeneratedKeyColumnNames()	Whether generated column names must be unquoted before passing them to JDBC statement preparation.

Methods inherited from class Object

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

Field Details

STANDARD

public static final GeneratedValuesSupport STANDARD

The base-Dialect profile, which advertises no immediate generated-value retrieval mechanism.

Method Details

builder

public static GeneratedValuesSupport.Builder builder()

Create a builder initialized from STANDARD.

builder

public static GeneratedValuesSupport.Builder builder(GeneratedValuesSupport base)

Create a builder initialized with every value from the given profile.

supports

public boolean supports(GeneratedValuesSupport.Capability capability)

Whether the given immediate retrieval capability is supported.

getCapabilities

public Set<GeneratedValuesSupport.Capability> getCapabilities()

The immutable set of supported immediate retrieval capabilities.

unquoteGeneratedKeyColumnNames

public boolean unquoteGeneratedKeyColumnNames()

Whether generated column names must be unquoted before passing them to JDBC statement preparation.