Class OracleDialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.OracleDialect

All Implemented Interfaces:

CheckConstraintSupport, ForeignKeySupport, IdentifierSupport, KeywordSupport, LiteralSupport, AlterTableSupport, ColumnDefinitionSupport, ConstraintControlSupport, IndexDdlSupport, TableCreationSupport, TruncateSupport, CurrentTemporalSupport, TemporalFormatSupport, TemporalOperationSupport, ConversionContext

Direct Known Subclasses:

OracleSpatial10gDialect, OracleSpatialSDO10gDialect

public class OracleDialect
extends Dialect
implements CurrentTemporalSupport, TemporalFormatSupport, TemporalOperationSupport

A SQL dialect for Oracle 19c and above.

Please refer to the Oracle documentation.

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	applicationContinuity
protected final boolean	autonomous
protected final int	driverMajorVersion
protected final int	driverMinorVersion
protected final boolean	extended

Fields inherited from class Dialect

LEGACY_LOB_MERGE_STRATEGY, NEW_LOCATOR_LOB_MERGE_STRATEGY, STANDARD_MULTI_KEY_LOAD_SIZING_STRATEGY, STREAM_XFER_LOB_MERGE_STRATEGY

Fields inherited from interface ConstraintControlSupport

NONE

Fields inherited from interface TruncateSupport

STANDARD

Constructor Summary

Constructors

Constructor	Description
OracleDialect()
OracleDialect(DatabaseVersion version)
OracleDialect(DialectResolutionInfo info)
OracleDialect(DialectResolutionInfo info, OracleServerConfiguration serverConfiguration)

Method Summary

Modifier and Type	Method	Description
String	addColumnPrefix()
String	alterColumnType(AlterColumnTypeRequest request)
void	appendBinaryLiteral(SqlAppender appender, byte[] bytes)	Append a SQL binary literal.
void	appendBooleanValueString(SqlAppender appender, boolean bool)	Append a SQL Boolean literal expression.
void	appendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone)	Append a datetime literal for a java.time value.
void	appendDefinition(SqlAppender appender, ColumnDefinitionRequest request)
void	appendFormat(SqlAppender appender, String format)	Append the database translation of the supplied Hibernate format pattern.
IdentifierHelper	buildIdentifierHelper(IdentifierHelperBuildRequest request)	Build and supply the configured identifier helper from the stable JDBC metadata snapshot and selected keyword strategy.
SQLExceptionConversionDelegate	buildSQLExceptionConversionDelegate()	Supplies vendor-specific SQL-exception conversion for this Dialect.
String	castPattern(CastType from, CastType to)	type or Types.TIME type, and its default behavior for casting dates and timestamps to and from strings is just awful.
protected String	columnType(int sqlTypeCode)	Return the complete database column declaration pattern for a JDBC Types or Hibernate SqlTypes code used during type registration.
ConstraintControlMode	constraintControlMode()
protected void	contributeDefaultProperties(Properties properties)	Contribute provider configuration defaults after Dialect construction.
void	contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)	Contribute database-specific Java, JDBC, DDL, and basic type descriptors.
MutationOperation	createOptionalTableUpdateOperation(OptionalTableUpdateOperationRequest request)	Creates the JDBC mutation operation for an optional-table update.
String	currentDate()	Render the current SQL date expression.
String	currentLocalTime()	Render the current local-time expression.
String	currentLocalTimestamp()	Render the current local-timestamp expression.
String	currentTime()	Render the current SQL time expression used for java.sql.Time.
String	currentTimestamp()	Render the current SQL timestamp expression used for java.sql.Timestamp.
String	currentTimestampWithTimeZone()	Render the current timestamp-with-time-zone expression.
static Replacer	datetimeFormat(String format, boolean useFm, boolean resetFm)
List<String>	disableConstraintCommands(ConstraintControlRequest request)
List<String>	enableConstraintCommands(ConstraintControlRequest request)
String	extractPattern(TemporalUnit unit)	Oracle supports a limited list of temporal fields in the extract() function, but we can emulate some of them by using to_char() with a format string instead of extract().
long	fractionalSecondPrecisionInNanos()	We minimize multiplicative factors by using seconds (with fractional part) as the "native" precision for duration arithmetic.
AggregateSupport	getAggregateSupport()	Supply the aggregate-column mapping, DDL, read, assignment, and write behavior for this dialect.
String	getArrayTypeName(String javaElementTypeName, String elementTypeName, Integer maxLength)	Render an array type name from the independent Java element name, rendered SQL element name, and optional maximum length.
CallableStatementSupport	getCallableStatementSupport()	Supply the callable-statement protocol for this database and JDBC driver.
static String[]	getCreateVarcharEnumTypeCommand(String name, String[] values)	Used to generate the CREATE DDL command for Data Use Case Domain based on VARCHAR2 values.
CteSupport	getCteSupport()	The common-table-expression capabilities of this Dialect.
CurrentTemporalSupport	getCurrentTemporalSupport()	Supply current temporal expressions and database-side timestamp retrieval.
CurrentTimestampSelection	getCurrentTimestampSelection()	Select the JDBC command used for database-side current timestamp retrieval, or return null when the database offers no supported command.
DmlTargetColumnQualifierSupport	getDmlTargetColumnQualifierSupport()	The qualifier form accepted for target-column references in update and delete statements.
int	getDriverMajorVersion()
int	getDriverMinorVersion()
EnumSupport	getEnumSupport()	Supply the database's finite-domain declaration, lifecycle, and check strategy.
FetchClauseSupport	getFetchClauseSupport()	Supply the fetch clause forms accepted by this database.
GeneratedValuesSupport	getGeneratedValuesSupport()	Supply the stable profile describing immediate retrieval of arbitrary database-generated values for this Dialect.
TemporaryTableStrategy	getGlobalTemporaryTableStrategy()	Supplies this Dialect's global temporary-table strategy.
IdentityColumnSupport	getIdentityColumnSupport()	Supply the stable identity-column DDL, insert syntax, and identity-specific retrieval behavior for this Dialect.
IfExistsSupport	getIfExistsSupport()	Supply existence-check placement for schema DDL targets.
InformationExtractor	getInformationExtractor(ExtractionContext extractionContext)	Supply the context-bound strategy Hibernate uses to discover database tables, keys, indexes, and related schema metadata.
LimitHandler	getLimitHandler()	Supplies execution-time pagination for already-rendered SQL requested by Query.setMaxResults(int) or Query.setFirstResult(int).
LobSupport	getLobSupport()	Supply the database and driver policy for LOB creation, binding, materialization, type classification, mutation ordering, and VALUE LOB DDL.
TemporaryTableStrategy	getLocalTemporaryTableStrategy()	Supplies this Dialect's local temporary-table strategy.
LockingSupport	getLockingSupport()	Supplies the cohesive pessimistic-locking profile for this Dialect.
int	getMaxAliasLength()	Return the safe maximum length of a generated SQL alias, including room for Hibernate's generated suffix.
int	getMaxIdentifierLength()	Return the database's maximum identifier length.
protected int	getMaximumSeriesSize()	Oracle doesn't support the generate_series function or lateral recursive CTEs, so it has to be emulated with a top level recursive CTE which requires an upper bound on the amount of elements that the series can return.
protected DatabaseVersion	getMinimumSupportedVersion()	Get the version of the SQL dialect that is the minimum supported by this implementation.
MultiTableMutationSupport	getMultiTableMutationSupport()	Select the Hibernate-owned fallback families used for SQM update/delete and insert operations targeting entities mapped to multiple tables.
MutationSyntaxSupport	getMutationSyntaxSupport()	The native SQL mutation-syntax capabilities of this Dialect.
NamespaceSupport	getNamespaceSupport()	Supply catalog and schema lifecycle behavior to schema tooling.
GenerationType	getNativeValueGenerationStrategy()	Supply the semantic identifier-generation type used for native generation.
ParameterLimits	getParameterLimits()	Supplies the database limits for IN-expression elements and total JDBC statement parameters.
int	getPreferredSqlTypeCodeForArray()	Select the default SqlTypes code for a basic Java array or collection.
int	getPreferredSqlTypeCodeForBoolean()	Select the default SqlTypes code for Java boolean mappings.
String	getQueryHintString(String sql, String hints)	Apply a hint to the given SQL query.
String	getQueryHintString(String query, List<String> hintList)	Apply a hint to the given SQL query.
RefCursorSupportFactory	getRefCursorSupportFactory()	Supply the stable factory which creates this Dialect's JDBC REF_CURSOR registration and extraction service.
RowIdSupport	getRowIdSupport()	Supply the database's row-locator expression, JDBC type, and optional physical-column declaration policy.
RowValueSupport	getRowValueSupport()	The native row-value syntax of this Dialect.
SchemaCommentSupport	getSchemaCommentSupport()	Supply schema-export support for comments attached to database objects.
SchemaDropSupport	getSchemaDropSupport()	Supply schema-drop composition and ordered pre-drop commands.
SequenceInformationExtractor	getSequenceInformationExtractor()	Supply the strategy Hibernate uses to discover existing database sequences and their metadata.
SequenceSupport	getSequenceSupport()	Supplies the complete sequence value-expression and lifecycle-DDL strategy for this Dialect.
SetOperationSupport	getSetOperationSupport()	Supplies the database's set operators and structural query-group capabilities.
String	getSetOperatorSqlString(SetOperator setOperator)	Get the SQL string representation for a specific set operator (UNION, INTERSECT, EXCEPT).
SingleRowTableSupport	getSingleRowTableSupport()	Supply the SQL renderings used for a reusable single-row table and for an otherwise table-less select.
SqlAstTranslatorFactory	getSqlAstTranslatorFactory()	Supply the factory for this Dialect's single-use SQL AST translators.
StringValueSemantics	getStringValueSemantics()	Supply the database's stable string-value semantics.
SubquerySupport	getSubquerySupport()	Supplies the database's supported subquery placements.
Exporter<Table>	getTableExporter()	Supply the exporter used to create and drop relational tables.
TemporalFormatSupport	getTemporalFormatSupport()	Supply datetime-format translation.
TemporalOperationSupport	getTemporalOperationSupport()	Supply extraction and timestamp-arithmetic syntax.
TemporalTableSupport	getTemporalTableSupport()	Supplies the complete temporal-table DDL and historical-query strategy for this Dialect.
TimeZoneSupport	getTimeZoneSupport()	Select the database's support profile for SQL with time zone types.
TupleCountSupport	getTupleCountSupport()	Supplies the database syntax for ordinary and distinct tuple counts.
TypeSizingProfile	getTypeSizingProfile()	Supplies this Dialect's resolved type-sizing limits and defaults.
UniqueDelegate	getUniqueDelegate()	Supply the stable strategy used for unique-key representation and DDL.
Exporter<UserDefinedType>	getUserDefinedTypeExporter()	Supply the exporter used to create and drop user-defined types.
ValuesListSupport	getValuesListSupport()	The contexts in which this Dialect supports native multi-row values syntax.
ViolatedConstraintNameExtractor	getViolatedConstraintNameExtractor()	Supplies the extractor used to recover violated constraint names from database exceptions.
WindowFunctionSupport	getWindowFunctionSupport()	Supplies the native window-function syntax supported by this database.
void	initializeFunctionRegistry(FunctionContributions functionContributions)	Contribute the database-specific function descriptors after independent function contributors have run.
boolean	isApplicationContinuity()
boolean	isAutonomous()
boolean	isExtended()
protected static void	registerArrayFunctions(CommonFunctionFactory functionFactory)
protected void	registerColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)	Register the inherited ANSI-oriented DDL type descriptors during Dialect type contribution.
protected static void	registerJsonFunctions(CommonFunctionFactory functionFactory)
protected static void	registerXmlFunctions(CommonFunctionFactory functionFactory)
String	render(CheckConstraintRenderRequest request)
JdbcType	resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry)	Resolve the non-null JDBC descriptor for result-set metadata.
boolean	supportsUserDefinedTypes()	Whether mapped aggregate structures may be represented as database user-defined types.
boolean	throttleDdl()	Whether schema-management DDL commands require a short delay before execution to accommodate database-side propagation.
String	timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType)	Return a timestamp-add pattern containing ?1, ?2, and ?3.
String	timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalType, TemporalType toTemporalType)	Return a timestamp-difference pattern containing ?1, ?2, and ?3.

