Class JdbcMetadataOverrides

java.lang.Object

org.hibernate.dialect.jdbc.spi.JdbcMetadataOverrides

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

Immutable overrides applied to raw JDBC metadata reports.

A custom Dialect should retain one profile and return it from Dialect.getJdbcMetadataOverrides(). Select JdbcMetadataOverrides.SupportOverride.REPORTED to use Hibernate's interpretation of the raw driver report, JdbcMetadataOverrides.SupportOverride.SUPPORTED to force the effective answer to true, or JdbcMetadataOverrides.SupportOverride.UNSUPPORTED to force it to false.

These overrides describe effective driver behavior, not database SQL syntax. In particular, standard REF_CURSOR support says whether the JDBC Types.REF_CURSOR and typed getObject(..., ResultSet.class) path is usable; callable SQL support is supplied separately.

Since:

8.0

See Also:

• Dialect.getJdbcMetadataOverrides()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JdbcMetadataOverrides.Builder	Build an immutable JDBC-metadata-override profile.
static enum	JdbcMetadataOverrides.SupportOverride	Resolution to apply to one raw JDBC support report.

Field Summary

Fields

Modifier and Type	Field	Description
static final JdbcMetadataOverrides	STANDARD	The base-Dialect profile: use reported named-parameter and standard REF_CURSOR support, and force batch-update support.

Method Summary

Modifier and Type	Method	Description
static JdbcMetadataOverrides.Builder	builder()	Create a builder initialized from STANDARD.
static JdbcMetadataOverrides.Builder	builder(JdbcMetadataOverrides base)	Create a builder initialized from the given profile.
JdbcMetadataOverrides.SupportOverride	getBatchUpdateSupport()	The effective JDBC batch-update override.
JdbcMetadataOverrides.SupportOverride	getNamedParameterSupport()	The effective named-callable-parameter override.
JdbcMetadataOverrides.SupportOverride	getStandardRefCursorSupport()	The effective standard JDBC REF_CURSOR API override.

Methods inherited from class Object

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

Field Details

STANDARD

public static final JdbcMetadataOverrides STANDARD

The base-Dialect profile: use reported named-parameter and standard REF_CURSOR support, and force batch-update support.

Method Details

builder

public static JdbcMetadataOverrides.Builder builder()

Create a builder initialized from STANDARD.

builder

public static JdbcMetadataOverrides.Builder builder(JdbcMetadataOverrides base)

Create a builder initialized from the given profile.

Parameters:

base - the non-null profile to copy

getNamedParameterSupport

public JdbcMetadataOverrides.SupportOverride getNamedParameterSupport()

The effective named-callable-parameter override.

getBatchUpdateSupport

public JdbcMetadataOverrides.SupportOverride getBatchUpdateSupport()

The effective JDBC batch-update override.

getStandardRefCursorSupport

public JdbcMetadataOverrides.SupportOverride getStandardRefCursorSupport()

The effective standard JDBC REF_CURSOR API override.