Class MySQLDialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.MySQLDialect

All Implemented Interfaces:

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

Direct Known Subclasses:

MariaDBDialect, MySQL56SpatialDialect, MySQL5SpatialDialect, MySQLSpatialDialect

@SPI({USE,IMPLEMENT})
public class MySQLDialect
extends Dialect
implements CurrentTemporalSupport, TemporalFormatSupport, TemporalOperationSupport

A SQL dialect for MySQL 8 and above.

Please refer to the MySQL documentation.

This class is also the supported family base for provider Dialects derived from MySQL. Provider subclasses must invoke a constructor classified IMPLEMENT. The generated SPI inventory identifies the constructors and members covered by this type-level implementation contract; unclassified implementation details are not provider extension points.

Since:

8.0

Field Summary

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
MySQLDialect()
MySQLDialect(DatabaseVersion version)
MySQLDialect(DatabaseVersion version, MySQLServerConfiguration serverConfiguration)
MySQLDialect(DialectResolutionInfo info)

Method Summary

Modifier and Type	Method	Description
boolean	addPartitionKeyToPrimaryKey()	Whether every table partition key must also occur in its primary key.
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, Calendar calendar, TemporalType precision, TimeZone jdbcTimeZone)	Append a datetime literal for a Calendar 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.
void	appendLiteral(SqlAppender appender, String literal)	Append a SQL string literal.
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.
protected String	castType(int sqlTypeCode)	Return the complete cast-target type pattern for sqlTypeCode.
boolean	causesRollback(SQLException sqlException)	Determine whether this database marks the current transaction for rollback after the given statement failure.
char	closeQuote()	Return the character which closes a quoted identifier.
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	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.
MutationOperation	createOptionalTableUpdateOperation(OptionalTableUpdateOperationRequest request)	Creates the JDBC mutation operation for an optional-table update.
protected static DatabaseVersion	createVersion(DialectResolutionInfo info, DatabaseVersion defaultVersion)
String	currentTimestamp()	MySQL 5.7 precision defaults to seconds, but microseconds is better
static Replacer	datetimeFormat(String format)
List<String>	disableCommands()
List<String>	enableCommands()
String	extractPattern(TemporalUnit unit)	MySQL supports a limited list of temporal fields in the extract() function, but we can emulate some of them by using the appropriate named functions instead of extract().
long	fractionalSecondPrecisionInNanos()	microsecond is the smallest unit for timestampadd() and timestampdiff(), and the highest precision for a timestamp.
AggregateSupport	getAggregateSupport()	Supply the aggregate-column mapping, DDL, read, assignment, and write behavior for this dialect.
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.
protected MySQLStorageEngine	getDefaultMySQLStorageEngine()	Select the storage engine used when none is explicitly configured.
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.
EnumSupport	getEnumSupport()	Supply the database's finite-domain declaration, lifecycle, and check strategy.
FunctionalDependencyAnalysisSupport	getFunctionalDependencyAnalysisSupport()	The database's support for recognizing primary-key functional dependency in group by and order by clauses.
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()	MySQL 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.
DatabaseVersion	getMySQLVersion()
NameQualifierSupport	getNameQualifierSupport()	Supply catalog and schema qualification support, or return null to use DatabaseMetaData.
NamespaceSupport	getNamespaceSupport()	Treat MySQL databases as catalogs for namespace lifecycle operations.
NullOrderingSupport	getNullOrderingSupport()	Supply the database's default null ordering and explicit null-precedence syntax capabilities.
ObjectNullBindingStrategy	getObjectNullBindingStrategy()	Supply the JDBC strategy for binding an untyped Java null.
PredicateSupport	getPredicateSupport()	The database's native predicate syntax and predicate-placement profile.
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 query, String hints)	Apply a hint to the given SQL query.
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.
SequenceSupport	getSequenceSupport()	No support for sequences.
SetOperationSupport	getSetOperationSupport()	Supplies the database's set operators and structural query-group capabilities.
SingleRowTableSupport	getSingleRowTableSupport()	Supply the SQL renderings used for a reusable single-row table and for an otherwise table-less select.
SizeStrategy	getSizeStrategy()	Supply the strategy which resolves column sizes for mapped Java and JDBC types.
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.
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.
TemporalValueSemantics	getTemporalValueSemantics()	Supply temporal precision-adjustment and literal-offset semantics.
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.
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	isJdbcLogWarningsEnabledByDefault()	Is JDBC statement warning logging enabled by default?
boolean	isNoBackslashEscapesEnabled()
IndexNameQualification	nameQualification()
char	openQuote()	Return the character which opens a quoted identifier.
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)
String	render(CheckConstraintRenderRequest request)
String	renderAddConstraint(ForeignKeyConstraintRequest request)
String	renderDropConstraint(ForeignKeyDropRequest request)
boolean	requiresSelfReferentialForeignKeyNullification()
JdbcType	resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry)	Resolve the non-null JDBC descriptor for result-set metadata.
int	resolveSqlTypeLength(String columnTypeName, int jdbcTypeCode, int precision, int scale, int displaySize)	Normalize JDBC result-set metadata to Hibernate's resolved column length.
boolean	supports(CheckConstraintPlacement placement)
protected boolean	supportsAliasLocks()
protected boolean	supportsForShare()
boolean	supportsOnDeleteAction(OnDeleteAction action)
String	tableCreationOptions()
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