Methods inherited from class Dialect

addPartitionKeyToPrimaryKey, appendArrayLiteral, appendDateTimeLiteral, appendDateTimeLiteral, augmentPhysicalTableTypes, augmentRecognizedTableTypes, buildLockingClauseStrategy, buildStringToBooleanCast, buildStringToBooleanCastDecode, castType, causesRollback, contributeKeywords, defaultScrollMode, determineDatabaseVersion, equivalentTypes, getAlterTableSupport, getArraySupport, getBatchLoadSizingStrategy, getCatalogSeparator, getCheckConstraintSupport, getColumnAliasExtractor, getColumnDefinitionSupport, getConstraintControlSupport, getDefaultOrdinalityColumnName, getDefaultProperties, getDirectJavaTimeJdbcSupport, getEntityLockingStrategyFactory, getExpressionCoercionSupport, getForeignKeyExporter, getForeignKeySupport, getFunctionalDependencyAnalysisSupport, getIdentifierSupport, getIndexDdlSupport, getIndexExporter, getJdbcMetadataOverrides, getKeywords, getKeywordSupport, getLiteralSupport, getLobMergeStrategy, getLockingClauseStrategy, getLowercaseFunction, getMultiKeyLoadSizingStrategy, getNameQualifierSupport, getNationalizationSupport, getNativeParameterMarkerStrategy, getNullOrderingSupport, getObjectNullBindingStrategy, getPersistentTemporaryTableStrategy, getPredicateSupport, getQueryHintPlacement, getRowLevelSecurity, getSchemaNameResolver, getSelectClauseNullString, getSequenceExporter, getSizeStrategy, getSyntheticTableGroupSupport, getTableCleaner, getTableCreationSupport, getTableMigrator, getTemporalValueSemantics, getTemporaryTableExporter, getTruncateSupport, getVersion, isJdbcLogWarningsEnabledByDefault, narrowCastType, resolveSqlTypeCode, resolveSqlTypeCode, resolveSqlTypeLength, supportsCrossJoin, supportsFilterClause, supportsNationalizedMethods, supportsOrdinalSelectItemReference, toString, trimPattern, truncateMode

Methods inherited from class Object

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

Methods inherited from interface AlterTableSupport

addColumnSuffix, alterTableCommand

Methods inherited from interface CheckConstraintSupport

supports

Methods inherited from interface ConstraintControlSupport

disableCommands, enableCommands

Methods inherited from interface CurrentTemporalSupport

