Class MySQLDialect
- java.lang.Object
-
- org.hibernate.dialect.Dialect
-
- org.hibernate.dialect.MySQLDialect
-
- All Implemented Interfaces:
ConversionContext
- Direct Known Subclasses:
MariaDBDialect
,MySQL55Dialect
,MySQL57Dialect
,MySQL5Dialect
,MySQL8Dialect
,TiDBDialect
public class MySQLDialect extends Dialect
A SQL dialect for MySQL 5 and above.
-
-
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_DEFAULT_BATCH_LOAD_SIZING_STRATEGY, STREAM_XFER_LOB_MERGE_STRATEGY
-
-
Constructor Summary
Constructors Constructor Description MySQLDialect()
MySQLDialect(DatabaseVersion version)
MySQLDialect(DialectResolutionInfo info)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
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
appendLiteral(SqlAppender appender, String literal)
IdentifierHelper
buildIdentifierHelper(IdentifierHelperBuilder builder, DatabaseMetaData dbMetaData)
Build the IdentifierHelper indicated by this Dialect for handling identifier conversions.SQLExceptionConversionDelegate
buildSQLExceptionConversionDelegate()
Build an instance of aSQLExceptionConversionDelegate
for interpreting dialect-specific error or SQLState codes.boolean
canCreateCatalog()
Does this dialect support catalog creation?boolean
canCreateSchema()
Does this dialect support schema creation?String
castPattern(CastType from, CastType to)
Obtain a pattern for the SQL equivalent to acast()
function call.protected String
castType(int sqlTypeCode)
char
closeQuote()
The character specific to this dialect used to close a quoted identifier.protected String
columnType(int sqlTypeCode)
void
contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
Allows the Dialect to contribute additional typesString
currentTimestamp()
MySQL 5.7 precision defaults to seconds, but microseconds is betterstatic Replacer
datetimeFormat(String format)
boolean
dropConstraints()
Do we need to drop constraints before dropping tables in this dialect?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().String
getAddForeignKeyConstraintString(String constraintName, String[] foreignKey, String referencedTable, String[] primaryKey, boolean referencesPrimaryKey)
The syntax used to add a foreign key constraint to a table.protected static int
getCharacterSetBytesPerCharacter(DatabaseMetaData databaseMetaData)
String
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 catalogString[]
getCreateSchemaCommand(String schemaName)
Get the SQL command used to create the named schemaString
getCurrentTimestampSelectString()
Retrieve the command used to retrieve the current timestamp from the database.long
getDefaultLobLength()
protected MySQLStorageEngine
getDefaultMySQLStorageEngine()
String[]
getDropCatalogCommand(String catalogName)
Get the SQL command used to drop the named catalogString
getDropForeignKeyString()
String[]
getDropSchemaCommand(String schemaName)
Get the SQL command used to drop the named schemaSqmMultiTableInsertStrategy
getFallbackSqmInsertStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)
SqmMultiTableMutationStrategy
getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)
int
getFloatPrecision()
This is the default precision for a generated column mapped to a JavaFloat
orfloat
.String
getForUpdateNowaitString()
Retrieves theFOR UPDATE NOWAIT
syntax specific to this dialect.String
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.String
getForUpdateSkipLockedString()
Retrieves theFOR UPDATE SKIP LOCKED
syntax specific to this dialect.String
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.String
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
getFractionalSecondPrecisionInNanos()
microsecond
is the smallest unit fortimestampadd()
andtimestampdiff()
, and the highest precision for atimestamp
.SelectItemReferenceStrategy
getGroupBySelectItemReferenceStrategy()
IdentityColumnSupport
getIdentityColumnSupport()
Get the appropriateIdentityColumnSupport
LimitHandler
getLimitHandler()
Returns aLimitHandler
that implements support forQuery.setMaxResults(int)
andQuery.setFirstResult(int)
for this dialect.int
getMaxAliasLength()
What is the maximum length Hibernate can use for generated aliases?int
getMaxIdentifierLength()
What is the maximum identifier length supported by the dialect?int
getMaxVarbinaryLength()
The longest possible length of aTypes.VARBINARY
-like column.int
getMaxVarcharLength()
The longest possible length of aTypes.VARCHAR
-like column.DatabaseVersion
getMySQLVersion()
NameQualifierSupport
getNameQualifierSupport()
By default interpret this based on DatabaseMetaData.String
getNullColumnString(String columnType)
The keyword used to specify a nullable column.NullOrdering
getNullOrdering()
Returns the ordering of null.int
getPreferredSqlTypeCodeForBoolean()
The JDBCtype code
to use for mapping properties of Java typeboolean
.String
getQueryHintString(String query, String hints)
Apply a hint to the query.String
getReadLockString(int timeout)
Get the string to append to SELECT statements to acquire READ locks for this dialect.String
getReadLockString(String aliases, int timeout)
Get the string to append to SELECT statements to acquire READ locks for this dialect given the aliases of the columns to be read locked.ResultSet
getResultSet(CallableStatement ps)
Given a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int)
, extract theResultSet
from the OUT parameter.String
getSelectGUIDString()
Get the command used to select a GUID from the underlying database.SequenceSupport
getSequenceSupport()
No support for sequences.Dialect.SizeStrategy
getSizeStrategy()
SqlAstTranslatorFactory
getSqlAstTranslatorFactory()
Return an SqlAstTranslatorFactory specific for the Dialect.TemporaryTableKind
getSupportedTemporaryTableKind()
String
getTableComment(String comment)
Get the comment into a form supported for table definition.String
getTableTypeString()
org.hibernate.query.sqm.mutation.internal.temptable.AfterUseAction
getTemporaryTableAfterUseAction()
org.hibernate.query.sqm.mutation.internal.temptable.BeforeUseAction
getTemporaryTableBeforeUseAction()
String
getTemporaryTableCreateCommand()
String
getTemporaryTableDropCommand()
UniqueDelegate
getUniqueDelegate()
Get the UniqueDelegate supported by this dialectViolatedConstraintNameExtractor
getViolatedConstraintNameExtractor()
String
getWriteLockString(int timeout)
Get the string to append to SELECT statements to acquire WRITE locks for this dialect.String
getWriteLockString(String aliases, int timeout)
Get the string to append to SELECT statements to acquire WRITE locks for this dialect given the aliases of the columns to be write locked.RowLockStrategy
getWriteRowLockStrategy()
The row lock strategy to use for write locks.boolean
hasSelfReferentialForeignKeyBug()
Does the database/driver have bug in deleting rows that refer to other rows being deleted in the same query?protected void
initDefaultProperties()
Set appropriate default values for configuration properties.void
initializeFunctionRegistry(QueryEngine queryEngine)
Initialize the given registry with any dialect-specific functions.boolean
isCurrentTimestampSelectStringCallable()
Should the value returned byDialect.getCurrentTimestampSelectString()
be treated as callable.boolean
isJdbcLogWarningsEnabledByDefault()
Is JDBC statement warning logging enabled by default?char
openQuote()
The character specific to this dialect used to begin a quoted identifier.boolean
qualifyIndexName()
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()
.int
registerResultSetOutParameter(CallableStatement statement, int col)
Registers a parameter (either OUT, or the new REF_CURSOR param type available in Java 8) capable of returningResultSet
*by position*.JdbcType
resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry)
boolean
supportsCascadeDelete()
Does this dialect support cascaded delete on foreign key definitions?boolean
supportsColumnCheck()
Does this dialect support column-level check constraints?boolean
supportsCurrentTimestampSelection()
Does this dialect support a way to retrieve the database's current timestamp value?boolean
supportsIfExistsBeforeTableName()
For dropping a table, can the phrase "if exists" be applied before the table name?boolean
supportsLateral()
Does this dialect support the SQL lateral keyword or a proprietary alternative?boolean
supportsLobValueChangePropagation()
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
supportsLockTimeouts()
Informational metadata about whether this dialect is known to support specifying timeouts for requested lock acquisitions.boolean
supportsNoWait()
Does this dialect/database support NO_WAIT timeout.boolean
supportsNullPrecedence()
boolean
supportsOffsetInSubquery()
Does this dialect support offset in subqueries? Ex: select * from Table1 where col1 in (select col1 from Table2 order by col2 limit 1 offset 1)boolean
supportsSkipLocked()
Does this dialect/database support SKIP_LOCKED timeout.boolean
supportsSubqueryOnMutatingTable()
Does this dialect support referencing the table being mutated in a subquery.boolean
supportsUnionAll()
Does this dialect support UNION ALL.boolean
supportsWait()
Does this dialect/database support WAIT timeout.boolean
supportsWindowFunctions()
Does this dialect support window functions likerow_number() over (..)
?String
timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType)
Obtain a pattern for the SQL equivalent to atimestampadd()
function call.String
timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalType, TemporalType toTemporalType)
Obtain a pattern for the SQL equivalent to atimestampdiff()
function call.-
Methods inherited from class org.hibernate.dialect.Dialect
addSqlHintOrComment, appendBinaryLiteral, appendBooleanValueString, appendDateTimeLiteral, appendDateTimeLiteral, appendDateTimeLiteral, appendIntervalLiteral, appendLockHint, applyLocksToSql, augmentPhysicalTableTypes, augmentRecognizedTableTypes, currentDate, currentLocalTime, currentLocalTimestamp, currentTime, currentTimestampWithTimeZone, defaultScrollMode, doesReadCommittedCauseWritersToBlockReaders, doesRepeatableReadCauseReadersToBlockWriters, equivalentTypes, escapeComment, forceLobAsLastValue, generatedAs, getAddColumnString, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAlterTableString, getAuxiliaryDatabaseObjectExporter, getBooleanCheckCondition, getCallableStatementSupport, getCascadeConstraintsString, getCaseInsensitiveLike, getColumnAliasExtractor, getCreateMultisetTableString, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getCurrentSchemaCommand, getDefaultBatchLoadSizingStrategy, getDefaultDecimalPrecision, getDefaultNonContextualLobCreation, getDefaultProperties, getDefaultStatementBatchSize, getDefaultTimestampPrecision, getDefaultUseGetGeneratedKeys, getDoublePrecision, getDropTableString, getEnumCheckCondition, getForeignKeyExporter, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getHqlTranslator, getIndexExporter, getInExpressionCountLimit, getKeywords, getLobMergeStrategy, getLockingStrategy, getLockRowIdentifier, getLowercaseFunction, getMaxNVarcharLength, getNationalizationSupport, getNativeIdentifierGeneratorStrategy, getNoColumnsInsertString, getNullColumnString, getQueryHintString, getQuerySequencesString, getReadRowLockStrategy, getResultSet, getResultSet, getSchemaNameResolver, getSelectClauseNullString, getSequenceExporter, getSequenceInformationExtractor, getSqmTranslatorFactory, getTableExporter, getTemporaryTableCreateOptions, getTemporaryTableDdlTransactionHandling, getTemporaryTableExporter, getTemporaryTableTruncateCommand, getTimeZoneSupport, getUniqueKeyExporter, getVersion, hasAlterTable, hasDataTypeBeforeGeneratedAs, inlineLiteral, isAnsiNullOn, isEmptyStringTreatedAsNull, isLockTimeoutParameterized, prependComment, quote, registerDefaultKeywords, registerKeyword, registerKeywords, registerResultSetOutParameter, requiresFloatCastingOfIntegerDivision, requiresParensForTupleCounts, requiresParensForTupleDistinctCounts, resolveSqlTypeLength, supportsBindAsCallableArgument, supportsBitType, supportsCaseInsensitiveLike, supportsCircularCascadeDeleteConstraints, supportsCommentOn, supportsExistsInSelect, supportsExpectedLobUsagePattern, supportsFetchClause, supportsFractionalTimestampArithmetic, supportsIfExistsAfterAlterTable, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsBeforeConstraintName, supportsJdbcConnectionLobCreation, supportsNamedParameters, supportsNoColumnsInsert, supportsNonQueryWithCTE, supportsOrderByInSubquery, supportsOrdinalSelectItemReference, supportsOuterJoinForUpdate, supportsParametersInInsertSelect, supportsPartitionBy, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsSubqueryInSelect, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTemporalLiteralOffset, supportsTemporaryTablePrimaryKey, supportsTemporaryTables, supportsTruncateWithCast, supportsTupleCounts, supportsTupleDistinctCounts, supportsUnboundedLobLocatorMaterialization, supportsUnionInSubquery, supportsValuesList, supportsValuesListForInsert, toBooleanValueString, toString, transformSelectString, translateDurationField, translateExtractField, trimPattern, useFollowOnLocking, useInputStreamToInsertBlob
-
-
-
-
Constructor Detail
-
MySQLDialect
public MySQLDialect()
-
MySQLDialect
public MySQLDialect(DatabaseVersion version)
-
MySQLDialect
public MySQLDialect(DialectResolutionInfo info)
-
-
Method Detail
-
initDefaultProperties
protected void initDefaultProperties()
Description copied from class:Dialect
Set appropriate default values for configuration properties.- Overrides:
initDefaultProperties
in classDialect
-
columnType
protected String columnType(int sqlTypeCode)
Description copied from class:Dialect
The 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.- Overrides:
columnType
in classDialect
- Parameters:
sqlTypeCode
- a SQL type code- Returns:
- a column type name, with $l, $p, $s placeholders for length, precision, scale
- See Also:
SqlTypes
-
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
protected static int getCharacterSetBytesPerCharacter(DatabaseMetaData databaseMetaData)
-
getMaxVarcharLength
public int getMaxVarcharLength()
Description copied from class:Dialect
The longest possible length of aTypes.VARCHAR
-like column. For longer column lengths, use some sort oftext
-like type for the column.- Overrides:
getMaxVarcharLength
in classDialect
-
getMaxVarbinaryLength
public int getMaxVarbinaryLength()
Description copied from class:Dialect
The longest possible length of aTypes.VARBINARY
-like column. For longer column lengths, use some sort ofimage
-like type for the column.- Overrides:
getMaxVarbinaryLength
in classDialect
-
getNullColumnString
public String getNullColumnString(String columnType)
Description copied from class:Dialect
The keyword used to specify a nullable column.- Overrides:
getNullColumnString
in classDialect
- Returns:
- String
-
getMySQLVersion
public DatabaseVersion getMySQLVersion()
-
getSizeStrategy
public Dialect.SizeStrategy getSizeStrategy()
- Overrides:
getSizeStrategy
in classDialect
-
getDefaultLobLength
public long getDefaultLobLength()
- Overrides:
getDefaultLobLength
in classDialect
-
resolveSqlTypeDescriptor
public JdbcType resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry)
- Overrides:
resolveSqlTypeDescriptor
in classDialect
-
getPreferredSqlTypeCodeForBoolean
public int getPreferredSqlTypeCodeForBoolean()
Description copied from class:Dialect
The JDBCtype 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
public void initializeFunctionRegistry(QueryEngine queryEngine)
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
- 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])
- 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])
- log10(arg)
- sign(arg)
- sin(arg)
- cos(arg)
- tan(arg)
- asin(arg)
- acos(arg)
- atan(arg)
- atan2(arg0, arg1)
- round(arg0, arg1)
- least(arg0, arg1, ...)
- greatest(arg0, arg1, ...)
- format(datetime as pattern)
- collate(string as collation)
- str(arg) - synonym of cast(a as String)
- ifnull(arg0, arg1) - synonym of coalesce(a, b)
- second(arg) - synonym of extract(second from a)
- minute(arg) - synonym of extract(minute from a)
- hour(arg) - synonym of extract(hour from a)
- day(arg) - synonym of extract(day from a)
- month(arg) - synonym of extract(month from a)
- year(arg) - synonym of extract(year from a)
- Overrides:
initializeFunctionRegistry
in classDialect
-
contributeTypes
public void contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
Description copied from class:Dialect
Allows the Dialect to contribute additional types- Overrides:
contributeTypes
in classDialect
- Parameters:
typeContributions
- Callback to contribute the typesserviceRegistry
- The service registry
-
getSqlAstTranslatorFactory
public SqlAstTranslatorFactory getSqlAstTranslatorFactory()
Description copied from class:Dialect
Return an SqlAstTranslatorFactory specific for the Dialect. Returnnull
to use Hibernate's standard translator.- Overrides:
getSqlAstTranslatorFactory
in classDialect
- See Also:
StandardSqlAstTranslatorFactory
,JdbcEnvironment.getSqlAstTranslatorFactory()
-
castPattern
public String castPattern(CastType from, CastType to)
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
public String 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:
TemporalUnit.NATIVE
-
extractPattern
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 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
-
supportsUnionAll
public boolean supportsUnionAll()
Description copied from class:Dialect
Does this dialect support UNION ALL.- Overrides:
supportsUnionAll
in classDialect
- Returns:
- True if UNION ALL is supported; false otherwise.
-
getGroupBySelectItemReferenceStrategy
public SelectItemReferenceStrategy getGroupBySelectItemReferenceStrategy()
- 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.
-
getQueryHintString
public String getQueryHintString(String query, String hints)
Description copied from class:Dialect
Apply a hint to the query. The entire query is provided, allowing the Dialect 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
public SequenceSupport getSequenceSupport()
No support for sequences.- Overrides:
getSequenceSupport
in classDialect
-
getViolatedConstraintNameExtractor
public ViolatedConstraintNameExtractor getViolatedConstraintNameExtractor()
- 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:
- boolean
-
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.- Overrides:
getAddForeignKeyConstraintString
in classDialect
- Parameters:
constraintName
- The FK constraint name.foreignKey
- The names of the columns comprising the FKreferencedTable
- The table referenced by the FKprimaryKey
- The explicit columns in the referencedTable referenced by this FK.referencesPrimaryKey
- if false, constraint should be explicit about which column names the constraint refers to- Returns:
- the "add FK" fragment
-
getDropForeignKeyString
public String getDropForeignKeyString()
- Overrides:
getDropForeignKeyString
in classDialect
-
getLimitHandler
public LimitHandler getLimitHandler()
Description copied from class:Dialect
Returns aLimitHandler
that implements support forQuery.setMaxResults(int)
andQuery.setFirstResult(int)
for this dialect.- 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's 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 catalog creation?- Overrides:
canCreateCatalog
in classDialect
- Returns:
- True if the dialect supports catalog creation; false otherwise.
-
getCreateCatalogCommand
public String[] getCreateCatalogCommand(String catalogName)
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
public String[] getDropCatalogCommand(String catalogName)
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 schema creation?- Overrides:
canCreateSchema
in classDialect
- Returns:
- True if the dialect supports schema creation; false otherwise.
-
getCreateSchemaCommand
public String[] getCreateSchemaCommand(String schemaName)
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
public String[] getDropSchemaCommand(String schemaName)
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 phrase "if exists" be applied before the table name? NOTE : Only one or the other (or neither) of this andDialect.supportsIfExistsAfterTableName()
should return true- Overrides:
supportsIfExistsBeforeTableName
in classDialect
- Returns:
true
if the "if exists" can be applied before the table name
-
getSelectGUIDString
public String getSelectGUIDString()
Description copied from class:Dialect
Get the command used to select a GUID from the underlying database. Optional operation.- Overrides:
getSelectGUIDString
in classDialect
- Returns:
- The appropriate command.
-
getTableComment
public String getTableComment(String comment)
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
public String getColumnComment(String comment)
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
public NullOrdering getNullOrdering()
Description copied from class:Dialect
Returns the ordering of null.- Overrides:
getNullOrdering
in classDialect
-
getFallbackSqmMutationStrategy
public SqmMultiTableMutationStrategy getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)
- Overrides:
getFallbackSqmMutationStrategy
in classDialect
-
getFallbackSqmInsertStrategy
public SqmMultiTableInsertStrategy getFallbackSqmInsertStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)
- Overrides:
getFallbackSqmInsertStrategy
in classDialect
-
getSupportedTemporaryTableKind
public TemporaryTableKind getSupportedTemporaryTableKind()
- Overrides:
getSupportedTemporaryTableKind
in classDialect
-
getTemporaryTableCreateCommand
public String getTemporaryTableCreateCommand()
- Overrides:
getTemporaryTableCreateCommand
in classDialect
-
getTemporaryTableDropCommand
public String getTemporaryTableDropCommand()
- Overrides:
getTemporaryTableDropCommand
in classDialect
-
getTemporaryTableAfterUseAction
public org.hibernate.query.sqm.mutation.internal.temptable.AfterUseAction getTemporaryTableAfterUseAction()
- Overrides:
getTemporaryTableAfterUseAction
in classDialect
-
getTemporaryTableBeforeUseAction
public org.hibernate.query.sqm.mutation.internal.temptable.BeforeUseAction getTemporaryTableBeforeUseAction()
- Overrides:
getTemporaryTableBeforeUseAction
in classDialect
-
getMaxAliasLength
public int getMaxAliasLength()
Description copied from class:Dialect
What is the maximum length Hibernate can use for generated aliases? The maximum here should account for the fact that Hibernate often needs to append "uniqueing" information to the end of generated aliases. That "uniqueing" information will be added to the end of a identifier generated to the length specified here; so be sure to leave some room (generally speaking 5 positions will suffice).- 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 the dialect?- Overrides:
getMaxIdentifierLength
in classDialect
- Returns:
- The maximum length.
-
supportsCurrentTimestampSelection
public boolean supportsCurrentTimestampSelection()
Description copied from class:Dialect
Does this dialect support a way to retrieve the database's current timestamp value?- Overrides:
supportsCurrentTimestampSelection
in classDialect
- Returns:
- True if the current timestamp can be retrieved; false otherwise.
-
isCurrentTimestampSelectStringCallable
public boolean isCurrentTimestampSelectStringCallable()
Description copied from class:Dialect
Should the value returned byDialect.getCurrentTimestampSelectString()
be treated as callable. Typically this indicates that JDBC escape syntax is being used...- Overrides:
isCurrentTimestampSelectStringCallable
in classDialect
- Returns:
- True if the
Dialect.getCurrentTimestampSelectString()
return is callable; false otherwise.
-
getCurrentTimestampSelectString
public String getCurrentTimestampSelectString()
Description copied from class:Dialect
Retrieve the command used to retrieve the current timestamp from the database.- Overrides:
getCurrentTimestampSelectString
in classDialect
- Returns:
- The command.
-
registerResultSetOutParameter
public int registerResultSetOutParameter(CallableStatement statement, int col) throws SQLException
Description copied from class:Dialect
Registers a parameter (either OUT, or the new REF_CURSOR param type available in Java 8) capable of returningResultSet
*by position*. Pre-Java 8, registering such ResultSet-returning parameters varied greatly across database and drivers; hence its inclusion as part of the Dialect contract.- 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
public ResultSet getResultSet(CallableStatement ps) throws SQLException
Description copied from class:Dialect
Given a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int)
, extract theResultSet
from the OUT parameter.- Overrides:
getResultSet
in classDialect
- Parameters:
ps
- The callable statement.- Returns:
- The extracted result set.
- Throws:
SQLException
- Indicates problems extracting the result set.
-
getUniqueDelegate
public UniqueDelegate getUniqueDelegate()
Description copied from class:Dialect
Get the UniqueDelegate supported by this dialect- Overrides:
getUniqueDelegate
in classDialect
- Returns:
- The UniqueDelegate
-
supportsNullPrecedence
public boolean supportsNullPrecedence()
- 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)
. NOTE : I do not know the correct answer currently for databases which (1) are not part of the cruise control process or (2) do notDialect.supportsExpectedLobUsagePattern()
.- Overrides:
supportsLobValueChangePropagation
in classDialect
- Returns:
- True if the changes are propagated back to the database; false otherwise.
-
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 a DELETE query. And so can that table then be referenced in a subquery of said UPDATE/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
Informational metadata about whether this dialect is known to support specifying timeouts for requested lock acquisitions.- Overrides:
supportsLockTimeouts
in classDialect
- Returns:
- True is this dialect supports specifying lock timeouts.
-
buildSQLExceptionConversionDelegate
public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate()
Description copied from class:Dialect
Build an instance of aSQLExceptionConversionDelegate
for interpreting dialect-specific error or SQLState codes. If this method is overridden to return a non-null value, the defaultSQLExceptionConverter
will use the returnedSQLExceptionConversionDelegate
in addition to the following standard delegates:- a "static" delegate based on the JDBC 4 defined SQLException hierarchy;
- a delegate that interprets SQLState codes for either X/Open or SQL-2003 codes, depending on java.sql.DatabaseMetaData#getSQLStateType
- Overrides:
buildSQLExceptionConversionDelegate
in classDialect
- Returns:
- The SQLExceptionConversionDelegate for this dialect
-
getNameQualifierSupport
public NameQualifierSupport getNameQualifierSupport()
Description copied from class:Dialect
By default interpret this based on DatabaseMetaData.- Overrides:
getNameQualifierSupport
in classDialect
- Returns:
- The NameQualifierSupport.
-
buildIdentifierHelper
public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuilder builder, DatabaseMetaData dbMetaData) throws SQLException
Description copied from class:Dialect
Build the IdentifierHelper indicated by this Dialect for handling identifier conversions. Returningnull
is allowed and indicates that Hibernate should fallback 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
- 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 semi-configured IdentifierHelper builder.dbMetaData
- Access to the metadata returned from the driver if needed and if available. WARNING: may benull
- Returns:
- The IdentifierHelper instance to use, or
null
to indicate Hibernate should use its fallback path - Throws:
SQLException
- Accessing the DatabaseMetaData can throw it. Just re-throw and Hibernate will handle.- See Also:
Dialect.getNameQualifierSupport()
-
getIdentityColumnSupport
public IdentityColumnSupport getIdentityColumnSupport()
Description copied from class:Dialect
Get the appropriateIdentityColumnSupport
- 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 support cascaded delete on foreign key definitions?- Overrides:
supportsCascadeDelete
in classDialect
- Returns:
true
indicates that the dialect does support cascaded delete on foreign keys.
-
getTableTypeString
public String getTableTypeString()
- 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
protected MySQLStorageEngine getDefaultMySQLStorageEngine()
-
appendLiteral
public void appendLiteral(SqlAppender appender, String literal)
- Overrides:
appendLiteral
in classDialect
-
appendDatetimeFormat
public void appendDatetimeFormat(SqlAppender appender, String format)
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 all of the 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
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
-
getWriteLockString
public String getWriteLockString(int timeout)
Description copied from class:Dialect
Get the string to append to SELECT statements to acquire WRITE locks for this dialect. Location of the returned string is treated the same as 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
public String getWriteLockString(String aliases, int timeout)
Description copied from class:Dialect
Get the string to append to SELECT statements to acquire WRITE locks for this dialect given the aliases of the columns to be write locked. Location of the of the returned string is treated the same as 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
public String getReadLockString(int timeout)
Description copied from class:Dialect
Get the string to append to SELECT statements to acquire READ locks for this dialect. Location of the returned string is treated the same as 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
public String getReadLockString(String aliases, int timeout)
Description copied from class:Dialect
Get the string to append to SELECT 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 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
public 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
public String getForUpdateSkipLockedString(String aliases)
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
public 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
public String getForUpdateNowaitString(String aliases)
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
public String getForUpdateString(String aliases)
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 support offset in subqueries? Ex: select * from Table1 where col1 in (select col1 from Table2 order by col2 limit 1 offset 1)- Overrides:
supportsOffsetInSubquery
in classDialect
- Returns:
- boolean
-
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 SQL lateral keyword or a proprietary alternative?- Overrides:
supportsLateral
in classDialect
- Returns:
true
if the underlying database supports lateral,false
otherwise. The default isfalse
.
-
supportsSkipLocked
public boolean supportsSkipLocked()
Description copied from class:Dialect
Does this dialect/database support SKIP_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/database support NO_WAIT timeout.- Overrides:
supportsNoWait
in classDialect
- Returns:
true
if NO_WAIT is supported
-
supportsWait
public boolean supportsWait()
Description copied from class:Dialect
Does this dialect/database support WAIT timeout.- Overrides:
supportsWait
in classDialect
- Returns:
true
if WAIT is supported
-
getWriteRowLockStrategy
public RowLockStrategy getWriteRowLockStrategy()
Description copied from class:Dialect
The row lock strategy to use for write locks.- Overrides:
getWriteRowLockStrategy
in classDialect
-
-