appendArrayLiteral, augmentPhysicalTableTypes, augmentRecognizedTableTypes, buildLockingClauseStrategy, buildStringToBooleanCast, buildStringToBooleanCastDecode, contributeDefaultProperties, defaultScrollMode, determineDatabaseVersion, equivalentTypes, getAlterTableSupport, getArraySupport, getArrayTypeName, getBatchLoadSizingStrategy, getCallableStatementSupport, getCatalogSeparator, getCheckConstraintSupport, getColumnAliasExtractor, getColumnDefinitionSupport, getConstraintControlSupport, getDefaultOrdinalityColumnName, getDefaultProperties, getEntityLockingStrategyFactory, getExpressionCoercionSupport, getFetchClauseSupport, getForeignKeyExporter, getForeignKeySupport, getGeneratedValuesSupport, getGlobalTemporaryTableStrategy, getIdentifierSupport, getIndexDdlSupport, getIndexExporter, getJdbcMetadataOverrides, getKeywords, getKeywordSupport, getLiteralSupport, getLobMergeStrategy, getLockingClauseStrategy, getLowercaseFunction, getMultiKeyLoadSizingStrategy, getNationalizationSupport, getNativeParameterMarkerStrategy, getNativeValueGenerationStrategy, getParameterLimits, getPersistentTemporaryTableStrategy, getQueryHintPlacement, getQueryHintString, getRefCursorSupportFactory, getRowIdSupport, getRowLevelSecurity, getSchemaNameResolver, getSelectClauseNullString, getSequenceExporter, getSequenceInformationExtractor, getSetOperatorSqlString, getSyntheticTableGroupSupport, getTableCleaner, getTableCreationSupport, getTableExporter, getTableMigrator, getTemporaryTableExporter, getTimeZoneSupport, getTruncateSupport, getTupleCountSupport, getUserDefinedTypeExporter, getValuesListSupport, getVersion, narrowCastType, resolveSqlTypeCode, resolveSqlTypeCode, 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

addColumnPrefix, addColumnSuffix, alterTableCommand

Methods inherited from interface ConstraintControlSupport

disableConstraintCommands, enableConstraintCommands

Methods inherited from interface CurrentTemporalSupport

currentDate, currentLocalTime, currentLocalTimestamp, currentTime, currentTimestampWithTimeZone, isCurrentTimestampStable, usesStandardCurrentTimestampFunction

Methods inherited from interface ForeignKeySupport

supportsAlterTableConstraints

Methods inherited from interface IdentifierSupport

quote, quoteCollation, toQuotedIdentifier

Methods inherited from interface IndexDdlSupport

createCommand, createTail

Methods inherited from interface KeywordSupport

acceptsJdbcKeyword

Methods inherited from interface LiteralSupport

appendBinaryLiteral, appendIntervalLiteral, appendIntervalLiteral, appendUUIDLiteral, toBooleanValueString

Methods inherited from interface TableCreationSupport

createTableCommand, requiresViewColumnList

Methods inherited from interface TemporalOperationSupport

translateDurationField, translateExtractField

Methods inherited from interface TruncateSupport

renderCommands

Constructor Details

MySQLDialect

@SPI(IMPLEMENT)
public MySQLDialect()

MySQLDialect

@SPI(IMPLEMENT)
public MySQLDialect(DatabaseVersion version)

MySQLDialect

@SPI(IMPLEMENT)
public MySQLDialect(DatabaseVersion version,
 MySQLServerConfiguration serverConfiguration)

