Class MySQLDialect
- All Implemented Interfaces:
FunctionContributor
,TypeContributor
,ConversionContext
- Direct Known Subclasses:
MariaDBDialect
,MySQL56SpatialDialect
,MySQL5SpatialDialect
,MySQL8Dialect
,MySQLSpatialDialect
,TiDBDialect
-
Nested Class Summary
Nested classes/interfaces inherited from class org.hibernate.dialect.Dialect
Dialect.SizeStrategy, Dialect.SizeStrategyImpl
-
Field Summary
Fields inherited from class org.hibernate.dialect.Dialect
CLOSED_QUOTE, LEGACY_LOB_MERGE_STRATEGY, LOG_BASE2OF10, NEW_LOCATOR_LOB_MERGE_STRATEGY, QUOTE, STANDARD_MULTI_KEY_LOAD_SIZING_STRATEGY, STREAM_XFER_LOB_MERGE_STRATEGY
-
Constructor Summary
ConstructorsConstructorDescriptionMySQLDialect
(DatabaseVersion version) MySQLDialect
(DatabaseVersion version, int bytesPerCharacter) MySQLDialect
(DatabaseVersion version, int bytesPerCharacter, boolean noBackslashEscapes) MySQLDialect
(DatabaseVersion version, MySQLServerConfiguration serverConfiguration) -
Method Summary
Modifier and TypeMethodDescriptionvoid
appendDatetimeFormat
(SqlAppender appender, String format) Translate the given datetime format string from the pattern language defined by Java'sDateTimeFormatter
to whatever pattern language is understood by the native datetime formatting function for this database (often theto_char()
function).void
appendDateTimeLiteral
(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone) Append a datetime literal representing the givenjava.time
value to the givenSqlAppender
.void
appendDateTimeLiteral
(SqlAppender appender, Calendar calendar, TemporalType precision, TimeZone jdbcTimeZone) Append a datetime literal representing the givenCalendar
value to the givenSqlAppender
.void
appendDateTimeLiteral
(SqlAppender appender, Date date, TemporalType precision, TimeZone jdbcTimeZone) Append a datetime literal representing the givenDate
value to the givenSqlAppender
.void
appendLiteral
(SqlAppender appender, String literal) Append a literal string to the givenSqlAppender
.buildIdentifierHelper
(IdentifierHelperBuilder builder, DatabaseMetaData dbMetaData) TheIdentifierHelper
indicated by this dialect for handling identifier conversions.An instance ofSQLExceptionConversionDelegate
for interpreting dialect-specific error or SQLState codes.boolean
Does this dialect support creating and dropping catalogs?boolean
Does this dialect support creating and dropping schema?boolean
Is there some way to disable foreign key constraint checking while truncating tables? (If there's no way to do it, and if we can't batch truncate, we must drop and recreate the constraints instead.)castPattern
(CastType from, CastType to) Obtain a pattern for the SQL equivalent to acast()
function call.protected String
castType
(int sqlTypeCode) The SQL type to use incast( ... as ... )
expressions when casting to the target type represented by the given JDBC type code.char
The character specific to this dialect used to close a quoted identifier.protected String
columnType
(int sqlTypeCode) void
contributeTypes
(TypeContributions typeContributions, ServiceRegistry serviceRegistry) A callback which allows theDialect
to contribute types.protected static DatabaseVersion
Deprecated.protected static DatabaseVersion
createVersion
(DialectResolutionInfo info, DatabaseVersion defaultVersion) MySQL 5.7 precision defaults to seconds, but microseconds is betterstatic Replacer
datetimeFormat
(String format) boolean
Do we need to drop constraints before dropping tables in this dialect?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().getAddForeignKeyConstraintString
(String constraintName, String[] foreignKey, String referencedTable, String[] primaryKey, boolean referencesPrimaryKey) The syntax used to add a foreign key constraint to a table, with the referenced key columns explicitly specified.getAlterColumnTypeString
(String columnName, String columnType, String columnDefinition) The fragment of analter table
command which modifies a column type, or null if column types cannot be modified.protected static int
getCharacterSetBytesPerCharacter
(DatabaseMetaData databaseMetaData) Deprecated.getColumnComment
(String comment) Get the comment into a form supported for column definition.String[]
getCreateCatalogCommand
(String catalogName) Get the SQL command used to create the named catalog.String[]
getCreateSchemaCommand
(String schemaName) Get the SQL command used to create the named schema.The command used to retrieve the current timestamp from the database.long
protected MySQLStorageEngine
A SQL statement that temporarily disables foreign key constraint checking for all tables.Get the minimumDmlTargetColumnQualifierSupport
required by this dialect.String[]
getDropCatalogCommand
(String catalogName) Get the SQL command used to drop the named catalog.The subcommand of thealter table
command used to drop a foreign key constraint, usuallydrop constraint
.String[]
getDropSchemaCommand
(String schemaName) Get the SQL command used to drop the named schema.The subcommand of thealter table
command used to drop a unique key constraint.A SQL statement that re-enables foreign key constraint checking for all tables.getEnumTypeDeclaration
(String name, String[] values) If this database has a special MySQL-styleenum
column type, return the type declaration for the given enumeration of values.getFallbackSqmInsertStrategy
(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext) TheSqmMultiTableInsertStrategy
to use when not specified byQueryEngineOptions.getCustomSqmMultiTableInsertStrategy()
.getFallbackSqmMutationStrategy
(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext) TheSqmMultiTableMutationStrategy
to use when not specified byQueryEngineOptions.getCustomSqmMultiTableMutationStrategy()
.int
This is the default precision for a generated column mapped to a JavaFloat
orfloat
.Retrieves theFOR UPDATE NOWAIT
syntax specific to this dialect.getForUpdateNowaitString
(String aliases) Get theFOR UPDATE OF column_list NOWAIT
fragment appropriate for this dialect, given the aliases of the columns to be write locked.Retrieves theFOR UPDATE SKIP LOCKED
syntax specific to this dialect.getForUpdateSkipLockedString
(String aliases) Get theFOR UPDATE OF column_list SKIP LOCKED
fragment appropriate for this dialect, given the aliases of the columns to be write locked.getForUpdateString
(String aliases) Get theFOR UPDATE OF column_list
fragment appropriate for this dialect, given the aliases of the columns to be write locked.long
microsecond
is the smallest unit fortimestampadd()
andtimestampdiff()
, and the highest precision for atimestamp
.Get this dialect's level of support for primary key functional dependency analysis withinGROUP BY
andORDER BY
clauses.Determine how selected items are referenced in thegroup by
clause.Get the appropriateIdentityColumnSupport
for this dialect.Obtain aLimitHandler
that implements pagination support forQuery.setMaxResults(int)
andQuery.setFirstResult(int)
.int
What is the maximum length Hibernate can use for generated aliases?int
What is the maximum identifier length supported by this dialect?int
The biggest size value that can be supplied as argument to aTypes.VARBINARY
-like type.int
The biggest size value that can be supplied as argument to aTypes.VARCHAR
-like type.protected DatabaseVersion
Get the version of the SQL dialect that is the minimum supported by this implementation.getNullColumnString
(String columnType) The keyword used to specify a nullable column of the given SQL type.Returns the default ordering of null.int
The JDBC type code to use for mapping properties of Java typeboolean
.getQueryHintString
(String query, String hints) Apply a hint to the given SQL query.getReadLockString
(int timeout) Get the string to append toSELECT
statements to acquire READ locks for this dialect.getReadLockString
(String aliases, int timeout) Get the string to append toSELECT
statements to acquire READ locks for this dialect, given the aliases of the columns to be read locked.Given a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int)
, extract theResultSet
from theOUT
parameter.Get the command used to select a GUID from the database.No support for sequences.A customDialect.SizeStrategy
for column types.The kind of temporary tables that are supported on this database.getTableComment
(String comment) Get the comment into a form supported for table definition.An arbitrary fragment appended to the end of thecreate table
statement.The action to take after finishing use of a temporary table.The action to take before beginning use of a temporary table.The command to create a temporary table.The command to drop a temporary table.AViolatedConstraintNameExtractor
for extracting the name of a violated constraint from aSQLException
.getWriteLockString
(int timeout) Get the string to append toSELECT
statements to acquire pessimistic WRITE locks for this dialect.getWriteLockString
(String aliases, int timeout) Get the string to append toSELECT
statements to acquire WRITE locks for this dialect, given the aliases of the columns to be write locked.The row lock strategy to use for write locks.boolean
Does the database/driver have bug in deleting rows that refer to other rows being deleted in the same query?protected void
Set appropriate default values for configuration properties.void
initializeFunctionRegistry
(FunctionContributions functionContributions) Initialize the given registry with any dialect-specific functions.boolean
Is the command returned byDialect.getCurrentTimestampSelectString()
treated as callable?boolean
Is JDBC statement warning logging enabled by default?boolean
char
The character specific to this dialect used to begin a quoted identifier.boolean
Do we need to qualify index names with the schema name?protected void
registerColumnTypes
(TypeContributions typeContributions, ServiceRegistry serviceRegistry) Register ANSI-standard column types using the length limits defined byDialect.getMaxVarcharLength()
,Dialect.getMaxNVarcharLength()
, andDialect.getMaxVarbinaryLength()
.protected void
Register the reserved words of ANSI-standard SQL as keywords.int
registerResultSetOutParameter
(CallableStatement statement, int col) Registers a parameter capable of returning aResultSet
by position, either anOUT
parameter, or aREF_CURSOR
parameter as defined in Java 8.resolveSqlTypeDescriptor
(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry) Assigns an appropriateJdbcType
to a column of a JDBC result set based on the column type name, JDBC type code, precision, and scale.int
resolveSqlTypeLength
(String columnTypeName, int jdbcTypeCode, int precision, int scale, int displaySize) Determine the length/precision of a column based on information in the JDBCResultSetMetaData
.boolean
Does this dialect support modifying the type of an existing column?boolean
Does this dialect supporton delete
actions in foreign key definitions?boolean
Does this dialect support column-level check constraints?boolean
Does this dialect support commenting on tables and columns?boolean
Does this dialect support some way to retrieve the current timestamp value from the database?boolean
Does this dialect support thefrom
clause for update statements?boolean
For dropping a table, can the phraseif exists
be applied before the table name?boolean
Does this dialect support theis true
andis false
operators?boolean
Does this dialect support the SQLlateral
keyword or a proprietary alternative?boolean
Does the dialect support propagating changes to LOB values back to the database? Talking about mutating the internal value of the locator, as opposed to supplying a new locator instance.boolean
Does this dialect support specifying timeouts when requesting locks.boolean
Does this dialect supportNO_WAIT
timeout.boolean
Does this dialect supportnulls first
andnulls last
?boolean
Does this dialect supportoffset
in subqueries?boolean
Does this dialect/database support recursive CTEs?boolean
Does this dialect supportSKIP_LOCKED
timeout.boolean
Does this dialect support referencing the table being mutated in a subquery? The "table being mutated" is the table referenced in an update or delete query.boolean
Does this dialect supports timezone offsets in temporal literals.boolean
Does this dialect supportWAIT
timeout.boolean
Does this dialect support window functions likerow_number() over (..)
?timestampaddPattern
(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType) Obtain a pattern for the SQL equivalent to atimestampadd()
function call.timestampdiffPattern
(TemporalUnit unit, TemporalType fromTemporalType, TemporalType toTemporalType) Obtain a pattern for the SQL equivalent to atimestampdiff()
function call.boolean
Whether to switch: fromVARCHAR
-like types toSqlTypes.MATERIALIZED_CLOB
types when the requested size for a type exceeds theDialect.getMaxVarcharCapacity()
, fromNVARCHAR
-like types toSqlTypes.MATERIALIZED_NCLOB
types when the requested size for a type exceeds theDialect.getMaxNVarcharCapacity()
, and fromVARBINARY
-like types toSqlTypes.MATERIALIZED_BLOB
types when the requested size for a type exceeds theDialect.getMaxVarbinaryCapacity()
.Methods inherited from class org.hibernate.dialect.Dialect
addSqlHintOrComment, appendArrayLiteral, appendBinaryLiteral, appendBooleanValueString, appendIntervalLiteral, appendLockHint, appendUUIDLiteral, applyLocksToSql, augmentPhysicalTableTypes, augmentRecognizedTableTypes, canBatchTruncate, checkVersion, contribute, contributeFunctions, createOptionalTableUpdateOperation, currentDate, currentLocalTime, currentLocalTimestamp, currentTime, currentTimestampWithTimeZone, defaultScrollMode, doesReadCommittedCauseWritersToBlockReaders, doesRepeatableReadCauseReadersToBlockWriters, doesRoundTemporalOnOverflow, equivalentTypes, escapeComment, forceLobAsLastValue, generatedAs, getAddColumnString, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAggregateSupport, getAlterTableString, getArrayTypeName, getAuxiliaryDatabaseObjectExporter, getBatchLoadSizingStrategy, getBeforeDropStatement, getCallableStatementSupport, getCascadeConstraintsString, getCaseInsensitiveLike, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getColumnAliasExtractor, getCreateEnumTypeCommand, getCreateEnumTypeCommand, getCreateIndexString, getCreateIndexTail, getCreateMultisetTableString, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getCreateUserDefinedTypeExtensionsString, getCreateUserDefinedTypeKindString, getCrossReferenceParentTableFilter, getCurrentSchemaCommand, getDefaultDecimalPrecision, getDefaultIntervalSecondScale, getDefaultNonContextualLobCreation, getDefaultProperties, getDefaultStatementBatchSize, getDefaultTimestampPrecision, getDefaultUseGetGeneratedKeys, getDisableConstraintStatement, getDoublePrecision, getDropEnumTypeCommand, getDropEnumTypeCommand, getDropTableString, getEnableConstraintStatement, getEnumTypeDeclaration, getFallbackSchemaManagementTool, getForeignKeyExporter, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getHqlTranslator, getIndexExporter, getInExpressionCountLimit, getKeywords, getLobMergeStrategy, getLockingStrategy, getLockRowIdentifier, getLowercaseFunction, getMaxNVarcharCapacity, getMaxNVarcharLength, getMaxVarbinaryCapacity, getMaxVarcharCapacity, getMultiKeyLoadSizingStrategy, getNationalizationSupport, getNativeIdentifierGeneratorStrategy, getNativeParameterMarkerStrategy, getNoColumnsInsertString, getNullColumnString, getParameterCountLimit, getPreferredSqlTypeCodeForArray, getQueryHintString, getQuerySequencesString, getReadRowLockStrategy, getResultSet, getResultSet, getRowIdColumnString, getSchemaNameResolver, getSelectClauseNullString, getSequenceExporter, getSequenceInformationExtractor, getSqmTranslatorFactory, getTableCleaner, getTableExporter, getTableMigrator, getTemporaryTableCreateOptions, getTemporaryTableDdlTransactionHandling, getTemporaryTableExporter, getTemporaryTableTruncateCommand, getTimeoutInSeconds, getTimeZoneSupport, getTruncateTableStatement, getTruncateTableStatements, getUniqueDelegate, getUniqueKeyExporter, getUserDefinedTypeComment, getUserDefinedTypeExporter, getVersion, hasAlterTable, hasDataTypeBeforeGeneratedAs, inlineLiteral, isAnsiNullOn, isEmptyStringTreatedAsNull, isLob, isLockTimeoutParameterized, ordinal, prependComment, quote, quoteCollation, registerKeyword, registerKeywords, registerResultSetOutParameter, requiresCastForConcatenatingNonStrings, requiresFloatCastingOfIntegerDivision, requiresParensForTupleCounts, requiresParensForTupleDistinctCounts, resolveSqlTypeCode, resolveSqlTypeCode, rowId, rowIdSqlType, supportsBatchUpdates, supportsBindAsCallableArgument, supportsBitType, supportsCaseInsensitiveLike, supportsCircularCascadeDeleteConstraints, supportsConflictClauseForInsertCTE, supportsDistinctFromPredicate, supportsExistsInSelect, supportsExpectedLobUsagePattern, supportsFetchClause, supportsFractionalTimestampArithmetic, supportsIfExistsAfterAlterTable, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsAfterTypeName, supportsIfExistsBeforeConstraintName, supportsIfExistsBeforeTypeName, supportsInsertReturning, supportsInsertReturningGeneratedKeys, supportsInsertReturningRowId, supportsJdbcConnectionLobCreation, supportsMaterializedLobAccess, supportsNamedParameters, supportsNationalizedMethods, supportsNoColumnsInsert, supportsNonQueryWithCTE, supportsOrderByInSubquery, supportsOrdinalSelectItemReference, supportsOuterJoinForUpdate, supportsParametersInInsertSelect, supportsPartitionBy, supportsPredicateAsExpression, supportsRefCursors, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsStandardArrays, supportsStandardCurrentTimestampFunction, supportsSubqueryInSelect, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTemporaryTablePrimaryKey, supportsTemporaryTables, supportsTruncateWithCast, supportsTupleCounts, supportsTupleDistinctCounts, supportsUnboundedLobLocatorMaterialization, supportsUnionAll, supportsUnionInSubquery, supportsUpdateReturning, supportsValuesList, supportsValuesListForInsert, toBooleanValueString, toQuotedIdentifier, toString, transformSelectString, translateDurationField, translateExtractField, trimPattern, trimPattern, unquoteGetGeneratedKeys, useArrayForMultiValuedParameters, useConnectionToCreateLob, useCrossReferenceForeignKeys, useFollowOnLocking, useInputStreamToInsertBlob
-
Constructor Details
-
MySQLDialect
public MySQLDialect() -
MySQLDialect
-
MySQLDialect
-
MySQLDialect
-
MySQLDialect
-
MySQLDialect
-
-
Method Details
-
createVersion
Deprecated. -
createVersion
protected static DatabaseVersion createVersion(DialectResolutionInfo info, DatabaseVersion defaultVersion) -
getMinimumSupportedVersion
Description copied from class:Dialect
Get the version of the SQL dialect that is the minimum supported by this implementation.- Overrides:
getMinimumSupportedVersion
in classDialect
-
initDefaultProperties
protected void initDefaultProperties()Description copied from class:Dialect
Set appropriate default values for configuration properties.This default implementation sets "hibernate.jdbc.batch_size", "hibernate.jdbc.lob.non_contextual_creation", and "hibernate.jdbc.use_get_generated_keys" to defaults determined by calling
Dialect.getDefaultStatementBatchSize()
,Dialect.getDefaultNonContextualLobCreation()
, andDialect.getDefaultUseGetGeneratedKeys()
.An implementation may set additional configuration properties, but this is discouraged.
- Overrides:
initDefaultProperties
in classDialect
-
columnType
Description copied from class:Dialect
The database column type name for a given JDBC type code defined inTypes
orSqlTypes
. This default implementation returns the ANSI-standard type name.This method may be overridden by concrete
Dialect
s as an alternative toDialect.registerColumnTypes(TypeContributions, ServiceRegistry)
for simple registrations.Note that:
- Implementations of this method are expected to define a
sensible mapping for
Types.NCLOB
Types.NCHAR
, andTypes.NVARCHAR
. On some database, these types are simply remapped toCLOB
,CHAR
, andVARCHAR
. - Mappings for
Types.TIMESTAMP
andTypes.TIMESTAMP_WITH_TIMEZONE
should support explicit specification of precision if possible. - As specified by
DdlTypeRegistry.getDescriptor(int)
, this method never receivesTypes.LONGVARCHAR
,Types.LONGNVARCHAR
, norTypes.LONGVARBINARY
, which are considered synonyms for their non-LONG
counterparts. - On the other hand, the types
SqlTypes.LONG32VARCHAR
,SqlTypes.LONG32NVARCHAR
, andSqlTypes.LONG32VARBINARY
are not synonyms, and implementations of this method must define sensible mappings, for example to database-nativeTEXT
orCLOB
types.
- Overrides:
columnType
in classDialect
- Parameters:
sqlTypeCode
- a SQLtype code
- Returns:
- a column type name, with
$l
,$p
,$s
placeholders for length, precision, scale - See Also:
- Implementations of this method are expected to define a
sensible mapping for
-
useMaterializedLobWhenCapacityExceeded
public boolean useMaterializedLobWhenCapacityExceeded()Description copied from class:Dialect
Whether to switch:- from
VARCHAR
-like types toSqlTypes.MATERIALIZED_CLOB
types when the requested size for a type exceeds theDialect.getMaxVarcharCapacity()
, - from
NVARCHAR
-like types toSqlTypes.MATERIALIZED_NCLOB
types when the requested size for a type exceeds theDialect.getMaxNVarcharCapacity()
, and - from
VARBINARY
-like types toSqlTypes.MATERIALIZED_BLOB
types when the requested size for a type exceeds theDialect.getMaxVarbinaryCapacity()
.
- Overrides:
useMaterializedLobWhenCapacityExceeded
in classDialect
- Returns:
true
if materialized LOBs should be used for capacity exceeding types.
- from
-
castType
Description copied from class:Dialect
The SQL type to use incast( ... as ... )
expressions when casting to the target type represented by the given JDBC type code. -
registerColumnTypes
protected void registerColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry) Description copied from class:Dialect
Register ANSI-standard column types using the length limits defined byDialect.getMaxVarcharLength()
,Dialect.getMaxNVarcharLength()
, andDialect.getMaxVarbinaryLength()
.This method is always called when a
Dialect
is instantiated.- Overrides:
registerColumnTypes
in classDialect
-
getCharacterSetBytesPerCharacter
@Deprecated protected static int getCharacterSetBytesPerCharacter(DatabaseMetaData databaseMetaData) Deprecated. -
getMaxVarcharLength
public int getMaxVarcharLength()Description copied from class:Dialect
The biggest size value that can be supplied as argument to aTypes.VARCHAR
-like type.For longer column lengths, use some sort of
text
-like type for the column.- Overrides:
getMaxVarcharLength
in classDialect
-
getMaxVarbinaryLength
public int getMaxVarbinaryLength()Description copied from class:Dialect
The biggest size value that can be supplied as argument to aTypes.VARBINARY
-like type.For longer column lengths, use some sort of
image
-like type for the column.- Overrides:
getMaxVarbinaryLength
in classDialect
-
isNoBackslashEscapesEnabled
public boolean isNoBackslashEscapesEnabled() -
getNullColumnString
Description copied from class:Dialect
The keyword used to specify a nullable column of the given SQL type.- Overrides:
getNullColumnString
in classDialect
-
getMySQLVersion
-
getSizeStrategy
Description copied from class:Dialect
A customDialect.SizeStrategy
for column types.- Overrides:
getSizeStrategy
in classDialect
-
getDefaultLobLength
public long getDefaultLobLength()Description copied from class:Dialect
This is the default length for a generated column of typeBLOB
orCLOB
mapped toBlob
orClob
, if LOB columns have a length in this dialect.- Overrides:
getDefaultLobLength
in classDialect
- Returns:
- 1048576L by default
- See Also:
-
resolveSqlTypeDescriptor
public JdbcType resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry) Description copied from class:Dialect
Assigns an appropriateJdbcType
to a column of a JDBC result set based on the column type name, JDBC type code, precision, and scale.- Overrides:
resolveSqlTypeDescriptor
in classDialect
- Parameters:
columnTypeName
- the column type namejdbcTypeCode
- thetype code
precision
- the precision or 0scale
- the scale or 0- Returns:
- an appropriate instance of
JdbcType
-
resolveSqlTypeLength
public int resolveSqlTypeLength(String columnTypeName, int jdbcTypeCode, int precision, int scale, int displaySize) Description copied from class:Dialect
Determine the length/precision of a column based on information in the JDBCResultSetMetaData
. Note that what JDBC reports as a "precision" might actually be the column length.- Overrides:
resolveSqlTypeLength
in classDialect
- Parameters:
columnTypeName
- the name of the column typejdbcTypeCode
- the JDBC type code of the column typeprecision
- the (numeric) precision or (character) length of the columnscale
- the scale of a numeric columndisplaySize
- the display size of the column- Returns:
- the precision or length of the column
-
getPreferredSqlTypeCodeForBoolean
public int getPreferredSqlTypeCodeForBoolean()Description copied from class:Dialect
The JDBC type code to use for mapping properties of Java typeboolean
.Usually
Types.BOOLEAN
orTypes.BIT
.- Overrides:
getPreferredSqlTypeCodeForBoolean
in classDialect
- Returns:
- one of the type codes defined by
Types
.
-
initializeFunctionRegistry
Description copied from class:Dialect
Initialize the given registry with any dialect-specific functions.Support for certain SQL functions is required, and if the database does not support a required function, then the dialect must define a way to emulate it.
These required functions include the functions defined by the JPA query language specification:
-
avg(arg)
- aggregate function -
count([distinct ]arg)
- aggregate function -
max(arg)
- aggregate function -
min(arg)
- aggregate function -
sum(arg)
- aggregate function
-
coalesce(arg0, arg1, ...)
-
nullif(arg0, arg1)
-
lower(arg)
-
upper(arg)
-
length(arg)
-
concat(arg0, arg1, ...)
-
locate(pattern, string[, start])
-
substring(string, start[, length])
-
trim([[spec ][character ]from] string)
-
abs(arg)
-
mod(arg0, arg1)
-
sqrt(arg)
-
current date
-
current time
-
current timestamp
-
any(arg)
- aggregate function -
every(arg)
- aggregate function
-
var_samp(arg)
- aggregate function -
var_pop(arg)
- aggregate function -
stddev_samp(arg)
- aggregate function -
stddev_pop(arg)
- aggregate function
-
cast(arg as Type)
-
extract(field from arg)
-
ln(arg)
-
exp(arg)
-
power(arg0, arg1)
-
floor(arg)
-
ceiling(arg)
-
position(pattern in string)
-
substring(string from start[ for length])
-
overlay(string placing replacement from start[ for length])
java.time
types:-
local date
-
local time
-
local datetime
-
offset datetime
-
instant
-
left(string, length)
-
right(string, length)
-
replace(string, pattern, replacement)
-
pad(string with length spec[ character])
-
repeat(string, times)
-
pi
-
log10(arg)
-
log(base, arg)
-
sign(arg)
-
sin(arg)
-
cos(arg)
-
tan(arg)
-
asin(arg)
-
acos(arg)
-
atan(arg)
-
atan2(arg0, arg1)
-
round(arg0[, arg1])
-
truncate(arg0[, arg1])
-
sinh(arg)
-
tanh(arg)
-
cosh(arg)
-
least(arg0, arg1, ...)
-
greatest(arg0, arg1, ...)
-
degrees(arg)
-
radians(arg)
-
bitand(arg1, arg1)
-
bitor(arg1, arg1)
-
bitxor(arg1, arg1)
-
format(datetime as pattern)
-
collate(string as collation)
-
str(arg)
- synonym ofcast(a as String)
-
ifnull(arg0, arg1)
- synonym ofcoalesce(a, b)
extract()
, and desugared by the parser:-
second(arg)
- synonym ofextract(second from a)
-
minute(arg)
- synonym ofextract(minute from a)
-
hour(arg)
- synonym ofextract(hour from a)
-
day(arg)
- synonym ofextract(day from a)
-
month(arg)
- synonym ofextract(month from a)
-
year(arg)
- synonym ofextract(year from a)
second()
function returns a floating point value, contrary to the integer type returned by the native function with this name on many databases. Thus, we don't just naively map these HQL functions to the native SQL functions with the same names.- Overrides:
initializeFunctionRegistry
in classDialect
-
-
contributeTypes
Description copied from class:Dialect
A callback which allows theDialect
to contribute types.- Overrides:
contributeTypes
in classDialect
- Parameters:
typeContributions
- Callback to contribute the typesserviceRegistry
- The service registry
-
getSqlAstTranslatorFactory
Description copied from class:Dialect
- Overrides:
getSqlAstTranslatorFactory
in classDialect
- See Also:
-
castPattern
Description copied from class:Dialect
Obtain a pattern for the SQL equivalent to acast()
function call. The resulting pattern must contain ?1 and ?2 placeholders for the arguments.- Overrides:
castPattern
in classDialect
- Parameters:
from
- aCastType
indicating the type of the value argumentto
- aCastType
indicating the type the value argument is cast to
-
getFloatPrecision
public int getFloatPrecision()Description copied from class:Dialect
This is the default precision for a generated column mapped to a JavaFloat
orfloat
. That is, a value representing "single precision".Usually 24 binary digits, at least for databases with a conventional interpretation of the ANSI SQL specification.
- Overrides:
getFloatPrecision
in classDialect
- Returns:
- a value representing "single precision", usually in binary digits, but sometimes in decimal digits
-
currentTimestamp
MySQL 5.7 precision defaults to seconds, but microseconds is better- Overrides:
currentTimestamp
in classDialect
-
getFractionalSecondPrecisionInNanos
public long getFractionalSecondPrecisionInNanos()microsecond
is the smallest unit fortimestampadd()
andtimestampdiff()
, and the highest precision for atimestamp
.- Overrides:
getFractionalSecondPrecisionInNanos
in classDialect
- Returns:
- the precision, specified as a quantity of nanoseconds
- See Also:
-
extractPattern
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 areTemporalUnit.DAY_OF_YEAR
,TemporalUnit.DAY_OF_MONTH
,TemporalUnit.DAY_OF_YEAR
. In addition, the fieldTemporalUnit.SECOND
is redefined to include microseconds.- Overrides:
extractPattern
in classDialect
- Parameters:
unit
- the first argument
-
timestampaddPattern
public String timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType) Description copied from class:Dialect
Obtain a pattern for the SQL equivalent to atimestampadd()
function call. The resulting pattern must contain ?1, ?2, and ?3 placeholders for the arguments.- Overrides:
timestampaddPattern
in classDialect
- Parameters:
unit
- The unit to add to the temporaltemporalType
- The type of the temporalintervalType
- The type of interval to add or null if it's not a native interval
-
timestampdiffPattern
public String timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalType, TemporalType toTemporalType) Description copied from class:Dialect
Obtain a pattern for the SQL equivalent to atimestampdiff()
function call. The resulting pattern must contain ?1, ?2, and ?3 placeholders for the arguments.- Overrides:
timestampdiffPattern
in classDialect
- Parameters:
unit
- the first argumentfromTemporalType
- true if the first argument is a timestamp, false if a datetoTemporalType
- true if the second argument is
-
supportsTemporalLiteralOffset
public boolean supportsTemporalLiteralOffset()Description copied from class:Dialect
Does this dialect supports timezone offsets in temporal literals.- Overrides:
supportsTemporalLiteralOffset
in classDialect
-
appendDateTimeLiteral
public void appendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone) Description copied from class:Dialect
Append a datetime literal representing the givenjava.time
value to the givenSqlAppender
.- Overrides:
appendDateTimeLiteral
in classDialect
-
appendDateTimeLiteral
public void appendDateTimeLiteral(SqlAppender appender, Date date, TemporalType precision, TimeZone jdbcTimeZone) Description copied from class:Dialect
Append a datetime literal representing the givenDate
value to the givenSqlAppender
.- Overrides:
appendDateTimeLiteral
in classDialect
-
appendDateTimeLiteral
public void appendDateTimeLiteral(SqlAppender appender, Calendar calendar, TemporalType precision, TimeZone jdbcTimeZone) Description copied from class:Dialect
Append a datetime literal representing the givenCalendar
value to the givenSqlAppender
.- Overrides:
appendDateTimeLiteral
in classDialect
-
getGroupBySelectItemReferenceStrategy
Description copied from class:Dialect
Determine how selected items are referenced in thegroup by
clause.- Overrides:
getGroupBySelectItemReferenceStrategy
in classDialect
-
supportsColumnCheck
public boolean supportsColumnCheck()Description copied from class:Dialect
Does this dialect support column-level check constraints?- Overrides:
supportsColumnCheck
in classDialect
- Returns:
- True if column-level
check
constraints are supported; false otherwise.
-
getEnumTypeDeclaration
Description copied from class:Dialect
If this database has a special MySQL-styleenum
column type, return the type declaration for the given enumeration of values.If the database has no such type, return
null
.- Overrides:
getEnumTypeDeclaration
in classDialect
values
- the enumerated values of the type- Returns:
- the DDL column type declaration
-
getQueryHintString
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 classDialect
- Parameters:
query
- The query to which to apply the hint.hints
- The hints to apply- Returns:
- The modified SQL
-
getSequenceSupport
No support for sequences.- Overrides:
getSequenceSupport
in classDialect
-
getViolatedConstraintNameExtractor
Description copied from class:Dialect
AViolatedConstraintNameExtractor
for extracting the name of a violated constraint from aSQLException
.- Specified by:
getViolatedConstraintNameExtractor
in interfaceConversionContext
- Overrides:
getViolatedConstraintNameExtractor
in classDialect
-
qualifyIndexName
public boolean qualifyIndexName()Description copied from class:Dialect
Do we need to qualify index names with the schema name?- Overrides:
qualifyIndexName
in classDialect
- Returns:
true
if we do
-
getAddForeignKeyConstraintString
public String getAddForeignKeyConstraintString(String constraintName, String[] foreignKey, String referencedTable, String[] primaryKey, boolean referencesPrimaryKey) Description copied from class:Dialect
The syntax used to add a foreign key constraint to a table, with the referenced key columns explicitly specified.- Overrides:
getAddForeignKeyConstraintString
in classDialect
- Parameters:
constraintName
- The foreign key constraint nameforeignKey
- The names of the columns comprising the foreign keyreferencedTable
- The table referenced by the foreign keyprimaryKey
- The explicit columns in the referencedTable referenced by this foreign key.referencesPrimaryKey
- if false, constraint should be explicit about which column names the constraint refers to- Returns:
- the "add FK" fragment
-
getDropForeignKeyString
Description copied from class:Dialect
The subcommand of thealter table
command used to drop a foreign key constraint, usuallydrop constraint
.- Overrides:
getDropForeignKeyString
in classDialect
-
getDropUniqueKeyString
Description copied from class:Dialect
The subcommand of thealter table
command used to drop a unique key constraint.- Overrides:
getDropUniqueKeyString
in classDialect
-
getAlterColumnTypeString
public String getAlterColumnTypeString(String columnName, String columnType, String columnDefinition) Description copied from class:Dialect
The fragment of analter table
command which modifies a column type, or null if column types cannot be modified. Oftenalter column col_name set data type col_type
.- Overrides:
getAlterColumnTypeString
in classDialect
- Parameters:
columnName
- the name of the columncolumnType
- the new type of the columncolumnDefinition
- the full column definition- Returns:
- a fragment to be appended to
alter table
-
supportsAlterColumnType
public boolean supportsAlterColumnType()Description copied from class:Dialect
Does this dialect support modifying the type of an existing column?- Overrides:
supportsAlterColumnType
in classDialect
-
getLimitHandler
Description copied from class:Dialect
Obtain aLimitHandler
that implements pagination support forQuery.setMaxResults(int)
andQuery.setFirstResult(int)
.- Overrides:
getLimitHandler
in classDialect
-
closeQuote
public char closeQuote()Description copied from class:Dialect
The character specific to this dialect used to close a quoted identifier.- Overrides:
closeQuote
in classDialect
- Returns:
- The dialect-specific close quote character.
-
openQuote
public char openQuote()Description copied from class:Dialect
The character specific to this dialect used to begin a quoted identifier. -
canCreateCatalog
public boolean canCreateCatalog()Description copied from class:Dialect
Does this dialect support creating and dropping catalogs?- Overrides:
canCreateCatalog
in classDialect
- Returns:
- True if the dialect supports catalog creation; false otherwise.
-
getCreateCatalogCommand
Description copied from class:Dialect
Get the SQL command used to create the named catalog.- Overrides:
getCreateCatalogCommand
in classDialect
- Parameters:
catalogName
- The name of the catalog to be created.- Returns:
- The creation commands
-
getDropCatalogCommand
Description copied from class:Dialect
Get the SQL command used to drop the named catalog.- Overrides:
getDropCatalogCommand
in classDialect
- Parameters:
catalogName
- The name of the catalog to be dropped.- Returns:
- The drop commands
-
canCreateSchema
public boolean canCreateSchema()Description copied from class:Dialect
Does this dialect support creating and dropping schema?- Overrides:
canCreateSchema
in classDialect
- Returns:
- True if the dialect supports schema creation; false otherwise.
-
getCreateSchemaCommand
Description copied from class:Dialect
Get the SQL command used to create the named schema.- Overrides:
getCreateSchemaCommand
in classDialect
- Parameters:
schemaName
- The name of the schema to be created.- Returns:
- The creation commands
-
getDropSchemaCommand
Description copied from class:Dialect
Get the SQL command used to drop the named schema.- Overrides:
getDropSchemaCommand
in classDialect
- Parameters:
schemaName
- The name of the schema to be dropped.- Returns:
- The drop commands
-
supportsIfExistsBeforeTableName
public boolean supportsIfExistsBeforeTableName()Description copied from class:Dialect
For dropping a table, can the phraseif exists
be applied before the table name?- Overrides:
supportsIfExistsBeforeTableName
in classDialect
- Returns:
true
ifif exists
can be applied before the table name
-
getSelectGUIDString
Description copied from class:Dialect
Get the command used to select a GUID from the database.Optional operation.
- Overrides:
getSelectGUIDString
in classDialect
- Returns:
- The appropriate command.
-
supportsCommentOn
public boolean supportsCommentOn()Description copied from class:Dialect
Does this dialect support commenting on tables and columns?- Overrides:
supportsCommentOn
in classDialect
- Returns:
true
if commenting is supported
-
getTableComment
Description copied from class:Dialect
Get the comment into a form supported for table definition.- Overrides:
getTableComment
in classDialect
- Parameters:
comment
- The comment to apply- Returns:
- The comment fragment
-
getColumnComment
Description copied from class:Dialect
Get the comment into a form supported for column definition.- Overrides:
getColumnComment
in classDialect
- Parameters:
comment
- The comment to apply- Returns:
- The comment fragment
-
getNullOrdering
Description copied from class:Dialect
Returns the default ordering of null.- Overrides:
getNullOrdering
in classDialect
-
getFallbackSqmMutationStrategy
public SqmMultiTableMutationStrategy getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext) Description copied from class:Dialect
TheSqmMultiTableMutationStrategy
to use when not specified byQueryEngineOptions.getCustomSqmMultiTableMutationStrategy()
. -
getFallbackSqmInsertStrategy
public SqmMultiTableInsertStrategy getFallbackSqmInsertStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext) Description copied from class:Dialect
TheSqmMultiTableInsertStrategy
to use when not specified byQueryEngineOptions.getCustomSqmMultiTableInsertStrategy()
. -
getSupportedTemporaryTableKind
Description copied from class:Dialect
The kind of temporary tables that are supported on this database.- Overrides:
getSupportedTemporaryTableKind
in classDialect
-
getTemporaryTableCreateCommand
Description copied from class:Dialect
The command to create a temporary table.- Overrides:
getTemporaryTableCreateCommand
in classDialect
-
getTemporaryTableDropCommand
Description copied from class:Dialect
The command to drop a temporary table.- Overrides:
getTemporaryTableDropCommand
in classDialect
-
getTemporaryTableAfterUseAction
Description copied from class:Dialect
The action to take after finishing use of a temporary table.- Overrides:
getTemporaryTableAfterUseAction
in classDialect
-
getTemporaryTableBeforeUseAction
Description copied from class:Dialect
The action to take before beginning use of a temporary table.- Overrides:
getTemporaryTableBeforeUseAction
in classDialect
-
getMaxAliasLength
public int getMaxAliasLength()Description copied from class:Dialect
What is the maximum length Hibernate can use for generated aliases?- Overrides:
getMaxAliasLength
in classDialect
- Returns:
- The maximum length.
-
getMaxIdentifierLength
public int getMaxIdentifierLength()Description copied from class:Dialect
What is the maximum identifier length supported by this dialect?- Overrides:
getMaxIdentifierLength
in classDialect
- Returns:
- The maximum length.
-
supportsIsTrue
public boolean supportsIsTrue()Description copied from class:Dialect
Does this dialect support theis true
andis false
operators?- Overrides:
supportsIsTrue
in classDialect
- Returns:
true
if the database supportsis true
andis false
, orfalse
if it does not. The default isis false
.
-
supportsCurrentTimestampSelection
public boolean supportsCurrentTimestampSelection()Description copied from class:Dialect
Does this dialect support some way to retrieve the current timestamp value from the database?- Overrides:
supportsCurrentTimestampSelection
in classDialect
- Returns:
- True if the current timestamp can be retrieved; false otherwise.
-
isCurrentTimestampSelectStringCallable
public boolean isCurrentTimestampSelectStringCallable()Description copied from class:Dialect
Is the command returned byDialect.getCurrentTimestampSelectString()
treated as callable?Typically, this indicates the use of the JDBC escape syntax.
- Overrides:
isCurrentTimestampSelectStringCallable
in classDialect
- Returns:
- if the
Dialect.getCurrentTimestampSelectString()
is treated as callable; false otherwise.
-
getCurrentTimestampSelectString
Description copied from class:Dialect
The command used to retrieve the current timestamp from the database.- Overrides:
getCurrentTimestampSelectString
in classDialect
-
registerResultSetOutParameter
Description copied from class:Dialect
Registers a parameter capable of returning aResultSet
by position, either anOUT
parameter, or aREF_CURSOR
parameter as defined in Java 8.- Overrides:
registerResultSetOutParameter
in classDialect
- Parameters:
statement
- The callable statement.col
- The bind position at which to register the output param.- Returns:
- The number of (contiguous) bind positions used.
- Throws:
SQLException
- Indicates problems registering the param.
-
getResultSet
Description copied from class:Dialect
Given a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int)
, extract theResultSet
from theOUT
parameter.- Overrides:
getResultSet
in classDialect
- Parameters:
ps
- The callable statement.- Returns:
- The extracted result set.
- Throws:
SQLException
- Indicates problems extracting the result set.
-
supportsNullPrecedence
public boolean supportsNullPrecedence()Description copied from class:Dialect
Does this dialect supportnulls first
andnulls last
?- Overrides:
supportsNullPrecedence
in classDialect
-
supportsLobValueChangePropagation
public boolean supportsLobValueChangePropagation()Description copied from class:Dialect
Does the dialect support propagating changes to LOB values back to the database? Talking about mutating the internal value of the locator, as opposed to supplying a new locator instance.- For BLOBs, the internal value might be changed by:
Blob.setBinaryStream(long)
,Blob.setBytes(long, byte[])
,Blob.setBytes(long, byte[], int, int)
, orBlob.truncate(long)
. - For CLOBs, the internal value might be changed by:
Clob.setAsciiStream(long)
,Clob.setCharacterStream(long)
,Clob.setString(long, String)
,Clob.setString(long, String, int, int)
, orClob.truncate(long)
.
- Overrides:
supportsLobValueChangePropagation
in classDialect
- Returns:
- True if the changes are propagated back to the database; false otherwise.
- For BLOBs, the internal value might be changed by:
-
supportsSubqueryOnMutatingTable
public boolean supportsSubqueryOnMutatingTable()Description copied from class:Dialect
Does this dialect support referencing the table being mutated in a subquery? The "table being mutated" is the table referenced in an update or delete query. And so can that table then be referenced in a subquery of the update or delete query?For example, would the following two syntaxes be supported:
delete from TABLE_A where ID not in (select ID from TABLE_A)
update TABLE_A set NON_ID = 'something' where ID in (select ID from TABLE_A)
- Overrides:
supportsSubqueryOnMutatingTable
in classDialect
- Returns:
- True if this dialect allows references the mutating table from a subquery.
-
supportsLockTimeouts
public boolean supportsLockTimeouts()Description copied from class:Dialect
Does this dialect support specifying timeouts when requesting locks.- Overrides:
supportsLockTimeouts
in classDialect
- Returns:
- True is this dialect supports specifying lock timeouts.
-
buildSQLExceptionConversionDelegate
Description copied from class:Dialect
An instance ofSQLExceptionConversionDelegate
for interpreting dialect-specific error or SQLState codes.If this method is overridden to return a non-null value, the default
SQLExceptionConverter
will use the returnedSQLExceptionConversionDelegate
in addition to the following standard delegates:- a "static" delegate based on the JDBC4-defined
SQLException
hierarchy, and - a delegate that interprets SQLState codes as either X/Open or SQL-2003 codes, depending on what is reported by the JDBC driver.
It is strongly recommended that every
Dialect
implementation override this method, since interpretation of a SQL error is much more accurate when based on the vendor-specific error code, rather than on the SQLState.- Overrides:
buildSQLExceptionConversionDelegate
in classDialect
- Returns:
- The
SQLExceptionConversionDelegate
for this dialect
- a "static" delegate based on the JDBC4-defined
-
getNameQualifierSupport
Description copied from class:Dialect
The support for qualified identifiers.By default, decide based on
DatabaseMetaData
.- Overrides:
getNameQualifierSupport
in classDialect
- Returns:
- The
NameQualifierSupport
, or null to useDatabaseMetaData
.
-
buildIdentifierHelper
public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuilder builder, DatabaseMetaData dbMetaData) throws SQLException Description copied from class:Dialect
TheIdentifierHelper
indicated by this dialect for handling identifier conversions. Returningnull
is allowed and indicates that Hibernate should fall back to building a "standard" helper. In the fallback path, any changes made to the IdentifierHelperBuilder during this call will still be incorporated into the built IdentifierHelper.The incoming builder will have the following set:
IdentifierHelperBuilder.isGloballyQuoteIdentifiers()
IdentifierHelperBuilder.getUnquotedCaseStrategy()
- initialized to UPPERIdentifierHelperBuilder.getQuotedCaseStrategy()
- initialized to MIXED
By default, Hibernate will do the following:
- Call
IdentifierHelperBuilder.applyIdentifierCasing(DatabaseMetaData)
- Call
IdentifierHelperBuilder.applyReservedWords(DatabaseMetaData)
- Applies
AnsiSqlKeywords.sql2003()
as reserved words - Applies the {#link #sqlKeywords} collected here as reserved words
- Applies the Dialect's
NameQualifierSupport
, if it defines one
- Overrides:
buildIdentifierHelper
in classDialect
- Parameters:
builder
- A partially-configuredIdentifierHelperBuilder
.dbMetaData
- Access to the metadata returned from the driver if needed and if available. WARNING: it may benull
.- Returns:
- The
IdentifierHelper
instance to use, ornull
to indicate Hibernate should use its fallback path - Throws:
SQLException
- Accessing theDatabaseMetaData
can throw it. Just rethrow and Hibernate will handle it.- See Also:
-
getIdentityColumnSupport
Description copied from class:Dialect
Get the appropriateIdentityColumnSupport
for this dialect.- Overrides:
getIdentityColumnSupport
in classDialect
- Returns:
- the IdentityColumnSupport
-
isJdbcLogWarningsEnabledByDefault
public boolean isJdbcLogWarningsEnabledByDefault()Description copied from class:Dialect
Is JDBC statement warning logging enabled by default?- Overrides:
isJdbcLogWarningsEnabledByDefault
in classDialect
-
supportsCascadeDelete
public boolean supportsCascadeDelete()Description copied from class:Dialect
Does this dialect supporton delete
actions in foreign key definitions?- Overrides:
supportsCascadeDelete
in classDialect
- Returns:
true
if the dialect does support theon delete
clause.
-
getTableTypeString
Description copied from class:Dialect
An arbitrary fragment appended to the end of thecreate table
statement.- Overrides:
getTableTypeString
in classDialect
-
hasSelfReferentialForeignKeyBug
public boolean hasSelfReferentialForeignKeyBug()Description copied from class:Dialect
Does the database/driver have bug in deleting rows that refer to other rows being deleted in the same query?- Overrides:
hasSelfReferentialForeignKeyBug
in classDialect
- Returns:
true
if the database/driver has this bug
-
dropConstraints
public boolean dropConstraints()Description copied from class:Dialect
Do we need to drop constraints before dropping tables in this dialect?- Overrides:
dropConstraints
in classDialect
- Returns:
- True if constraints must be dropped prior to dropping the table; false otherwise.
-
getDefaultMySQLStorageEngine
-
appendLiteral
Description copied from class:Dialect
Append a literal string to the givenSqlAppender
.- Overrides:
appendLiteral
in classDialect
-
appendDatetimeFormat
Description copied from class:Dialect
Translate the given datetime format string from the pattern language defined by Java'sDateTimeFormatter
to whatever pattern language is understood by the native datetime formatting function for this database (often theto_char()
function).Since it's never possible to translate every pattern letter sequences understood by
DateTimeFormatter
, only the following subset of pattern letters is accepted by Hibernate:- G: era
- y: year of era
- Y: year of week-based year
- M: month of year
- w: week of week-based year (ISO week number)
- W: week of month
- E: day of week (name)
- e: day of week (number)
- d: day of month
- D: day of year
- a: AM/PM
- H: hour of day (24 hour time)
- h: hour of AM/PM (12 hour time)
- m: minutes
- s: seconds
- z,Z,x: timezone offset
In addition, punctuation characters and single-quoted literal strings are accepted.
Appends a pattern accepted by the function that formats dates and times in this dialect to a SQL fragment that is being constructed.
- Overrides:
appendDatetimeFormat
in classDialect
-
datetimeFormat
-
getWriteLockString
Description copied from class:Dialect
Get the string to append toSELECT
statements to acquire pessimistic WRITE locks for this dialect.Location of the returned string is treated the same as
Dialect.getForUpdateString()
.- Overrides:
getWriteLockString
in classDialect
- Parameters:
timeout
- in milliseconds, -1 for indefinite wait and 0 for no wait.- Returns:
- The appropriate
LOCK
clause string.
-
getWriteLockString
Description copied from class:Dialect
Get the string to append toSELECT
statements to acquire WRITE locks for this dialect, given the aliases of the columns to be write locked.Location of the returned string is treated the same as
Dialect.getForUpdateString()
.- Overrides:
getWriteLockString
in classDialect
- Parameters:
aliases
- The columns to be read locked.timeout
- in milliseconds, -1 for indefinite wait and 0 for no wait.- Returns:
- The appropriate
LOCK
clause string.
-
getReadLockString
Description copied from class:Dialect
Get the string to append toSELECT
statements to acquire READ locks for this dialect.Location of the returned string is treated the same as
Dialect.getForUpdateString()
.- Overrides:
getReadLockString
in classDialect
- Parameters:
timeout
- in milliseconds, -1 for indefinite wait and 0 for no wait.- Returns:
- The appropriate
LOCK
clause string.
-
getReadLockString
Description copied from class:Dialect
Get the string to append toSELECT
statements to acquire READ locks for this dialect, given the aliases of the columns to be read locked.Location of the returned string is treated the same as
Dialect.getForUpdateString()
.- Overrides:
getReadLockString
in classDialect
- Parameters:
aliases
- The columns to be read locked.timeout
- in milliseconds, -1 for indefinite wait and 0 for no wait.- Returns:
- The appropriate
LOCK
clause string.
-
getForUpdateSkipLockedString
Description copied from class:Dialect
Retrieves theFOR UPDATE SKIP LOCKED
syntax specific to this dialect.- Overrides:
getForUpdateSkipLockedString
in classDialect
- Returns:
- The appropriate
FOR UPDATE SKIP LOCKED
clause string.
-
getForUpdateSkipLockedString
Description copied from class:Dialect
Get theFOR UPDATE OF column_list SKIP LOCKED
fragment appropriate for this dialect, given the aliases of the columns to be write locked.- Overrides:
getForUpdateSkipLockedString
in classDialect
- Parameters:
aliases
- The columns to be write locked.- Returns:
- The appropriate
FOR UPDATE colunm_list SKIP LOCKED
clause string.
-
getForUpdateNowaitString
Description copied from class:Dialect
Retrieves theFOR UPDATE NOWAIT
syntax specific to this dialect.- Overrides:
getForUpdateNowaitString
in classDialect
- Returns:
- The appropriate
FOR UPDATE NOWAIT
clause string.
-
getForUpdateNowaitString
Description copied from class:Dialect
Get theFOR UPDATE OF column_list NOWAIT
fragment appropriate for this dialect, given the aliases of the columns to be write locked.- Overrides:
getForUpdateNowaitString
in classDialect
- Parameters:
aliases
- The columns to be write locked.- Returns:
- The appropriate
FOR UPDATE OF colunm_list NOWAIT
clause string.
-
getForUpdateString
Description copied from class:Dialect
Get theFOR UPDATE OF column_list
fragment appropriate for this dialect, given the aliases of the columns to be write locked.- Overrides:
getForUpdateString
in classDialect
- Parameters:
aliases
- The columns to be write locked.- Returns:
- The appropriate
FOR UPDATE OF column_list
clause string.
-
supportsOffsetInSubquery
public boolean supportsOffsetInSubquery()Description copied from class:Dialect
Does this dialect supportoffset
in subqueries?For example:
select * from Table1 where col1 in (select col1 from Table2 order by col2 limit 1 offset 1)
- Overrides:
supportsOffsetInSubquery
in classDialect
- Returns:
true
if it does
-
supportsWindowFunctions
public boolean supportsWindowFunctions()Description copied from class:Dialect
Does this dialect support window functions likerow_number() over (..)
?- Overrides:
supportsWindowFunctions
in classDialect
- Returns:
true
if the underlying database supports window functions,false
otherwise. The default isfalse
.
-
supportsLateral
public boolean supportsLateral()Description copied from class:Dialect
Does this dialect support the SQLlateral
keyword or a proprietary alternative?- Overrides:
supportsLateral
in classDialect
- Returns:
true
if the underlying database supports lateral,false
otherwise. The default isfalse
.
-
supportsRecursiveCTE
public boolean supportsRecursiveCTE()Description copied from class:Dialect
Does this dialect/database support recursive CTEs?- Overrides:
supportsRecursiveCTE
in classDialect
- Returns:
true
if recursive CTEs are supported
-
supportsSkipLocked
public boolean supportsSkipLocked()Description copied from class:Dialect
Does this dialect supportSKIP_LOCKED
timeout.- Overrides:
supportsSkipLocked
in classDialect
- Returns:
true
if SKIP_LOCKED is supported
-
supportsNoWait
public boolean supportsNoWait()Description copied from class:Dialect
Does this dialect supportNO_WAIT
timeout.- Overrides:
supportsNoWait
in classDialect
- Returns:
true
ifNO_WAIT
is supported
-
supportsWait
public boolean supportsWait()Description copied from class:Dialect
Does this dialect supportWAIT
timeout.- Overrides:
supportsWait
in classDialect
- Returns:
true
ifWAIT
is supported
-
getWriteRowLockStrategy
Description copied from class:Dialect
The row lock strategy to use for write locks.- Overrides:
getWriteRowLockStrategy
in classDialect
-
registerDefaultKeywords
protected void registerDefaultKeywords()Description copied from class:Dialect
Register the reserved words of ANSI-standard SQL as keywords.- Overrides:
registerDefaultKeywords
in classDialect
- See Also:
-
getFunctionalDependencyAnalysisSupport
Description copied from class:Dialect
Get this dialect's level of support for primary key functional dependency analysis withinGROUP BY
andORDER BY
clauses.- Overrides:
getFunctionalDependencyAnalysisSupport
in classDialect
-
canDisableConstraints
public boolean canDisableConstraints()Description copied from class:Dialect
Is there some way to disable foreign key constraint checking while truncating tables? (If there's no way to do it, and if we can't batch truncate, we must drop and recreate the constraints instead.)- Overrides:
canDisableConstraints
in classDialect
- Returns:
true
if there is some way to do it- See Also:
-
getDisableConstraintsStatement
Description copied from class:Dialect
A SQL statement that temporarily disables foreign key constraint checking for all tables.- Overrides:
getDisableConstraintsStatement
in classDialect
-
getEnableConstraintsStatement
Description copied from class:Dialect
A SQL statement that re-enables foreign key constraint checking for all tables.- Overrides:
getEnableConstraintsStatement
in classDialect
-
getDmlTargetColumnQualifierSupport
Description copied from class:Dialect
Get the minimumDmlTargetColumnQualifierSupport
required by this dialect.- Overrides:
getDmlTargetColumnQualifierSupport
in classDialect
- Returns:
- the column qualifier support required by this dialect
-
supportsFromClauseInUpdate
public boolean supportsFromClauseInUpdate()Description copied from class:Dialect
Does this dialect support thefrom
clause for update statements?- Overrides:
supportsFromClauseInUpdate
in classDialect
- Returns:
true
iffrom
clause is supported
-