isCurrentTimestampStable, usesStandardCurrentTimestampFunction

Methods inherited from interface ForeignKeySupport

renderAddConstraint, renderDropConstraint, requiresSelfReferentialForeignKeyNullification, supportsAlterTableConstraints, supportsOnDeleteAction

Methods inherited from interface IdentifierSupport

closeQuote, openQuote, quote, quoteCollation, toQuotedIdentifier

Methods inherited from interface IndexDdlSupport

createCommand, createTail, nameQualification

Methods inherited from interface KeywordSupport

acceptsJdbcKeyword

Methods inherited from interface LiteralSupport

appendIntervalLiteral, appendIntervalLiteral, appendLiteral, appendUUIDLiteral, toBooleanValueString

Methods inherited from interface TableCreationSupport

createTableCommand, requiresViewColumnList, tableCreationOptions

Methods inherited from interface TemporalOperationSupport

translateDurationField, translateExtractField

Methods inherited from interface TruncateSupport

renderCommands

Field Details

autonomous

protected final boolean autonomous

extended

protected final boolean extended

applicationContinuity

protected final boolean applicationContinuity

driverMajorVersion

protected final int driverMajorVersion

driverMinorVersion

protected final int driverMinorVersion

Constructor Details

OracleDialect

public OracleDialect()

OracleDialect

public OracleDialect(DatabaseVersion version)

OracleDialect

public OracleDialect(DialectResolutionInfo info)

OracleDialect

public OracleDialect(DialectResolutionInfo info,
 OracleServerConfiguration serverConfiguration)

Method Details

getTemporalOperationSupport

@SPI({IMPLEMENT,SUPPLY})
public TemporalOperationSupport getTemporalOperationSupport()

Description copied from class: Dialect

Supply extraction and timestamp-arithmetic syntax. Return one stable, non-null, thread-safe implementation. Providers may implement TemporalOperationSupport directly and return this.

Overrides:

getTemporalOperationSupport in class Dialect

See Also:

• TemporalOperationSupport

getTemporalFormatSupport

@SPI({IMPLEMENT,SUPPLY})
public TemporalFormatSupport getTemporalFormatSupport()

Description copied from class: Dialect

Supply datetime-format translation. Return one stable, non-null, thread-safe implementation.

Overrides:

getTemporalFormatSupport in class Dialect

See Also:

• TemporalFormatSupport

getCurrentTemporalSupport

@SPI({IMPLEMENT,SUPPLY})
public CurrentTemporalSupport getCurrentTemporalSupport()

Description copied from class: Dialect

Supply current temporal expressions and database-side timestamp retrieval. Return one stable, non-null, thread-safe implementation. Providers may implement CurrentTemporalSupport directly and return this.

Overrides:

getCurrentTemporalSupport in class Dialect

See Also:

• CurrentTemporalSupport

getTypeSizingProfile

public TypeSizingProfile getTypeSizingProfile()

Description copied from class: Dialect

Supplies this Dialect's resolved type-sizing limits and defaults.

Return TypeSizingProfile.STANDARD when no dimension differs. Construct one stable immutable profile after version and server configuration are known. A family Dialect may copy its superclass profile, but must set every effective dimension which formerly changed through scalar-method delegation because profile builder setters do not cascade.

Overrides:

getTypeSizingProfile in class Dialect

isAutonomous

public boolean isAutonomous()

isExtended

public boolean isExtended()

isApplicationContinuity

public boolean isApplicationContinuity()

getMinimumSupportedVersion

@SPI({IMPLEMENT,SUPPLY})
protected DatabaseVersion getMinimumSupportedVersion()

Description copied from class: Dialect

Get the version of the SQL dialect that is the minimum supported by this implementation.

This method is called during superclass construction. Implementations must return construction-safe immutable data and must not depend on subclass initialization.

Overrides:

getMinimumSupportedVersion in class Dialect

getPreferredSqlTypeCodeForBoolean

@SPI({IMPLEMENT,SUPPLY})
public int getPreferredSqlTypeCodeForBoolean()

Description copied from class: Dialect

Select the default SqlTypes code for Java boolean mappings.

Return a Boolean-compatible code such as SqlTypes.BOOLEAN, SqlTypes.BIT, SqlTypes.SMALLINT, SqlTypes.TINYINT, or SqlTypes.INTEGER. The hibernate.type.preferred_boolean_jdbc_type setting takes precedence over this Dialect default. This method selects a type code; contribute a JDBC descriptor or customize DDL rendering through their dedicated contracts.

Overrides:

getPreferredSqlTypeCodeForBoolean in class Dialect

Returns:

a Boolean-compatible type code defined by SqlTypes

See Also:

• MappingSettings.PREFERRED_BOOLEAN_JDBC_TYPE

appendBooleanValueString

@SPI({USE,IMPLEMENT})
public void appendBooleanValueString(SqlAppender appender,
 boolean bool)

Description copied from interface: LiteralSupport

Append a SQL Boolean literal expression.

Specified by:

appendBooleanValueString in interface LiteralSupport

initializeFunctionRegistry

@SPI({IMPLEMENT,SUPPLY})
public void initializeFunctionRegistry(FunctionContributions functionContributions)

Description copied from class: Dialect

Contribute the database-specific function descriptors after independent function contributors have run.

Override this callback to extend or replace the inherited function set. Invoke super first to retain Hibernate's standard and emulated registrations; omitting it deliberately replaces that set. Mutate the supplied boot-scoped function registry only during this callback, and do not retain the contribution context or registry afterward. Implement an independent FunctionContributor instead when the contribution is not owned by a Dialect.

Overrides:

initializeFunctionRegistry in class Dialect

Parameters:

functionContributions - the Hibernate-supplied function contribution target

See Also:

• FunctionContributions
• FunctionContributor
• SqmFunctionRegistry
• SqmFunctionDescriptor
• CommonFunctionFactory

registerXmlFunctions

protected static void registerXmlFunctions(CommonFunctionFactory functionFactory)

registerJsonFunctions

protected static void registerJsonFunctions(CommonFunctionFactory functionFactory)

registerArrayFunctions

protected static void registerArrayFunctions(CommonFunctionFactory functionFactory)

getMaximumSeriesSize

protected int getMaximumSeriesSize()

Oracle doesn't support the generate_series function or lateral recursive CTEs, so it has to be emulated with a top level recursive CTE which requires an upper bound on the amount of elements that the series can return.

getSqlAstTranslatorFactory

@SPI({IMPLEMENT,SUPPLY})
public SqlAstTranslatorFactory getSqlAstTranslatorFactory()

Description copied from class: Dialect

Supply the factory for this Dialect's single-use SQL AST translators.

Return null to use StandardSqlAstTranslatorFactory. A custom Dialect should normally return a reusable factory derived from that class and create translators derived from AbstractSqlAstTranslator or an appropriate supported family base. The factory must not retain translation requests, and every translator it returns is used for one translation.

Overrides:

getSqlAstTranslatorFactory in class Dialect

See Also:

• SqlAstTranslatorFactory
• JdbcEnvironment.getSqlAstTranslatorFactory()

currentDate

@SPI({USE,IMPLEMENT})
public String currentDate()

Description copied from interface: CurrentTemporalSupport

Render the current SQL date expression.

Specified by:

currentDate in interface CurrentTemporalSupport

currentTime

@SPI({USE,IMPLEMENT})
public String currentTime()

Description copied from interface: CurrentTemporalSupport

