Class HANADialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.HANADialect

All Implemented Interfaces:

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

Direct Known Subclasses:

HANASpatialDialect

public class HANADialect
extends Dialect
implements CurrentTemporalSupport, TemporalFormatSupport, TemporalOperationSupport

An SQL dialect for the SAP HANA Platform and Cloud.

• For more information on SAP HANA Cloud, refer to the SAP HANA Cloud SQL Reference Guide.
• For more information on SAP HANA Platform, refer to the SAP HANA Platform SQL Reference Guide.

Column tables are created by this dialect by default when using the auto-DDL feature.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HANADialect.HANABlobType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	USE_DEFAULT_TABLE_TYPE_COLUMN

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
HANADialect()
HANADialect(DatabaseVersion version)
HANADialect(DatabaseVersion version, boolean defaultTableTypeColumn)
HANADialect(HANAServerConfiguration configuration, boolean defaultTableTypeColumn)
HANADialect(DialectResolutionInfo info)

Method Summary

Modifier and Type	Method	Description
String	addColumnPrefix()
String	addColumnSuffix()
String	alterColumnType(AlterColumnTypeRequest request)
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	appendDateTimeLiteral(SqlAppender appender, Date date, TemporalType precision, TimeZone jdbcTimeZone)	Append a datetime literal for a legacy Date 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)	Obtain a pattern for the SQL equivalent to a cast() function call.
boolean	causesRollback(SQLException sqlException)	Determine whether this database marks the current transaction for rollback after the given statement failure.
protected String	columnType(int sqlTypeCode)	Return the complete database column declaration pattern for a JDBC Types or Hibernate SqlTypes code used during type registration.
protected void	contributeDefaultProperties(Properties properties)	Contribute provider configuration defaults after Dialect construction.
protected void	contributeKeywords(KeywordRegistration registration)	Contribute ANSI and database-specific SQL keywords.
void	contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)	Contribute database-specific Java, JDBC, DDL, and basic type descriptors.
String	createTableCommand(TableCreationKind kind)
ScrollMode	defaultScrollMode()	A default ScrollMode to be used by Query.scroll().
DatabaseVersion	determineDatabaseVersion(DialectResolutionInfo info)	Determine the database version, as precise as possible and using Dialect-specific techniques, from a DialectResolutionInfo object.
String	extractPattern(TemporalUnit unit)	HANA has no extract() function, but we can emulate it using the appropriate named functions instead of extract().
long	fractionalSecondPrecisionInNanos()	The number of nanoseconds represented by one native fractional-second unit used for datetime arithmetic.
AggregateSupport	getAggregateSupport()	Supply the aggregate-column mapping, DDL, read, assignment, and write behavior for this dialect.
CallableStatementSupport	getCallableStatementSupport()	Supply the callable-statement protocol for this database and JDBC driver.
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.
DirectJavaTimeJdbcSupport	getDirectJavaTimeJdbcSupport()	Supply direct JDBC access capabilities for Java Time classes.
DmlTargetColumnQualifierSupport	getDmlTargetColumnQualifierSupport()	The qualifier form accepted for target-column references in update and delete statements.
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.
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.
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()	HANA doesn't support the generate_series function or lateral recursive CTEs, so it has to be emulated with the xmltable and lpad functions.
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.
NameQualifierSupport	getNameQualifierSupport()	Supply catalog and schema qualification support, or return null to use DatabaseMetaData.
NamespaceSupport	getNamespaceSupport()	Supply catalog and schema lifecycle behavior to schema tooling.
NullOrderingSupport	getNullOrderingSupport()	Supply the database's default null ordering and explicit null-precedence syntax capabilities.
int	getPreferredSqlTypeCodeForArray()	Select the default SqlTypes code for a basic Java array or collection.
String	getQueryHintString(String query, List<String> hints)	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.
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.
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.
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.
TemporalValueSemantics	getTemporalValueSemantics()	Supply temporal precision-adjustment and literal-offset semantics.
TypeSizingProfile	getTypeSizingProfile()	Supplies this Dialect's resolved type-sizing limits and defaults.
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	isCloud()
protected boolean	isDefaultTableTypeColumn()
boolean	isUseUnicodeStringTypes()
protected void	registerColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)	Register the inherited ANSI-oriented DDL type descriptors during Dialect type contribution.
boolean	supports(CheckConstraintPlacement placement)	HANA currently does not support check constraints.
protected boolean	supportsAsciiStringTypes()
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.
protected Boolean	useUnicodeStringTypesDefault()