MySQLDialect

@SPI(IMPLEMENT)
public MySQLDialect(DialectResolutionInfo info)

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

createVersion

protected static DatabaseVersion createVersion(DialectResolutionInfo info,
 DatabaseVersion defaultVersion)

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

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

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

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

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

castType

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

Description copied from class: Dialect

Return the complete cast-target type pattern for sqlTypeCode.

Override this hook when cast syntax differs from column declaration syntax; otherwise delegate to Dialect.columnType(int).

Overrides:

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

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

isNoBackslashEscapesEnabled

public boolean isNoBackslashEscapesEnabled()

appendDefinition

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

Specified by:

appendDefinition in interface ColumnDefinitionSupport

getMySQLVersion

public DatabaseVersion getMySQLVersion()

getSizeStrategy

public SizeStrategy getSizeStrategy()

Description copied from class: Dialect

Supply the strategy which resolves column sizes for mapped Java and JDBC types.

Return the standard strategy unless this database changes column-size resolution. For focused deviations, construct a stable StandardSizeStrategy with this Dialect, override the affected cases, and delegate all other cases to the standard implementation. The result must be non-null and stable for the lifetime of this Dialect.

Overrides:

getSizeStrategy in class Dialect

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

resolveSqlTypeLength

@SPI({USE,IMPLEMENT})
public int resolveSqlTypeLength(String columnTypeName,
 int jdbcTypeCode,
 int precision,
 int scale,
 int displaySize)

Description copied from class: Dialect

Normalize JDBC result-set metadata to Hibernate's resolved column length.

JDBC precision may represent character length. Providers should retain their vendor formulas using all supplied metadata values.

Overrides:

resolveSqlTypeLength 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

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

registerJsonFunctions

protected static void registerJsonFunctions(CommonFunctionFactory functionFactory)

getMaximumSeriesSize

protected int getMaximumSeriesSize()

MySQL 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.

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.

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

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

currentTimestamp

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

MySQL 5.7 precision defaults to seconds, but microseconds is better

Specified by:

currentTimestamp in interface CurrentTemporalSupport

fractionalSecondPrecisionInNanos

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

microsecond is the smallest unit for timestampadd() and timestampdiff(), and the highest precision for a timestamp.

Specified by:

fractionalSecondPrecisionInNanos in interface TemporalOperationSupport

extractPattern

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

MySQL supports a limited list of temporal fields in the extract() function, but we can emulate some of them by using the appropriate named functions instead of extract().

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

In addition, the field TemporalUnit.SECOND is redefined to include microseconds.

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

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

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

appendDateTimeLiteral

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

Description copied from class: Dialect

Append a datetime literal for a Calendar value.

Preserve Calendar-specific time-zone and millisecond semantics, append immediately, and retain no invocation state.

Specified by:

appendDateTimeLiteral in interface LiteralSupport

Overrides:

appendDateTimeLiteral in class Dialect

supports

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

Specified by:

supports in interface CheckConstraintSupport

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

getQueryHintString

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

getSequenceSupport

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

No support for sequences.

Overrides:

getSequenceSupport in class Dialect

Returns:

the non-null sequence-support strategy

See Also:

• SequenceSupport

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

nameQualification

@SPI({USE,IMPLEMENT})
public IndexNameQualification nameQualification()

Specified by:

nameQualification in interface IndexDdlSupport

renderAddConstraint

@SPI({USE,IMPLEMENT})
public String renderAddConstraint(ForeignKeyConstraintRequest request)

Specified by:

renderAddConstraint in interface ForeignKeySupport

renderDropConstraint

@SPI({USE,IMPLEMENT})
public String renderDropConstraint(ForeignKeyDropRequest request)

Specified by:

renderDropConstraint in interface ForeignKeySupport

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

alterColumnType

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

Specified by:

alterColumnType in interface AlterTableSupport

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

closeQuote

@SPI({USE,IMPLEMENT})
public char closeQuote()

Description copied from interface: IdentifierSupport

Return the character which closes a quoted identifier.

Specified by:

closeQuote in interface IdentifierSupport

openQuote

@SPI({USE,IMPLEMENT})
public char openQuote()

Description copied from interface: IdentifierSupport

Return the character which opens a quoted identifier.

Specified by:

openQuote in interface IdentifierSupport

getNamespaceSupport

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

Treat MySQL databases as catalogs for namespace lifecycle operations.