Render the current SQL time expression used for java.sql.Time.

Specified by:

currentTime in interface CurrentTemporalSupport

currentTimestamp

@SPI({USE,IMPLEMENT})
public String currentTimestamp()

Description copied from interface: CurrentTemporalSupport

Render the current SQL timestamp expression used for java.sql.Timestamp.

Specified by:

currentTimestamp in interface CurrentTemporalSupport

currentLocalTime

@SPI({USE,IMPLEMENT})
public String currentLocalTime()

Description copied from interface: CurrentTemporalSupport

Render the current local-time expression.

Specified by:

currentLocalTime in interface CurrentTemporalSupport

currentLocalTimestamp

@SPI({USE,IMPLEMENT})
public String currentLocalTimestamp()

Description copied from interface: CurrentTemporalSupport

Render the current local-timestamp expression.

Specified by:

currentLocalTimestamp in interface CurrentTemporalSupport

currentTimestampWithTimeZone

@SPI({USE,IMPLEMENT})
public String currentTimestampWithTimeZone()

Description copied from interface: CurrentTemporalSupport

Render the current timestamp-with-time-zone expression.

Specified by:

currentTimestampWithTimeZone in interface CurrentTemporalSupport

getGeneratedValuesSupport

public GeneratedValuesSupport getGeneratedValuesSupport()

Description copied from class: Dialect

Supply the stable profile describing immediate retrieval of arbitrary database-generated values for this Dialect.

Override this method to declare native insert or update returning, row-id returning, or JDBC generated-key support for arbitrary generated columns. Identity-only retrieval belongs to Dialect.getIdentityColumnSupport(), and an ordinary select after mutation is a Hibernate fallback rather than a capability of this profile. Refine a family profile by copying the value returned by the superclass and changing only the differing capabilities.

Overrides:

getGeneratedValuesSupport in class Dialect

castPattern

@SPI({USE,IMPLEMENT})
public String castPattern(CastType from,
 CastType to)

type or Types.TIME type, and its default behavior for casting dates and timestamps to and from strings is just awful.

Overrides:

castPattern in class Dialect

Parameters:

from - a CastType indicating the type of the value argument

to - a CastType indicating the type the value argument is cast to

fractionalSecondPrecisionInNanos

@SPI({USE,IMPLEMENT})
public long fractionalSecondPrecisionInNanos()

We minimize multiplicative factors by using seconds (with fractional part) as the "native" precision for duration arithmetic.

Specified by:

fractionalSecondPrecisionInNanos in interface TemporalOperationSupport

extractPattern

@SPI({USE,IMPLEMENT})
public String extractPattern(TemporalUnit unit)

Oracle supports a limited list of temporal fields in the extract() function, but we can emulate some of them by using to_char() with a format string instead of extract().

Thus, the additional supported fields are TemporalUnit.DAY_OF_YEAR, TemporalUnit.DAY_OF_MONTH, TemporalUnit.DAY_OF_YEAR, and TemporalUnit.WEEK.

Specified by:

extractPattern in interface TemporalOperationSupport

timestampaddPattern

@SPI({USE,IMPLEMENT})
public String timestampaddPattern(TemporalUnit unit,
 TemporalType temporalType,
 IntervalType intervalType)

Description copied from interface: TemporalOperationSupport

Return a timestamp-add pattern containing ?1, ?2, and ?3.

Specified by:

timestampaddPattern in interface TemporalOperationSupport

timestampdiffPattern

@SPI({USE,IMPLEMENT})
public String timestampdiffPattern(TemporalUnit unit,
 TemporalType fromTemporalType,
 TemporalType toTemporalType)

Description copied from interface: TemporalOperationSupport

Return a timestamp-difference pattern containing ?1, ?2, and ?3.

Specified by:

timestampdiffPattern in interface TemporalOperationSupport

columnType

@SPI({USE,IMPLEMENT})
protected String columnType(int sqlTypeCode)

Description copied from class: Dialect

Return the complete database column declaration pattern for a JDBC Types or Hibernate SqlTypes code used during type registration.

Use only $l, $p, and $s for length, precision, and scale. Define distinct mappings for the LONG32 codes; the JDBC LONG synonyms are normalized before this hook. Delegate unknown inherited codes to the superclass so its standard exception remains authoritative.

Overrides:

columnType in class Dialect

registerColumnTypes

@SPI({IMPLEMENT,SUPPLY})
protected void registerColumnTypes(TypeContributions typeContributions,
 ServiceRegistry serviceRegistry)

Description copied from class: Dialect

Register the inherited ANSI-oriented DDL type descriptors during Dialect type contribution.

Override this focused sub-hook to extend or replace column type registrations. Invoke super first to retain the inherited descriptor set; omitting it deliberately replaces that set. Mutate the supplied boot-scoped registry only during this callback, and do not retain the contribution context or registry afterward. Implement an independent TypeContributor instead when the contribution is not owned by a Dialect.

Overrides:

registerColumnTypes in class Dialect

Parameters:

typeContributions - the Hibernate-supplied contribution target

serviceRegistry - the Hibernate-supplied bootstrap services

See Also:

• Dialect.contributeTypes(TypeContributions, ServiceRegistry)
• Dialect.getTypeSizingProfile()

getTimeZoneSupport

@SPI({IMPLEMENT,SUPPLY})
public TimeZoneSupport getTimeZoneSupport()

Description copied from class: Dialect

Select the database's support profile for SQL with time zone types.

Override this method to report whether the database preserves the original zone, normalizes values to UTC, or has no native support. This value participates in mapping and JDBC type selection; it does not control temporal-literal syntax.

Overrides:

getTimeZoneSupport in class Dialect

Returns:

the database time-zone type support profile

See Also:

• TimeZoneSupport

contributeDefaultProperties

@SPI({IMPLEMENT,SUPPLY})
protected void contributeDefaultProperties(Properties properties)

Description copied from class: Dialect

Contribute provider configuration defaults after Dialect construction.

Invoke super first to extend the inherited defaults. Omitting super deliberately replaces them. Mutate the supplied isolated property bag only during this callback; do not retain it or call Dialect.getDefaultProperties() from a Dialect constructor.

Overrides:

contributeDefaultProperties in class Dialect

Parameters:

properties - the isolated contribution target

resolveSqlTypeDescriptor

@SPI({USE,IMPLEMENT})
public JdbcType resolveSqlTypeDescriptor(String columnTypeName,
 int jdbcTypeCode,
 int precision,
 int scale,
 JdbcTypeRegistry jdbcTypeRegistry)

Description copied from class: Dialect

Resolve the non-null JDBC descriptor for result-set metadata.

Preserve vendor replacement and array-component resolution, and delegate unmatched codes to jdbcTypeRegistry.

Overrides:

resolveSqlTypeDescriptor in class Dialect

supportsUserDefinedTypes

@SPI({IMPLEMENT,SUPPLY})
public boolean supportsUserDefinedTypes()

Description copied from class: Dialect

Whether mapped aggregate structures may be represented as database user-defined types.

This capability is independent of Dialect.getUserDefinedTypeExporter(), which supplies schema commands for any UDT definitions that are present.

Overrides:

supportsUserDefinedTypes in class Dialect

See Also:

• Struct

getArrayTypeName

@SPI({USE,IMPLEMENT})
public String getArrayTypeName(String javaElementTypeName,
 String elementTypeName,
 Integer maxLength)

Description copied from class: Dialect

Render an array type name from the independent Java element name, rendered SQL element name, and optional maximum length.