Methods inherited from class Dialect

addPartitionKeyToPrimaryKey, appendArrayLiteral, appendDateTimeLiteral, augmentPhysicalTableTypes, augmentRecognizedTableTypes, buildLockingClauseStrategy, buildStringToBooleanCast, buildStringToBooleanCastDecode, castType, constraintControlMode, createOptionalTableUpdateOperation, equivalentTypes, getAlterTableSupport, getArraySupport, getArrayTypeName, getBatchLoadSizingStrategy, getCatalogSeparator, getCheckConstraintSupport, getColumnAliasExtractor, getColumnDefinitionSupport, getConstraintControlSupport, getDefaultOrdinalityColumnName, getDefaultProperties, getEntityLockingStrategyFactory, getEnumSupport, getExpressionCoercionSupport, getFetchClauseSupport, getForeignKeyExporter, getForeignKeySupport, getFunctionalDependencyAnalysisSupport, getGeneratedValuesSupport, getIdentifierSupport, getIfExistsSupport, getIndexDdlSupport, getIndexExporter, getInformationExtractor, getJdbcMetadataOverrides, getKeywords, getKeywordSupport, getLiteralSupport, getLobMergeStrategy, getLocalTemporaryTableStrategy, getLockingClauseStrategy, getLowercaseFunction, getMultiKeyLoadSizingStrategy, getNationalizationSupport, getNativeParameterMarkerStrategy, getNativeValueGenerationStrategy, getObjectNullBindingStrategy, getParameterLimits, getPersistentTemporaryTableStrategy, getPredicateSupport, getPreferredSqlTypeCodeForBoolean, getQueryHintPlacement, getQueryHintString, getRowIdSupport, getRowLevelSecurity, getSchemaNameResolver, getSelectClauseNullString, getSequenceExporter, getSetOperationSupport, getSetOperatorSqlString, getSizeStrategy, getStringValueSemantics, getSyntheticTableGroupSupport, getTableCleaner, getTableCreationSupport, getTableMigrator, getTemporalTableSupport, getTemporaryTableExporter, getTimeZoneSupport, getTruncateSupport, getTupleCountSupport, getUniqueDelegate, getUserDefinedTypeExporter, getVersion, isJdbcLogWarningsEnabledByDefault, narrowCastType, resolveSqlTypeCode, resolveSqlTypeCode, resolveSqlTypeDescriptor, resolveSqlTypeLength, supportsCrossJoin, supportsFilterClause, supportsNationalizedMethods, supportsOrdinalSelectItemReference, supportsUserDefinedTypes, throttleDdl, toString, trimPattern, truncateMode

Methods inherited from class Object

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

Methods inherited from interface AlterTableSupport

alterTableCommand

Methods inherited from interface CheckConstraintSupport

render

Methods inherited from interface ConstraintControlSupport

disableCommands, disableConstraintCommands, enableCommands, enableConstraintCommands

Methods inherited from interface CurrentTemporalSupport

currentDate, currentLocalTime, currentLocalTimestamp, currentTime, currentTimestamp, currentTimestampWithTimeZone, 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

appendBinaryLiteral, appendIntervalLiteral, appendIntervalLiteral, appendLiteral, appendUUIDLiteral, toBooleanValueString

Methods inherited from interface TableCreationSupport

requiresViewColumnList, tableCreationOptions

Methods inherited from interface TemporalOperationSupport

translateDurationField, translateExtractField

