Package org.hibernate.dialect

Class MySQLDialect

java.lang.Object
org.hibernate.dialect.Dialect
org.hibernate.dialect.MySQLDialect
All Implemented Interfaces:
FunctionContributor, TypeContributor, ConversionContext
Direct Known Subclasses:
MariaDBDialect, TiDBDialect
public class MySQLDialect extends Dialect
A SQL dialect for MySQL 5.7 and above.

  • Constructor Details

  • Method Details

    • createVersion

      @Deprecated protected static DatabaseVersion createVersion(DialectResolutionInfo info)
      Deprecated.

    • createVersion

      protected static DatabaseVersion createVersion(DialectResolutionInfo info, DatabaseVersion defaultVersion)

    • getMinimumSupportedVersion

      protected DatabaseVersion getMinimumSupportedVersion()
      Description copied from class: Dialect
      Get the version of the SQL dialect that is the minimum supported by this implementation.
      Overrides:
      getMinimumSupportedVersion in class Dialect

    • 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(), and Dialect.getDefaultUseGetGeneratedKeys().

      An implementation may set additional configuration properties, but this is discouraged.

      Overrides:
      initDefaultProperties in class Dialect

    • columnType

      protected String columnType(int sqlTypeCode)
      Description copied from class: Dialect
      The database column type name for a given JDBC type code defined in Types or SqlTypes. This default implementation returns the ANSI-standard type name.

      This method may be overridden by concrete Dialects as an alternative to Dialect.registerColumnTypes(TypeContributions, ServiceRegistry) for simple registrations.

      Note that:

      1. Implementations of this method are expected to define a sensible mapping forTypes.NCLOB Types.NCHAR, and Types.NVARCHAR. On some database, these types are simply remapped to CLOB, CHAR, and VARCHAR.
      2. Mappings for Types.TIMESTAMP and Types.TIMESTAMP_WITH_TIMEZONE should support explicit specification of precision if possible.
      3. As specified by DdlTypeRegistry.getDescriptor(int), this method never receives Types.LONGVARCHAR, Types.LONGNVARCHAR, nor Types.LONGVARBINARY, which are considered synonyms for their non-LONG counterparts.
      4. On the other hand, the types SqlTypes.LONG32VARCHAR, SqlTypes.LONG32NVARCHAR, and SqlTypes.LONG32VARBINARY are not synonyms, and implementations of this method must define sensible mappings, for example to database-native TEXT or CLOB types.
      Overrides:
      columnType in class Dialect
      Parameters:
      sqlTypeCode - a SQL type code
      Returns:
      a column type name, with $l, $p, $s placeholders for length, precision, scale
      See Also:

    • useMaterializedLobWhenCapacityExceeded

      public boolean useMaterializedLobWhenCapacityExceeded()
      Description copied from class: Dialect
      Whether to switch:
      Overrides:
      useMaterializedLobWhenCapacityExceeded in class Dialect
      Returns:
      true if materialized LOBs should be used for capacity exceeding types.

    • castType

      protected String castType(int sqlTypeCode)
      Description copied from class: Dialect
      The SQL type to use in cast( ... as ... ) expressions when casting to the target type represented by the given JDBC type code.
      Overrides:
      castType in class Dialect
      Parameters:
      sqlTypeCode - The JDBC type code representing the target type
      Returns:
      The SQL type to use in cast()

    • registerColumnTypes

      protected void registerColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
      Description copied from class: Dialect
      Register ANSI-standard column types using the length limits defined by Dialect.getMaxVarcharLength(), Dialect.getMaxNVarcharLength(), and Dialect.getMaxVarbinaryLength().

      This method is always called when a Dialect is instantiated.

      Overrides:
      registerColumnTypes in class Dialect

    • 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 a Types.VARCHAR-like type.

      For longer column lengths, use some sort of text-like type for the column.

      Overrides:
      getMaxVarcharLength in class Dialect

    • getMaxVarbinaryLength

      public int getMaxVarbinaryLength()
      Description copied from class: Dialect
      The biggest size value that can be supplied as argument to a Types.VARBINARY-like type.

      For longer column lengths, use some sort of image-like type for the column.

      Overrides:
      getMaxVarbinaryLength in class Dialect

    • isNoBackslashEscapesEnabled

      public boolean isNoBackslashEscapesEnabled()

    • getNullColumnString

      public String getNullColumnString(String columnType)
      Description copied from class: Dialect
      The keyword used to specify a nullable column of the given SQL type.
      Overrides:
      getNullColumnString in class Dialect

    • getMySQLVersion

      public DatabaseVersion getMySQLVersion()

    • getSizeStrategy

      public Dialect.SizeStrategy getSizeStrategy()
      Description copied from class: Dialect
      A custom Dialect.SizeStrategy for column types.
      Overrides:
      getSizeStrategy in class Dialect

    • getDefaultLobLength

      public long getDefaultLobLength()
      Description copied from class: Dialect
      This is the default length for a generated column of type BLOB or CLOB mapped to Blob or Clob, if LOB columns have a length in this dialect.
      Overrides:
      getDefaultLobLength in class Dialect
      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 appropriate JdbcType to a column of a JDBC result set based on the column type name, JDBC type code, precision, and scale.
      Overrides:
      resolveSqlTypeDescriptor in class Dialect
      Parameters:
      columnTypeName - the column type name
      jdbcTypeCode - the type code
      precision - the precision or 0
      scale - 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 JDBC ResultSetMetaData. Note that what JDBC reports as a "precision" might actually be the column length.
      Overrides:
      resolveSqlTypeLength in class Dialect
      Parameters:
      columnTypeName - the name of the column type
      jdbcTypeCode - the JDBC type code of the column type
      precision - the (numeric) precision or (character) length of the column
      scale - the scale of a numeric column
      displaySize - 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 type boolean.

      Usually Types.BOOLEAN or Types.BIT.

      Overrides:
      getPreferredSqlTypeCodeForBoolean in class Dialect
      Returns:
      one of the type codes defined by Types.

    • initializeFunctionRegistry

      public void initializeFunctionRegistry(FunctionContributions functionContributions)
      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
      Along with an additional set of functions defined by ANSI SQL:
      • 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])
      And the following functions for working with java.time types:
      • local date
      • local time
      • local datetime
      • offset datetime
      • instant
      And a number of additional "standard" functions:
      • 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 of cast(a as String)
      • ifnull(arg0, arg1) - synonym of coalesce(a, b)
      Finally, the following functions are defined as abbreviations for extract(), and desugared by the parser:
      • 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)
      Note that according to this definition, the 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 class Dialect

    • contributeTypes

      public void contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
      Description copied from class: Dialect
      A callback which allows the Dialect to contribute types.
      Overrides:
      contributeTypes in class Dialect
      Parameters:
      typeContributions - Callback to contribute the types
      serviceRegistry - The service registry

    • getSqlAstTranslatorFactory

      public SqlAstTranslatorFactory getSqlAstTranslatorFactory()
      Description copied from class: Dialect
      Return a SqlAstTranslatorFactory specific to this dialect, or null to use the standard translator.
      Overrides:
      getSqlAstTranslatorFactory in class Dialect
      See Also:

    • castPattern

      public String castPattern(CastType from, CastType to)
      Description copied from class: Dialect
      Obtain a pattern for the SQL equivalent to a cast() function call. The resulting pattern must contain ?1 and ?2 placeholders for the arguments.
      Overrides:
      castPattern in class Dialect
      Parameters:
      from - a CastType indicating the type of the value argument
      to - a CastType indicating the type the value argument is cast to

    • getFloatPrecision

      public int getFloatPrecision()
      Description copied from class: Dialect
      This is the default precision for a generated column mapped to a Java Float or float. 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 class Dialect
      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 class Dialect

    • getFractionalSecondPrecisionInNanos

      public long getFractionalSecondPrecisionInNanos()
      microsecond is the smallest unit for timestampadd() and timestampdiff(), and the highest precision for a timestamp.
      Overrides:
      getFractionalSecondPrecisionInNanos in class Dialect
      Returns:
      the precision, specified as a quantity of nanoseconds
      See Also:

    • 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 are TemporalUnit.DAY_OF_YEAR, TemporalUnit.DAY_OF_MONTH, TemporalUnit.DAY_OF_YEAR. In addition, the field TemporalUnit.SECOND is redefined to include microseconds.
      Overrides:
      extractPattern in class Dialect
      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 a timestampadd() function call. The resulting pattern must contain ?1, ?2, and ?3 placeholders for the arguments.
      Overrides:
      timestampaddPattern in class Dialect
      Parameters:
      unit - The unit to add to the temporal
      temporalType - The type of the temporal
      intervalType - 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 a timestampdiff() function call. The resulting pattern must contain ?1, ?2, and ?3 placeholders for the arguments.
      Overrides:
      timestampdiffPattern in class Dialect
      Parameters:
      unit - the first argument
      fromTemporalType - true if the first argument is a timestamp, false if a date
      toTemporalType - 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 class Dialect

    • appendDateTimeLiteral

      public void appendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone)
      Description copied from class: Dialect
      Append a datetime literal representing the given java.time value to the given SqlAppender.
      Overrides:
      appendDateTimeLiteral in class Dialect

    • appendDateTimeLiteral

      public void appendDateTimeLiteral(SqlAppender appender, Date date, TemporalType precision, TimeZone jdbcTimeZone)
      Description copied from class: Dialect
      Append a datetime literal representing the given Date value to the given SqlAppender.
      Overrides:
      appendDateTimeLiteral in class Dialect

    • appendDateTimeLiteral

      public void appendDateTimeLiteral(SqlAppender appender, Calendar calendar, TemporalType precision, TimeZone jdbcTimeZone)
      Description copied from class: Dialect
      Append a datetime literal representing the given Calendar value to the given SqlAppender.
      Overrides:
      appendDateTimeLiteral in class Dialect

    • getGroupBySelectItemReferenceStrategy

      public SelectItemReferenceStrategy getGroupBySelectItemReferenceStrategy()
      Description copied from class: Dialect
      Determine how selected items are referenced in the group by clause.
      Overrides:
      getGroupBySelectItemReferenceStrategy in class Dialect

    • supportsColumnCheck

      public boolean supportsColumnCheck()
      Description copied from class: Dialect
      Does this dialect support column-level check constraints?
      Overrides:
      supportsColumnCheck in class Dialect
      Returns:
      True if column-level check constraints are supported; false otherwise.

    • getEnumTypeDeclaration

      public String getEnumTypeDeclaration(String name, String[] values)
      Description copied from class: Dialect
      If this database has a special MySQL-style enum column type, return the type declaration for the given enumeration of values.

      If the database has no such type, return null.

      Overrides:
      getEnumTypeDeclaration in class Dialect
      values - the enumerated values of the type
      Returns:
      the DDL column type declaration

    • getQueryHintString

      public String getQueryHintString(String query, String hints)
      Description copied from class: Dialect
      Apply a hint to the given SQL query.

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

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

      Overrides:
      getQueryHintString in class Dialect
      Parameters:
      query - The query to which to apply the hint.
      hints - The hints to apply
      Returns:
      The modified SQL

    • getSequenceSupport

      public SequenceSupport getSequenceSupport()
      No support for sequences.
      Overrides:
      getSequenceSupport in class Dialect

    • getViolatedConstraintNameExtractor

      public ViolatedConstraintNameExtractor getViolatedConstraintNameExtractor()
      Description copied from class: Dialect
      A ViolatedConstraintNameExtractor for extracting the name of a violated constraint from a SQLException.
      Specified by:
      getViolatedConstraintNameExtractor in interface ConversionContext
      Overrides:
      getViolatedConstraintNameExtractor in class Dialect

    • qualifyIndexName

      public boolean qualifyIndexName()
      Description copied from class: Dialect
      Do we need to qualify index names with the schema name?
      Overrides:
      qualifyIndexName in class Dialect
      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 class Dialect
      Parameters:
      constraintName - The foreign key constraint name
      foreignKey - The names of the columns comprising the foreign key
      referencedTable - The table referenced by the foreign key
      primaryKey - 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

      public String getDropForeignKeyString()
      Description copied from class: Dialect
      The subcommand of the alter table command used to drop a foreign key constraint, usually drop constraint.
      Overrides:
      getDropForeignKeyString in class Dialect

    • getDropUniqueKeyString

      public String getDropUniqueKeyString()
      Description copied from class: Dialect
      The subcommand of the alter table command used to drop a unique key constraint.
      Overrides:
      getDropUniqueKeyString in class Dialect

    • getAlterColumnTypeString

      public String getAlterColumnTypeString(String columnName, String columnType, String columnDefinition)
      Description copied from class: Dialect
      The fragment of an alter table command which modifies a column type, or null if column types cannot be modified. Often alter column col_name set data type col_type.
      Overrides:
      getAlterColumnTypeString in class Dialect
      Parameters:
      columnName - the name of the column
      columnType - the new type of the column
      columnDefinition - 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 class Dialect

    • getLimitHandler

      public LimitHandler getLimitHandler()
      Description copied from class: Dialect
      Obtain a LimitHandler that implements pagination support for Query.setMaxResults(int) and Query.setFirstResult(int).
      Overrides:
      getLimitHandler in class Dialect

    • closeQuote

      public char closeQuote()
      Description copied from class: Dialect
      The character specific to this dialect used to close a quoted identifier.
      Overrides:
      closeQuote in class Dialect
      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.
      Overrides:
      openQuote in class Dialect
      Returns:
      The dialect-specific open quote character.

    • canCreateCatalog

      public boolean canCreateCatalog()
      Description copied from class: Dialect
      Does this dialect support creating and dropping catalogs?
      Overrides:
      canCreateCatalog in class Dialect
      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 class Dialect
      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 class Dialect
      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 class Dialect
      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 class Dialect
      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 class Dialect
      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?
      Overrides:
      supportsIfExistsBeforeTableName in class Dialect
      Returns:
      true if 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 database.

      Optional operation.

      Overrides:
      getSelectGUIDString in class Dialect
      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 class Dialect
      Returns:
      true if commenting is supported

    • getTableComment

      public String getTableComment(String comment)
      Description copied from class: Dialect
      Get the comment into a form supported for table definition.
      Overrides:
      getTableComment in class Dialect
      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 class Dialect
      Parameters:
      comment - The comment to apply
      Returns:
      The comment fragment

    • getNullOrdering

      public NullOrdering getNullOrdering()
      Description copied from class: Dialect
      Returns the default ordering of null.
      Overrides:
      getNullOrdering in class Dialect

    • getFallbackSqmMutationStrategy

      public SqmMultiTableMutationStrategy getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)
      Description copied from class: Dialect
      The SqmMultiTableMutationStrategy to use when not specified by QueryEngineOptions.getCustomSqmMultiTableMutationStrategy().
      Overrides:
      getFallbackSqmMutationStrategy in class Dialect
      See Also:

    • getFallbackSqmInsertStrategy

      public SqmMultiTableInsertStrategy getFallbackSqmInsertStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)
      Description copied from class: Dialect
      The SqmMultiTableInsertStrategy to use when not specified by QueryEngineOptions.getCustomSqmMultiTableInsertStrategy().
      Overrides:
      getFallbackSqmInsertStrategy in class Dialect
      See Also:

    • getSupportedTemporaryTableKind

      public TemporaryTableKind getSupportedTemporaryTableKind()
      Description copied from class: Dialect
      The kind of temporary tables that are supported on this database.
      Overrides:
      getSupportedTemporaryTableKind in class Dialect

    • getTemporaryTableCreateCommand

      public String getTemporaryTableCreateCommand()
      Description copied from class: Dialect
      The command to create a temporary table.
      Overrides:
      getTemporaryTableCreateCommand in class Dialect

    • getTemporaryTableDropCommand

      public String getTemporaryTableDropCommand()
      Description copied from class: Dialect
      The command to drop a temporary table.
      Overrides:
      getTemporaryTableDropCommand in class Dialect

    • getTemporaryTableAfterUseAction

      public AfterUseAction getTemporaryTableAfterUseAction()
      Description copied from class: Dialect
      The action to take after finishing use of a temporary table.
      Overrides:
      getTemporaryTableAfterUseAction in class Dialect

    • getTemporaryTableBeforeUseAction

      public BeforeUseAction getTemporaryTableBeforeUseAction()
      Description copied from class: Dialect
      The action to take before beginning use of a temporary table.
      Overrides:
      getTemporaryTableBeforeUseAction in class Dialect

    • getMaxAliasLength

      public int getMaxAliasLength()
      Description copied from class: Dialect
      What is the maximum length Hibernate can use for generated aliases?
      Overrides:
      getMaxAliasLength in class Dialect
      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 class Dialect
      Returns:
      The maximum length.

    • supportsIsTrue

      public boolean supportsIsTrue()
      Description copied from class: Dialect
      Does this dialect support the is true and is false operators?
      Overrides:
      supportsIsTrue in class Dialect
      Returns:
      true if the database supports is true and is false, or false if it does not. The default is is 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 class Dialect
      Returns:
      True if the current timestamp can be retrieved; false otherwise.

    • isCurrentTimestampSelectStringCallable

      public boolean isCurrentTimestampSelectStringCallable()
      Description copied from class: Dialect
      Is the command returned by Dialect.getCurrentTimestampSelectString() treated as callable?

      Typically, this indicates the use of the JDBC escape syntax.

      Overrides:
      isCurrentTimestampSelectStringCallable in class Dialect
      Returns:
      if the Dialect.getCurrentTimestampSelectString() is treated as callable; false otherwise.

    • getCurrentTimestampSelectString

      public String getCurrentTimestampSelectString()
      Description copied from class: Dialect
      The command used to retrieve the current timestamp from the database.
      Overrides:
      getCurrentTimestampSelectString in class Dialect

    • registerResultSetOutParameter

      public int registerResultSetOutParameter(CallableStatement statement, int col) throws SQLException
      Description copied from class: Dialect
      Registers a parameter capable of returning a ResultSet by position, either an OUT parameter, or a REF_CURSOR parameter as defined in Java 8.
      Overrides:
      registerResultSetOutParameter in class Dialect
      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 by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet from the OUT parameter.
      Overrides:
      getResultSet in class Dialect
      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 support nulls first and nulls last?
      Overrides:
      supportsNullPrecedence in class Dialect

    • 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.
      Overrides:
      supportsLobValueChangePropagation in class Dialect
      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 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 class Dialect
      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 class Dialect
      Returns:
      True is this dialect supports specifying lock timeouts.

    • buildSQLExceptionConversionDelegate

      public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate()
      Description copied from class: Dialect
      An instance of SQLExceptionConversionDelegate 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 returned SQLExceptionConversionDelegate in addition to the following standard delegates:

      1. a "static" delegate based on the JDBC4-defined SQLException hierarchy, and
      2. 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 class Dialect
      Returns:
      The SQLExceptionConversionDelegate for this dialect

    • getNameQualifierSupport

      public NameQualifierSupport getNameQualifierSupport()
      Description copied from class: Dialect
      The support for qualified identifiers.

      By default, decide based on DatabaseMetaData.

      Overrides:
      getNameQualifierSupport in class Dialect
      Returns:
      The NameQualifierSupport, or null to use DatabaseMetaData.

    • buildIdentifierHelper

      public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuilder builder, DatabaseMetaData dbMetaData) throws SQLException
      Description copied from class: Dialect
      The IdentifierHelper indicated by this dialect for handling identifier conversions. Returning null 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:

      By default, Hibernate will do the following:

      Overrides:
      buildIdentifierHelper in class Dialect
      Parameters:
      builder - A partially-configured IdentifierHelperBuilder.
      dbMetaData - Access to the metadata returned from the driver if needed and if available. WARNING: it may be null.
      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 rethrow and Hibernate will handle it.
      See Also:

    • getIdentityColumnSupport

      public IdentityColumnSupport getIdentityColumnSupport()
      Description copied from class: Dialect
      Get the appropriate IdentityColumnSupport for this dialect.
      Overrides:
      getIdentityColumnSupport in class Dialect
      Returns:
      the IdentityColumnSupport

    • isJdbcLogWarningsEnabledByDefault

      public boolean isJdbcLogWarningsEnabledByDefault()
      Description copied from class: Dialect
      Is JDBC statement warning logging enabled by default?
      Overrides:
      isJdbcLogWarningsEnabledByDefault in class Dialect

    • supportsCascadeDelete

      public boolean supportsCascadeDelete()
      Description copied from class: Dialect
      Does this dialect support on delete actions in foreign key definitions?
      Overrides:
      supportsCascadeDelete in class Dialect
      Returns:
      true if the dialect does support the on delete clause.

    • getTableTypeString

      public String getTableTypeString()
      Description copied from class: Dialect
      An arbitrary fragment appended to the end of the create table statement.
      Overrides:
      getTableTypeString in class Dialect

    • 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 class Dialect
      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 class Dialect
      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)
      Description copied from class: Dialect
      Append a literal string to the given SqlAppender.
      Overrides:
      appendLiteral in class Dialect

    • 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's DateTimeFormatter to whatever pattern language is understood by the native datetime formatting function for this database (often the to_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 class Dialect

    • datetimeFormat

      public static Replacer datetimeFormat(String format)

    • getWriteLockString

      public String getWriteLockString(int timeout)
      Description copied from class: Dialect
      Get the string to append to SELECT statements to acquire pessimistic WRITE locks for this dialect.

      Location of the returned string is treated the same as Dialect.getForUpdateString().

      Overrides:
      getWriteLockString in class Dialect
      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 returned string is treated the same as Dialect.getForUpdateString().

      Overrides:
      getWriteLockString in class Dialect
      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 Dialect.getForUpdateString().

      Overrides:
      getReadLockString in class Dialect
      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 Dialect.getForUpdateString().

      Overrides:
      getReadLockString in class Dialect
      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 the FOR UPDATE SKIP LOCKED syntax specific to this dialect.
      Overrides:
      getForUpdateSkipLockedString in class Dialect
      Returns:
      The appropriate FOR UPDATE SKIP LOCKED clause string.

    • getForUpdateSkipLockedString

      public String getForUpdateSkipLockedString(String aliases)
      Description copied from class: Dialect
      Get the FOR UPDATE OF column_list SKIP LOCKED fragment appropriate for this dialect, given the aliases of the columns to be write locked.
      Overrides:
      getForUpdateSkipLockedString in class Dialect
      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 the FOR UPDATE NOWAIT syntax specific to this dialect.
      Overrides:
      getForUpdateNowaitString in class Dialect
      Returns:
      The appropriate FOR UPDATE NOWAIT clause string.

    • getForUpdateNowaitString

      public String getForUpdateNowaitString(String aliases)
      Description copied from class: Dialect
      Get the FOR UPDATE OF column_list NOWAIT fragment appropriate for this dialect, given the aliases of the columns to be write locked.
      Overrides:
      getForUpdateNowaitString in class Dialect
      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 the FOR UPDATE OF column_list fragment appropriate for this dialect, given the aliases of the columns to be write locked.
      Overrides:
      getForUpdateString in class Dialect
      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?

      For example: 

       select * from Table1 where col1 in (select col1 from Table2 order by col2 limit 1 offset 1)
      Overrides:
      supportsOffsetInSubquery in class Dialect
      Returns:
      true if it does

    • supportsWindowFunctions

      public boolean supportsWindowFunctions()
      Description copied from class: Dialect
      Does this dialect support window functions like row_number() over (..)?
      Overrides:
      supportsWindowFunctions in class Dialect
      Returns:
      true if the underlying database supports window functions, false otherwise. The default is false.

    • supportsLateral

      public boolean supportsLateral()
      Description copied from class: Dialect
      Does this dialect support the SQL lateral keyword or a proprietary alternative?
      Overrides:
      supportsLateral in class Dialect
      Returns:
      true if the underlying database supports lateral, false otherwise. The default is false.

    • supportsRecursiveCTE

      public boolean supportsRecursiveCTE()
      Description copied from class: Dialect
      Does this dialect/database support recursive CTEs?
      Overrides:
      supportsRecursiveCTE in class Dialect
      Returns:
      true if recursive CTEs are supported

    • supportsSkipLocked

      public boolean supportsSkipLocked()
      Description copied from class: Dialect
      Does this dialect support SKIP_LOCKED timeout.
      Overrides:
      supportsSkipLocked in class Dialect
      Returns:
      true if SKIP_LOCKED is supported

    • supportsNoWait

      public boolean supportsNoWait()
      Description copied from class: Dialect
      Does this dialect support NO_WAIT timeout.
      Overrides:
      supportsNoWait in class Dialect
      Returns:
      true if NO_WAIT is supported

    • supportsWait

      public boolean supportsWait()
      Description copied from class: Dialect
      Does this dialect support WAIT timeout.
      Overrides:
      supportsWait in class Dialect
      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 class Dialect

    • registerDefaultKeywords

      protected void registerDefaultKeywords()
      Description copied from class: Dialect
      Register the reserved words of ANSI-standard SQL as keywords.
      Overrides:
      registerDefaultKeywords in class Dialect
      See Also:

    • getFunctionalDependencyAnalysisSupport

      public FunctionalDependencyAnalysisSupport getFunctionalDependencyAnalysisSupport()
      Description copied from class: Dialect
      Get this dialect's level of support for primary key functional dependency analysis within GROUP BY and ORDER BY clauses.
      Overrides:
      getFunctionalDependencyAnalysisSupport in class Dialect

    • 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 class Dialect
      Returns:
      true if there is some way to do it
      See Also:

    • getDisableConstraintsStatement

      public String getDisableConstraintsStatement()
      Description copied from class: Dialect
      A SQL statement that temporarily disables foreign key constraint checking for all tables.
      Overrides:
      getDisableConstraintsStatement in class Dialect

    • getEnableConstraintsStatement

      public String getEnableConstraintsStatement()
      Description copied from class: Dialect
      A SQL statement that re-enables foreign key constraint checking for all tables.
      Overrides:
      getEnableConstraintsStatement in class Dialect

    • getDmlTargetColumnQualifierSupport

      public DmlTargetColumnQualifierSupport getDmlTargetColumnQualifierSupport()
      Description copied from class: Dialect
      Get the minimum DmlTargetColumnQualifierSupport required by this dialect.
      Overrides:
      getDmlTargetColumnQualifierSupport in class Dialect
      Returns:
      the column qualifier support required by this dialect

    • supportsFromClauseInUpdate

      public boolean supportsFromClauseInUpdate()
      Description copied from class: Dialect
      Does this dialect support the from clause for update statements?
      Overrides:
      supportsFromClauseInUpdate in class Dialect
      Returns:
      true if from clause is supported

    • appendCheckConstraintOptions

      public String appendCheckConstraintOptions(CheckConstraint checkConstraint, String sqlCheckConstraint)
      Description copied from class: Dialect
      Append the CheckConstraint options to SQL check sqlCheckConstraint
      Overrides:
      appendCheckConstraintOptions in class Dialect
      Parameters:
      checkConstraint - an instance of CheckConstraint
      sqlCheckConstraint - the SQL to append the CheckConstraint options
      Returns:
      a SQL expression