Return null when array types are unsupported. The standard forms are element array and element array[length].

Overrides:

getArrayTypeName in class Dialect

getPreferredSqlTypeCodeForArray

@SPI({IMPLEMENT,SUPPLY})
public int getPreferredSqlTypeCodeForArray()

Description copied from class: Dialect

Select the default SqlTypes code for a basic Java array or collection.

Return the container type Hibernate should request when no local mapping selects one. Typical choices are SqlTypes.ARRAY, SqlTypes.TABLE, SqlTypes.JSON_ARRAY, SqlTypes.XML_ARRAY, and SqlTypes.VARBINARY. The hibernate.type.preferred_array_jdbc_type setting takes precedence over this Dialect default. This method selects a type code; contribute a JDBC descriptor or customize DDL rendering through their dedicated contracts.

Overrides:

getPreferredSqlTypeCodeForArray in class Dialect

Returns:

a container type code defined by SqlTypes

See Also:

• MappingSettings.PREFERRED_ARRAY_JDBC_TYPE

getUserDefinedTypeExporter

@SPI({USE,IMPLEMENT,SUPPLY})
public Exporter<UserDefinedType> getUserDefinedTypeExporter()

Description copied from class: Dialect

Supply the exporter used to create and drop user-defined types.

Return one stable exporter owned by this Dialect. Use StandardUserDefinedTypeExporter when standard object-type DDL is sufficient.

Overrides:

getUserDefinedTypeExporter in class Dialect

contributeTypes

@SPI({IMPLEMENT,SUPPLY})
public void contributeTypes(TypeContributions typeContributions,
 ServiceRegistry serviceRegistry)

Description copied from class: Dialect

Contribute database-specific Java, JDBC, DDL, and basic type descriptors.

Override this method when the database or JDBC driver requires descriptors beyond the inherited registrations. Invoke super first unless the Dialect intentionally replaces the complete inherited contribution protocol. Obtain reusable dialect-specific JDBC descriptors from the family facades in org.hibernate.dialect.type.spi, and preserve whether a descriptor replaces an existing registration or is added only when absent.

Overrides:

contributeTypes in class Dialect

Parameters:

typeContributions - the Hibernate-supplied contribution registry

serviceRegistry -

the Hibernate-supplied services, including class loading used by driver-backed descriptor factories

Mutate the supplied boot-scoped registries only during this callback and do not retain the contribution context or a mutable registry afterward. Implement an independent TypeContributor instead when the contribution is not owned by a Dialect.

getAggregateSupport

@SPI({IMPLEMENT,SUPPLY})
public AggregateSupport getAggregateSupport()

Description copied from class: Dialect

Supply the aggregate-column mapping, DDL, read, assignment, and write behavior for this dialect. Override this method to return a provider implementation of AggregateSupport, or retain the standard behavior returned by the default.

Overrides:

getAggregateSupport in class Dialect

Returns:

this dialect's aggregate support

See Also:

• AggregateSupport

getNativeValueGenerationStrategy

public GenerationType getNativeValueGenerationStrategy()

Description copied from class: Dialect

Supply the semantic identifier-generation type used for native generation.

Return a non-null typed value instead of a legacy generator name or implementation class. The inherited implementation selects GenerationType.IDENTITY when this Dialect's IdentityColumnSupport supports identity columns and GenerationType.SEQUENCE otherwise. Override it when the database's native choice differs from that rule.

Legacy "native" mappings and NativeGenerator consume this same provider decision.

Overrides:

getNativeValueGenerationStrategy in class Dialect

Returns:

the non-null semantic native identifier-generation type

See Also:

• NativeGenerator

getIdentityColumnSupport

public IdentityColumnSupport getIdentityColumnSupport()

Description copied from class: Dialect

Supply the stable identity-column DDL, insert syntax, and identity-specific retrieval behavior for this Dialect.

Override this method to supply a provider implementation of IdentityColumnSupport. Prefer extending IdentityColumnSupportBase and return the same immutable or otherwise stable support instance on every invocation. Do not construct Hibernate mutation delegates in this supply point.

Overrides:

getIdentityColumnSupport in class Dialect

getLimitHandler

public LimitHandler getLimitHandler()

Description copied from class: Dialect

Supplies execution-time pagination for already-rendered SQL requested by Query.setMaxResults(int) or Query.setFirstResult(int).

This is distinct from SQL AST PaginationRenderingSupport, which handles offset and fetch clauses represented in the semantic tree. A custom Dialect should normally return a stock LimitHandler or extend a supported handler family. The returned handler may be reused concurrently and must not retain per-query state.

Overrides:

getLimitHandler in class Dialect

Returns:

a non-null handler

getCurrentTimestampSelection

@SPI({USE,IMPLEMENT})
public CurrentTimestampSelection getCurrentTimestampSelection()

Description copied from interface: CurrentTemporalSupport

Select the JDBC command used for database-side current timestamp retrieval, or return null when the database offers no supported command.

Specified by:

getCurrentTimestampSelection in interface CurrentTemporalSupport

See Also:

• CurrentTimestampSelection

getValuesListSupport

public ValuesListSupport getValuesListSupport()

Description copied from class: Dialect

The contexts in which this Dialect supports native multi-row values syntax.

The returned immutable profile must be non-null and stable for the lifetime of this Dialect. Report only native syntax support; translator emulation is selected separately.

Overrides:

getValuesListSupport in class Dialect

getLobSupport

@SPI({IMPLEMENT,SUPPLY})
public LobSupport getLobSupport()

Description copied from class: Dialect

Supply the database and driver policy for LOB creation, binding, materialization, type classification, mutation ordering, and VALUE LOB DDL. Return one stable, thread-safe strategy for this Dialect.

Overrides:

getLobSupport in class Dialect

Returns:

the non-null LOB support strategy

See Also:

• LobSupport

addColumnPrefix

@SPI({USE,IMPLEMENT})
public String addColumnPrefix()

Specified by:

addColumnPrefix in interface AlterTableSupport

getIfExistsSupport

@SPI({IMPLEMENT,SUPPLY})
public IfExistsSupport getIfExistsSupport()

Description copied from class: Dialect

Supply existence-check placement for schema DDL targets.

Return one immutable profile for this Dialect's lifetime.

Overrides:

getIfExistsSupport in class Dialect

See Also:

• IfExistsSupport

getSchemaDropSupport

@SPI({IMPLEMENT,SUPPLY})
public SchemaDropSupport getSchemaDropSupport()

Description copied from class: Dialect

Supply schema-drop composition and ordered pre-drop commands.

Return one immutable profile for this Dialect's lifetime.

Overrides:

getSchemaDropSupport in class Dialect

See Also:

• SchemaDropSupport

alterColumnType

@SPI({USE,IMPLEMENT})
public String alterColumnType(AlterColumnTypeRequest request)

Specified by:

alterColumnType in interface AlterTableSupport

getSequenceSupport

@SPI({IMPLEMENT,SUPPLY})
public SequenceSupport getSequenceSupport()

Description copied from class: Dialect

Supplies the complete sequence value-expression and lifecycle-DDL strategy for this Dialect.

Return the same stable, thread-safe strategy for the Dialect's lifetime. Use SequenceSupports.none() when sequences are unsupported, select one of the other stock strategies only when its complete grammar matches the database, or supply a provider implementation of SequenceSupport.

Overrides:

getSequenceSupport in class Dialect

Returns:

the non-null sequence-support strategy