Methods inherited from interface TruncateSupport

renderCommands

Field Details

USE_DEFAULT_TABLE_TYPE_COLUMN

public static final String USE_DEFAULT_TABLE_TYPE_COLUMN

See Also:

• Constant Field Values

Constructor Details

HANADialect

public HANADialect(DialectResolutionInfo info)

HANADialect

public HANADialect()

HANADialect

public HANADialect(DatabaseVersion version)

HANADialect

public HANADialect(DatabaseVersion version,
 boolean defaultTableTypeColumn)

HANADialect

public HANADialect(HANAServerConfiguration configuration,
 boolean defaultTableTypeColumn)

Method Details

getDirectJavaTimeJdbcSupport

public DirectJavaTimeJdbcSupport getDirectJavaTimeJdbcSupport()

Description copied from class: Dialect

Supply direct JDBC access capabilities for Java Time classes. Return one stable, non-null, thread-safe implementation.

Overrides:

getDirectJavaTimeJdbcSupport in class Dialect

Returns:

the direct Java Time JDBC support for this Dialect and driver

See Also:

• DirectJavaTimeJdbcSupport

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

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

determineDatabaseVersion

@SPI({USE,IMPLEMENT})
public DatabaseVersion determineDatabaseVersion(DialectResolutionInfo info)

Description copied from class: Dialect

Determine the database version, as precise as possible and using Dialect-specific techniques, from a DialectResolutionInfo object.

This method is called during superclass construction by Dialect(DialectResolutionInfo). Implementations must not depend on subclass initialization. Integration providers may also invoke this method on an existing Dialect when database metadata becomes available after the Dialect was constructed.

Overrides:

determineDatabaseVersion in class Dialect

Parameters:

info - The dialect resolution info that would be passed by Hibernate ORM to the constructor of a Dialect of the same type.

Returns:

The corresponding database version.

isDefaultTableTypeColumn

protected boolean isDefaultTableTypeColumn()

isCloud

public boolean isCloud()

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()

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

castPattern

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

Description copied from class: Dialect

Obtain a pattern for the SQL equivalent to a cast() function call. The resulting pattern must contain ?1 and ?2 placeholders for the arguments.

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

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

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

getMaximumSeriesSize

protected int getMaximumSeriesSize()

HANA doesn't support the generate_series function or lateral recursive CTEs, so it has to be emulated with the xmltable and lpad functions.

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()

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

extractPattern

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

HANA has no extract() function, but we can emulate it using the appropriate named functions instead of extract(). The supported fields are TemporalUnit.YEAR, TemporalUnit.MONTH TemporalUnit.DAY, TemporalUnit.HOUR, TemporalUnit.MINUTE, TemporalUnit.SECOND TemporalUnit.WEEK, TemporalUnit.DAY_OF_WEEK, TemporalUnit.DAY_OF_MONTH, TemporalUnit.DAY_OF_YEAR.

Specified by:

extractPattern in interface TemporalOperationSupport

causesRollback

public boolean causesRollback(SQLException sqlException)

Description copied from class: Dialect

Determine whether this database marks the current transaction for rollback after the given statement failure.

Inspect the original database exception when the policy depends on its error code, SQL state, or subtype. This decision is independent of how Hibernate converts the exception. This determines both JDBC rollback state and whether a pessimistic lock failure becomes a JPA PessimisticLockException or LockTimeoutException.

Overrides:

causesRollback in class Dialect

Parameters:

sqlException - the original database exception

Returns:

true when the failed statement invalidates the transaction

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

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

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

createTableCommand

@SPI({USE,IMPLEMENT})
public String createTableCommand(TableCreationKind kind)

Specified by:

createTableCommand in interface TableCreationSupport

addColumnPrefix

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

Specified by:

addColumnPrefix in interface AlterTableSupport

addColumnSuffix

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

Specified by:

addColumnSuffix in interface AlterTableSupport

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

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

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

contributeKeywords