Although MySQL accepts create schema as a synonym for create database, Hibernate follows the JDBC driver's catalog model because DatabaseMetaData.supportsSchemasInDataManipulation() returns false.

Overrides:

getNamespaceSupport in class Dialect

See Also:

• NamespaceSupport

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

addPartitionKeyToPrimaryKey

@SPI({USE,IMPLEMENT})
public boolean addPartitionKeyToPrimaryKey()

Description copied from class: Dialect

Whether every table partition key must also occur in its primary key.

Return true only when the database requires the rule for both ordinary and temporal-history tables. This has nothing to do with window-function partitioning.

Overrides:

addPartitionKeyToPrimaryKey in class Dialect

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

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

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

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

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

getPredicateSupport

public PredicateSupport getPredicateSupport()

Description copied from class: Dialect

The database's native predicate syntax and predicate-placement profile.

Override this method to supply independent support for a native case-insensitive-like operator, scalar distinct from, truthness predicates, and predicates used as value expressions. An absent case-insensitive-like operator selects Hibernate's lowercase-expression emulation. Return one immutable, non-null profile whose values remain stable for the lifetime of this Dialect; do not override individual consumers to reproduce these decisions.

Overrides:

getPredicateSupport in class Dialect

Returns:

this Dialect's stable predicate-support profile

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

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

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

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

isJdbcLogWarningsEnabledByDefault

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

Description copied from class: Dialect

Is JDBC statement warning logging enabled by default?

Overrides:

isJdbcLogWarningsEnabledByDefault in class Dialect

supportsOnDeleteAction

@SPI({USE,IMPLEMENT})
public boolean supportsOnDeleteAction(OnDeleteAction action)

Specified by:

supportsOnDeleteAction in interface ForeignKeySupport

tableCreationOptions

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

Specified by:

tableCreationOptions in interface TableCreationSupport

requiresSelfReferentialForeignKeyNullification

@SPI({USE,IMPLEMENT})
public boolean requiresSelfReferentialForeignKeyNullification()

Specified by:

requiresSelfReferentialForeignKeyNullification in interface ForeignKeySupport

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

getDefaultMySQLStorageEngine

@SPI({IMPLEMENT,SUPPLY})
protected MySQLStorageEngine getDefaultMySQLStorageEngine()

Select the storage engine used when none is explicitly configured.

Since:

8.0

appendLiteral

@SPI({USE,IMPLEMENT})
public void appendLiteral(SqlAppender appender,
 String literal)

Description copied from interface: LiteralSupport

Append a SQL string literal.

Specified by:

appendLiteral in interface LiteralSupport

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)

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

getSubquerySupport

@SPI({IMPLEMENT,SUPPLY})
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

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

getSetOperationSupport

@SPI({IMPLEMENT,SUPPLY})
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

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

supportsForShare

protected boolean supportsForShare()

supportsAliasLocks

protected boolean supportsAliasLocks()

getFunctionalDependencyAnalysisSupport

@SPI({IMPLEMENT,SUPPLY})
public FunctionalDependencyAnalysisSupport getFunctionalDependencyAnalysisSupport()

Description copied from class: Dialect

The database's support for recognizing primary-key functional dependency in group by and order by clauses.

This profile controls when Hibernate may omit functionally dependent columns. Report only behavior guaranteed by the database across the Dialect's supported versions.

Overrides:

getFunctionalDependencyAnalysisSupport in class Dialect

Returns:

a non-null immutable capability profile

See Also:

• FunctionalDependencyAnalysisSupport

constraintControlMode

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

Specified by:

constraintControlMode in interface ConstraintControlSupport

Overrides:

constraintControlMode in class Dialect

disableCommands

@SPI({USE,IMPLEMENT})
public List<String> disableCommands()

Specified by:

disableCommands in interface ConstraintControlSupport

enableCommands

@SPI({USE,IMPLEMENT})
public List<String> enableCommands()

Specified by:

enableCommands in interface ConstraintControlSupport

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

render

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

Specified by:

render in interface CheckConstraintSupport

getObjectNullBindingStrategy

@SPI({IMPLEMENT,SUPPLY})
public ObjectNullBindingStrategy getObjectNullBindingStrategy()

Description copied from class: Dialect

Supply the JDBC strategy for binding an untyped Java null.

Overrides:

getObjectNullBindingStrategy in class Dialect

Returns:

the non-null binding strategy

See Also:

• ObjectNullBindingStrategy

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

@SPI({IMPLEMENT,SUPPLY})
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

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

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