See Also:

• SequenceSupport

getTableExporter

public Exporter<Table> getTableExporter()

Description copied from class: Dialect

Supply the exporter used to create and drop relational tables.

Return one stable exporter owned by this Dialect. Prefer StandardTableExporter when only its focused table-DDL template hooks are needed.

Overrides:

getTableExporter in class Dialect

getSequenceInformationExtractor

public SequenceInformationExtractor getSequenceInformationExtractor()

Description copied from class: Dialect

Supply the strategy Hibernate uses to discover existing database sequences and their metadata.

Return SequenceInformationExtractors.none() when the database version does not expose sequence metadata. Configure ordinary single-query extraction with SequenceInformationExtractors.builder(String), and implement SequenceInformationExtractor directly only for a genuinely multi-stage algorithm.

Overrides:

getSequenceInformationExtractor in class Dialect

See Also:

• SequenceInformationExtractor
• SequenceInformationExtractors

getViolatedConstraintNameExtractor

@SPI({IMPLEMENT,SUPPLY})
public ViolatedConstraintNameExtractor getViolatedConstraintNameExtractor()

Description copied from class: Dialect

Supplies the extractor used to recover violated constraint names from database exceptions.

The extractor returns null when a name cannot be recovered. Do not use an empty string or sentinel to represent absence.

Specified by:

getViolatedConstraintNameExtractor in interface ConversionContext

Overrides:

getViolatedConstraintNameExtractor in class Dialect

Returns:

the non-null constraint-name extractor

See Also:

• ViolatedConstraintNameExtractor

buildSQLExceptionConversionDelegate

@SPI({IMPLEMENT,SUPPLY})
public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate()

Description copied from class: Dialect

Supplies vendor-specific SQL-exception conversion for this Dialect.

The returned delegate runs in addition to Hibernate's standard JDBC exception-hierarchy and SQL-state delegates. Its null result means that it declined the exception so conversion may continue. Return null from this method when the Dialect has no vendor-specific delegate.

Prefer stable vendor error codes or SQL states and preserve the original SQLException.

Overrides:

buildSQLExceptionConversionDelegate in class Dialect

Returns:

the vendor conversion delegate, or null when none is supplied

See Also:

• SQLExceptionConversionDelegate

getSchemaCommentSupport

@SPI({IMPLEMENT,SUPPLY})
public SchemaCommentSupport getSchemaCommentSupport()

Description copied from class: Dialect

Supply schema-export support for comments attached to database objects.

This strategy does not control query comments, hints, SQL AST decoration, or statement inspection. Return one stable, non-null strategy.

Overrides:

getSchemaCommentSupport in class Dialect

See Also:

• SchemaCommentSupport

getSubquerySupport

public SubquerySupport getSubquerySupport()

Description copied from class: Dialect

Supplies the database's supported subquery placements.

Return one non-null, immutable profile whose values remain stable for this Dialect's lifetime. Declare every placement independently. In particular, scalar subqueries in the select list and exists predicates in the select list are separate capabilities. Lateral spelling and fallback rendering remain translator responsibilities. When refining a family Dialect, start from SubquerySupport.builder(super.getSubquerySupport()) and change only the differing placements.

Overrides:

getSubquerySupport in class Dialect

Returns:

this Dialect's stable subquery-support profile

getParameterLimits

public ParameterLimits getParameterLimits()

Description copied from class: Dialect

Supplies the database limits for IN-expression elements and total JDBC statement parameters.

Return a non-null, immutable profile whose values remain stable for this Dialect's lifetime. Use ParameterLimits.UNLIMITED when neither limit applies and ParameterLimits.of(int) when both limits are identical. Keep the dimensions independent when the database imposes different expression and statement limits; Hibernate uses them for different planning decisions.

Overrides:

getParameterLimits in class Dialect

Returns:

the non-null parameter-limit profile

getStringValueSemantics

@SPI({IMPLEMENT,SUPPLY})
public StringValueSemantics getStringValueSemantics()

Description copied from class: Dialect

Supply the database's stable string-value semantics.

Overrides:

getStringValueSemantics in class Dialect

Returns:

the non-null string-value profile

See Also:

• StringValueSemantics

getLocalTemporaryTableStrategy

public TemporaryTableStrategy getLocalTemporaryTableStrategy()

Description copied from class: Dialect

Supplies this Dialect's local temporary-table strategy.

Return null when the database has no supported local temporary-table form. A non-null strategy must be stable for the Dialect lifetime and consistent with Dialect.getTemporaryTableExporter().

Overrides:

getLocalTemporaryTableStrategy in class Dialect

getGlobalTemporaryTableStrategy

public TemporaryTableStrategy getGlobalTemporaryTableStrategy()

Description copied from class: Dialect

Supplies this Dialect's global temporary-table strategy.

Return null when the database has no supported global temporary-table form. A non-null strategy must be stable for the Dialect lifetime and consistent with Dialect.getTemporaryTableExporter().

Overrides:

getGlobalTemporaryTableStrategy in class Dialect

getMultiTableMutationSupport

public MultiTableMutationSupport getMultiTableMutationSupport()

Description copied from class: Dialect

Select the Hibernate-owned fallback families used for SQM update/delete and insert operations targeting entities mapped to multiple tables.

A custom Dialect should return one of the named profiles when both operation families use the same strategy kind, or construct an asymmetric profile when they differ. Local, global, and persistent-table selections require the corresponding non-null temporary-table strategy, while CTE requires non-query CTE support.

Configured global and entity-specific custom strategies take precedence over this fallback. Supply a custom execution implementation with QuerySettings.QUERY_MULTI_TABLE_MUTATION_STRATEGY or QuerySettings.QUERY_MULTI_TABLE_INSERT_STRATEGY instead of depending on Hibernate's internal fallback implementations.

Overrides:

getMultiTableMutationSupport in class Dialect

Returns:

a stable, non-null fallback selection profile

getQueryHintString

@SPI({USE,IMPLEMENT})
public String getQueryHintString(String query,
 List<String> hintList)

Description copied from class: Dialect

Apply a hint to the given SQL query.

The entire query is provided, allowing full control over the placement and syntax of the hint.

By default, ignore the hint and simply return the query.

Overrides:

getQueryHintString in class Dialect

Parameters:

query - The query to which to apply the hint.

hintList - The hints to apply

Returns:

The modified SQL

getQueryHintString

@SPI({USE,IMPLEMENT})
public String getQueryHintString(String sql,
 String hints)

Description copied from class: Dialect

Apply a hint to the given SQL query.

The entire query is provided, allowing full control over the placement and syntax of the hint.

By default, ignore the hint and simply return the query.

Overrides:

getQueryHintString in class Dialect

Parameters:

sql - The query to which to apply the hint.

hints - The hints to apply

Returns:

The modified SQL

getMaxAliasLength

@SPI({USE,IMPLEMENT})
public int getMaxAliasLength()

Description copied from interface: IdentifierSupport

Return the safe maximum length of a generated SQL alias, including room for Hibernate's generated suffix.

Specified by:

getMaxAliasLength in interface IdentifierSupport

getMaxIdentifierLength

@SPI({USE,IMPLEMENT})
public int getMaxIdentifierLength()

Description copied from interface: IdentifierSupport

Return the database's maximum identifier length.

Specified by:

getMaxIdentifierLength in interface IdentifierSupport

getCallableStatementSupport

@SPI({IMPLEMENT,SUPPLY})
public CallableStatementSupport getCallableStatementSupport()