@SPI({USE,IMPLEMENT,SUPPLY})
protected void contributeKeywords(KeywordRegistration registration)

Description copied from class: Dialect

Contribute ANSI and database-specific SQL keywords.

Invoke super first to retain the SQL:2003 words. Omitting super deliberately replaces the inherited keyword profile. Register words only during this callback and do not retain the registration target.

Overrides:

contributeKeywords in class Dialect

Parameters:

registration - the scoped keyword target

defaultScrollMode

@SPI({USE,IMPLEMENT,SUPPLY})
public ScrollMode defaultScrollMode()

Description copied from class: Dialect

A default ScrollMode to be used by Query.scroll().

Overrides:

defaultScrollMode in class Dialect

Returns:

the default ScrollMode to use.

supports

@SPI({USE,IMPLEMENT})
public boolean supports(CheckConstraintPlacement placement)

HANA currently does not support check constraints.

Specified by:

supports in interface CheckConstraintSupport

getTemporalValueSemantics

@SPI({IMPLEMENT,SUPPLY})
public TemporalValueSemantics getTemporalValueSemantics()

Description copied from class: Dialect

Supply temporal precision-adjustment and literal-offset semantics. Return one stable, non-null immutable profile.

Overrides:

getTemporalValueSemantics in class Dialect

See Also:

• TemporalValueSemantics

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

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

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

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

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

getNameQualifierSupport

@SPI({IMPLEMENT,SUPPLY})
public NameQualifierSupport getNameQualifierSupport()

Description copied from class: Dialect

Supply catalog and schema qualification support, or return null to use DatabaseMetaData.

This value does not define the catalog separator; override Dialect.getCatalogSeparator() independently when the metadata-free fallback is not ..

Overrides:

getNameQualifierSupport in class Dialect

See Also:

• NameQualifierSupport

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

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

getQueryHintString

@SPI({USE,IMPLEMENT})
public String getQueryHintString(String query,
 List<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:

query - The query to which to apply the hint.

hints - The hints to apply

Returns:

The modified SQL

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

alterColumnType

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

Specified by:

alterColumnType in interface AlterTableSupport

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.

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

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

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

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

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

getNullOrderingSupport

public NullOrderingSupport getNullOrderingSupport()

Description copied from class: Dialect

Supply the database's default null ordering and explicit null-precedence syntax capabilities.

Override this method with a stable, non-null profile when the database's default null placement differs from NullOrderingSupport.STANDARD, or when it cannot render nulls first and nulls last natively. Dialect subclasses refining a family profile should copy Dialect.getNullOrderingSupport() from the superclass and change only the values which differ.

Overrides:

getNullOrderingSupport in class Dialect

Returns:

the stable, non-null null-ordering-support profile

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

fractionalSecondPrecisionInNanos

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

Description copied from interface: TemporalOperationSupport

The number of nanoseconds represented by one native fractional-second unit used for datetime arithmetic.

Return a positive power of ten no greater than 1_000_000_000, and keep the value consistent with TemporalOperationSupport.timestampaddPattern(TemporalUnit, TemporalType, IntervalType) and TemporalOperationSupport.timestampdiffPattern(TemporalUnit, TemporalType, TemporalType).

Specified by:

fractionalSecondPrecisionInNanos 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

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

appendDateTimeLiteral

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

Description copied from class: Dialect

Append a datetime literal for a legacy Date value.

Apply the supplied JDBC time zone where required, append immediately, and retain no invocation state.

Specified by:

appendDateTimeLiteral in interface LiteralSupport

Overrides:

appendDateTimeLiteral in class Dialect

appendDefinition

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

Specified by:

appendDefinition in interface ColumnDefinitionSupport

isUseUnicodeStringTypes

public boolean isUseUnicodeStringTypes()

supportsAsciiStringTypes

protected boolean supportsAsciiStringTypes()

useUnicodeStringTypesDefault

protected Boolean useUnicodeStringTypesDefault()

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

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

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

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

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

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

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

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