Description copied from class: Dialect

Supply the callable-statement protocol for this database and JDBC driver.

Return one non-null strategy whose behavior remains stable for this Dialect's lifetime. Use CallableStatementSupports for the standard and stock database protocols.

Overrides:

getCallableStatementSupport in class Dialect

Returns:

the callable-statement strategy

See Also:

• CallableStatementSupport

getRefCursorSupportFactory

@SPI({IMPLEMENT,SUPPLY})
public RefCursorSupportFactory getRefCursorSupportFactory()

Description copied from class: Dialect

Supply the stable factory which creates this Dialect's JDBC REF_CURSOR registration and extraction service.

Return one non-null factory whose identity and selection behavior remain stable for this Dialect's lifetime. This factory controls JDBC cursor access; Dialect.getCallableStatementSupport() independently controls whether and how the callable SQL protocol admits a REF_CURSOR parameter.

Overrides:

getRefCursorSupportFactory in class Dialect

Returns:

the REF_CURSOR JDBC access factory

See Also:

• RefCursorSupportFactory

getNamespaceSupport

@SPI({IMPLEMENT,SUPPLY})
public NamespaceSupport getNamespaceSupport()

Description copied from class: Dialect

Supply catalog and schema lifecycle behavior to schema tooling.

Return one stable, non-null strategy. Prefer a complete immutable profile from NamespaceSupports, and implement NamespaceSupport directly only for custom or multi-command namespace SQL.

Overrides:

getNamespaceSupport in class Dialect

See Also:

• NamespaceSupport

getTupleCountSupport

public TupleCountSupport getTupleCountSupport()

Description copied from class: Dialect

Supplies the database syntax for ordinary and distinct tuple counts.

Return one non-null, immutable profile whose values remain stable for this Dialect's lifetime. Select TupleCountSupport.Syntax.UNSUPPORTED to use Hibernate's existing emulation, TupleCountSupport.Syntax.ARGUMENT_LIST for syntax such as count(a, b), or TupleCountSupport.Syntax.PARENTHESIZED_TUPLE for syntax such as count((a, b)). Configure the ordinary and distinct forms independently; a database may require different forms for them. When refining a family Dialect, copy Dialect.getTupleCountSupport() from the superclass and replace only the differing syntax choice.

Overrides:

getTupleCountSupport in class Dialect

Returns:

the non-null tuple-count-syntax profile

getFetchClauseSupport

@SPI({USE,IMPLEMENT,SUPPLY})
public FetchClauseSupport getFetchClauseSupport()

Description copied from class: Dialect

Supply the fetch clause forms accepted by this database.

Return one non-null immutable profile whose identity and answers remain stable for this Dialect's lifetime. The four forms are independent; do not infer percent or ties support from ordinary row-count support.

Overrides:

getFetchClauseSupport in class Dialect

Returns:

the stable fetch clause capability profile

See Also:

• FetchClauseSupport

getWindowFunctionSupport

public WindowFunctionSupport getWindowFunctionSupport()

Description copied from class: Dialect

Supplies the native window-function syntax supported by this database.

Return one non-null, immutable profile whose values remain stable for this Dialect's lifetime. Baseline window calls, window partitioning, each frame unit, and frame exclusion are independent grammar facts. Every refinement requires baseline window support, and frame exclusion additionally requires a supported frame unit. Function-specific restrictions and individual frame-bound restrictions remain the responsibility of focused rendering.

When refining a family Dialect, start from WindowFunctionSupport.builder(super.getWindowFunctionSupport()) and change only the differing features.

Overrides:

getWindowFunctionSupport in class Dialect

Returns:

this Dialect's stable window-function-support profile

getCteSupport

public CteSupport getCteSupport()

Description copied from class: Dialect

The common-table-expression capabilities of this Dialect.

The returned immutable profile must be non-null and stable for the lifetime of this Dialect. Hibernate may cache and reuse it. Overrides may construct a new profile or copy CteSupport.STANDARD; invoking super is not required. This method is called only after Dialect construction, has no corresponding shutdown lifecycle, and failures propagate to the operation which obtains the profile.

Overrides:

getCteSupport in class Dialect

getLockingSupport

public LockingSupport getLockingSupport()

Description copied from class: Dialect

Supplies the cohesive pessimistic-locking profile for this Dialect.

The profile coordinates capability metadata, statement-clause rendering, table hints, already-rendered SQL rewriting, connection timeout handling, and follow-on locking. A custom Dialect should supply one internally consistent profile instead of overriding those behaviors independently. The returned support must be non-null and stable for the Dialect lifetime; its components may be reused concurrently and must not retain per-query requests.

Overrides:

getLockingSupport in class Dialect

See Also:

• LockingSupport

appendDateTimeLiteral

@SPI({USE,IMPLEMENT})
public void appendDateTimeLiteral(SqlAppender appender,
 TemporalAccessor temporalAccessor,
 TemporalType precision,
 TimeZone jdbcTimeZone)

Description copied from class: Dialect

Append a datetime literal for a java.time value.

Preserve the value's offset only when the Dialect's temporal-value semantics permit it. Append immediately and retain no invocation state.

Specified by:

appendDateTimeLiteral in interface LiteralSupport

Overrides:

appendDateTimeLiteral in class Dialect

appendFormat

@SPI({USE,IMPLEMENT})
public void appendFormat(SqlAppender appender,
 String format)

Description copied from interface: TemporalFormatSupport

Append the database translation of the supplied Hibernate format pattern.

Specified by:

appendFormat in interface TemporalFormatSupport

datetimeFormat

public static Replacer datetimeFormat(String format,
 boolean useFm,
 boolean resetFm)

appendBinaryLiteral

@SPI({USE,IMPLEMENT})
public void appendBinaryLiteral(SqlAppender appender,
 byte[] bytes)

Description copied from interface: LiteralSupport

Append a SQL binary literal.

Specified by:

appendBinaryLiteral in interface LiteralSupport

appendDefinition

@SPI({USE,IMPLEMENT})
public void appendDefinition(SqlAppender appender,
 ColumnDefinitionRequest request)

Specified by:

appendDefinition in interface ColumnDefinitionSupport

buildIdentifierHelper

@SPI({USE,IMPLEMENT,SUPPLY})
public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuildRequest request)

Description copied from interface: IdentifierSupport

Build and supply the configured identifier helper from the stable JDBC metadata snapshot and selected keyword strategy.

This inherited implementation initializes identifier casing, keywords, and namespace support from the request. Invoke it before replacing any of those values with authoritative provider settings, then build the final helper from the same builder. Settings which this implementation does not initialize may be applied before invoking it. If builder configuration cannot express a database rule, decorate the final helper with DelegatingIdentifierHelper. Do not retain the request, builder, or metadata view.

Specified by:

buildIdentifierHelper in interface IdentifierSupport

See Also:

• IdentifierHelper

constraintControlMode

@SPI({USE,IMPLEMENT})
public ConstraintControlMode constraintControlMode()

Specified by:

constraintControlMode in interface ConstraintControlSupport

Overrides:

constraintControlMode in class Dialect

disableConstraintCommands

@SPI({USE,IMPLEMENT})
public List<String> disableConstraintCommands(ConstraintControlRequest request)

Specified by:

disableConstraintCommands in interface ConstraintControlSupport

enableConstraintCommands

@SPI({USE,IMPLEMENT})
public List<String> enableConstraintCommands(ConstraintControlRequest request)

Specified by:

enableConstraintCommands in interface ConstraintControlSupport

getUniqueDelegate

@SPI({IMPLEMENT,SUPPLY})
public UniqueDelegate getUniqueDelegate()

Description copied from class: Dialect

Supply the stable strategy used for unique-key representation and DDL.

Return a stock profile from UniqueDelegates, or a stable provider-owned implementation or decorator. Do not import a Hibernate .internal leaf.

Overrides:

getUniqueDelegate in class Dialect

See Also:

• UniqueDelegate

getRowIdSupport

@SPI({IMPLEMENT,SUPPLY})
public RowIdSupport getRowIdSupport()

Description copied from class: Dialect

Supply the database's row-locator expression, JDBC type, and optional physical-column declaration policy.

Overrides:

getRowIdSupport in class Dialect

Returns:

the stable non-null row-id strategy

See Also:

• RowIdSupport

createOptionalTableUpdateOperation

@SPI({USE,IMPLEMENT,SUPPLY})
public MutationOperation createOptionalTableUpdateOperation(OptionalTableUpdateOperationRequest request)

Description copied from class: Dialect

Creates the JDBC mutation operation for an optional-table update.

Override this factory when the database needs an operation other than the standard update-then-insert behavior. The request contains the semantic update and bootstrap services; implementations must return an operation for the same OptionalTableUpdateOperationRequest.mutationTarget() and must not retain the request.

Overrides:

createOptionalTableUpdateOperation in class Dialect

Returns:

a non-null operation for the supplied optional-table update

See Also:

• OptionalTableUpdateOperationRequest
• MutationOperation

getDmlTargetColumnQualifierSupport

@SPI({USE,IMPLEMENT,SUPPLY})
public DmlTargetColumnQualifierSupport getDmlTargetColumnQualifierSupport()

Description copied from class: Dialect

The qualifier form accepted for target-column references in update and delete statements.

Translators use this value when rendering assignments and predicates. A custom Dialect should return the least permissive form required by the database, not a form used only by an emulation.

Overrides:

getDmlTargetColumnQualifierSupport in class Dialect

Returns:

the non-null target-column qualifier support

See Also:

• DmlTargetColumnQualifierSupport

getMutationSyntaxSupport

public MutationSyntaxSupport getMutationSyntaxSupport()

Description copied from class: Dialect

The native SQL mutation-syntax capabilities of this Dialect.

The returned immutable profile must be non-null and stable for the lifetime of this Dialect. Report syntax which the translator may use directly; do not report a capability merely because it can be emulated. QueryMutationRenderingSupport consumes this profile when selecting a native or emulated plan.

Overrides:

getMutationSyntaxSupport in class Dialect

getDriverMajorVersion

public int getDriverMajorVersion()

getDriverMinorVersion

public int getDriverMinorVersion()

getEnumSupport

@SPI({IMPLEMENT,SUPPLY})
public EnumSupport getEnumSupport()

Description copied from class: Dialect

Supply the database's finite-domain declaration, lifecycle, and check strategy. Return one stable, thread-safe strategy for this Dialect.

Overrides:

getEnumSupport in class Dialect

Returns:

the non-null enum support strategy

See Also:

• EnumSupport

getCreateVarcharEnumTypeCommand

public static String[] getCreateVarcharEnumTypeCommand(String name,
 String[] values)

Used to generate the CREATE DDL command for Data Use Case Domain based on VARCHAR2 values.

Returns:

the DDL command to create that enum

render

@SPI({USE,IMPLEMENT})
public String render(CheckConstraintRenderRequest request)

Specified by:

render in interface CheckConstraintSupport

getSingleRowTableSupport

public SingleRowTableSupport getSingleRowTableSupport()

Description copied from class: Dialect

Supply the SQL renderings used for a reusable single-row table and for an otherwise table-less select.

Override this method with one stable, non-null profile when either rendering differs from SingleRowTableSupport.STANDARD. The table expression and the complete select-only from fragment are independent; an empty fragment means that no from clause is required. Dialect subclasses refining a family profile should copy Dialect.getSingleRowTableSupport() from the superclass and change only the values which differ.

Overrides:

getSingleRowTableSupport in class Dialect

Returns:

the stable, non-null single-row-table-support profile

getSetOperationSupport

public SetOperationSupport getSetOperationSupport()

Description copied from class: Dialect

Supplies the database's set operators and structural query-group capabilities.

Return one non-null, immutable profile whose values remain stable for this Dialect's lifetime. Declare each SetOperator independently; support for a distinct operator never implies its ALL form. Structural capabilities such as UNION placement in subqueries are separate from operator support. Continue to override Dialect.getSetOperatorSqlString(SetOperator) when an operator requires database-specific spelling. When refining a family Dialect, start from SetOperationSupport.builder(super.getSetOperationSupport()) and change only the differing values.

Overrides:

getSetOperationSupport in class Dialect

Returns:

this Dialect's stable set-operation profile

getSetOperatorSqlString

@SPI({USE,IMPLEMENT})
public String getSetOperatorSqlString(SetOperator setOperator)

Description copied from class: Dialect

Get the SQL string representation for a specific set operator (UNION, INTERSECT, EXCEPT).

The default implementation delegates to SetOperator.sqlString(). Dialects like Cloud Spanner that require explicit 'DISTINCT' keywords can override this.

Overrides:

getSetOperatorSqlString in class Dialect

Parameters:

setOperator - The set operator

Returns:

The SQL fragment (e.g., "union", "union all", "union distinct")

getRowValueSupport

public RowValueSupport getRowValueSupport()

Description copied from class: Dialect

The native row-value syntax of this Dialect.

Override this method to supply explicit row(a, b) construction, row equality, ordering, and distinctness comparisons, row-valued IN lists, row-valued IN subqueries, and quantified row comparisons. Treat each feature as an exact native-syntax declaration: do not infer IN-subquery support from IN-list support or explicit row construction from comparison support. Copy the superclass profile when refining an inherited Dialect family. Return one immutable, non-null profile whose values remain stable for the lifetime of this Dialect.

Overrides:

getRowValueSupport in class Dialect

Returns:

this Dialect's stable row-value-support profile

getInformationExtractor

@SPI({IMPLEMENT,SUPPLY})
public InformationExtractor getInformationExtractor(ExtractionContext extractionContext)

Description copied from class: Dialect

Supply the context-bound strategy Hibernate uses to discover database tables, keys, indexes, and related schema metadata.

Return a new extractor for extractionContext. Prefer a stock profile from InformationExtractors, and implement InformationExtractor directly only when none of those complete profiles matches the database.

Overrides:

getInformationExtractor in class Dialect

See Also:

• InformationExtractor
• InformationExtractors

getTemporalTableSupport

@SPI({IMPLEMENT,SUPPLY})
public TemporalTableSupport getTemporalTableSupport()

Description copied from class: Dialect

Supplies the complete temporal-table DDL and historical-query strategy for this Dialect.

Return an immutable strategy and use the supported request values without retaining them. Prefer TemporalTableSupports.standard(int, int, boolean) when only the column type, precision, and table-check capability differ.

Overrides:

getTemporalTableSupport in class Dialect

Returns:

the non-null temporal-table support strategy

See Also:

• TemporalTableSupport

throttleDdl

public boolean throttleDdl()

Description copied from class: Dialect

Whether schema-management DDL commands require a short delay before execution to accommodate database-side propagation.

Overrides:

throttleDdl in class Dialect