Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Constructor Details

• DB2Dialect

  public DB2Dialect()

• DB2Dialect

  public DB2Dialect(DialectResolutionInfo info)

• DB2Dialect

  public DB2Dialect(DatabaseVersion version)

Method Details

• 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

• getDB2Version

  public DatabaseVersion getDB2Version()

  DB2 LUW Version

• getTableExporter

  public Exporter<Table> getTableExporter()

  Description copied from class: Dialect

  Get anExporter forTables, usuallyStandardTableExporter.

  Overrides:

  getTableExporter in class Dialect

• getDefaultStatementBatchSize

  public int getDefaultStatementBatchSize()

  Description copied from class: Dialect

  The default value to use for the configuration property"hibernate.jdbc.batch_size".

  Overrides:

  getDefaultStatementBatchSize 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 inTypes orSqlTypes. This default implementation returns the ANSI-standard type name.

  This method may be overridden by concreteDialects as an alternative toDialect.registerColumnTypes(TypeContributions, ServiceRegistry) for simple registrations.

  Note that:

  1. Implementations of this method are expected to define a sensible mapping forTypes.NCLOBTypes.NCHAR, andTypes.NVARCHAR. On some database, these types are simply remapped toCLOB,CHAR, andVARCHAR.
  2. Mappings forTypes.TIMESTAMP andTypes.TIMESTAMP_WITH_TIMEZONE should support explicit specification of precision if possible.
  3. As specified byDdlTypeRegistry.getDescriptor(int), this method never receivesTypes.LONGVARCHAR,Types.LONGNVARCHAR, norTypes.LONGVARBINARY, which are considered synonyms for their non-LONG counterparts.
  4. On the other hand, the typesSqlTypes.LONG32VARCHAR,SqlTypes.LONG32NVARCHAR, andSqlTypes.LONG32VARBINARY arenot synonyms, and implementations of this method must define sensible mappings, for example to database-nativeTEXT orCLOB types.

  Overrides:

  columnType in class Dialect

  Parameters:

  sqlTypeCode - a SQLtype 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 aDialect is instantiated.

  Overrides:

  registerColumnTypes in class Dialect

• createUniqueDelegate

  protected UniqueDelegate createUniqueDelegate()

• getMaxVarcharLength

  public int getMaxVarcharLength()

  Description copied from class: Dialect

  The biggest size value that can be supplied as argument to aTypes.VARCHAR-like type.

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

  Overrides:

  getMaxVarcharLength in class Dialect

• getDefaultDecimalPrecision

  public int getDefaultDecimalPrecision()

  Description copied from class: Dialect

  This is the default precision for a generated column of exact numeric typeDECIMAL orNUMERIC mapped to aBigInteger orBigDecimal.

  Usually returns the maximum precision of the database, except when there is no such maximum precision, or the maximum precision is very high.

  Overrides:

  getDefaultDecimalPrecision in class Dialect

  Returns:

  the default precision, in decimal digits

  See Also:

  • BigDecimalJavaType
  • BigIntegerJavaType

• supportsUserDefinedTypes

  public boolean supportsUserDefinedTypes()

  Description copied from class: Dialect

  Does the database support user defined types?

  Overrides:

  supportsUserDefinedTypes in class Dialect

  See Also:

  • Struct

• supportsPredicateAsExpression

  protected boolean supportsPredicateAsExpression()

  Description copied from class: Dialect

  Whether a predicate likea > 0 can appear in an expression context, for example, in aselect list item.

  Overrides:

  supportsPredicateAsExpression in class Dialect

• supportsDistinctFromPredicate

  public boolean supportsDistinctFromPredicate()

  Description copied from class: Dialect

  Does this dialect support some kind ofdistinct from predicate?

  That is, does it support syntax like:

   ... where FIRST_NAME IS DISTINCT FROM LAST_NAME

  Overrides:

  supportsDistinctFromPredicate in class Dialect

  Returns:

  True if this SQL dialect is known to support some kind ofdistinct from predicate; false otherwise

• 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 withjava.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 ofcast(a as String)
  • ifnull(arg0, arg1) - synonym ofcoalesce(a, b)

  Finally, the following functions are defined as abbreviations forextract(), and desugared by the parser:

  • second(arg) - synonym ofextract(second from a)
  • minute(arg) - synonym ofextract(minute from a)
  • hour(arg) - synonym ofextract(hour from a)
  • day(arg) - synonym ofextract(day from a)
  • month(arg) - synonym ofextract(month from a)
  • year(arg) - synonym ofextract(year from a)

  Note that according to this definition, thesecond() 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

• getMaximumSeriesSize

  protected int getMaximumSeriesSize()

  DB2 doesn't support thegenerate_series function orlateral recursive CTEs, so it has to be emulated with a top level recursive CTE which requires an upper bound on the amount of elements that the series can return.

• getPreferredSqlTypeCodeForArray

  public int getPreferredSqlTypeCodeForArray()

  Description copied from class: Dialect

  The JDBCtype code to use for mapping properties of basic Java array orCollection types.

  UsuallySqlTypes.ARRAY orSqlTypes.VARBINARY.

  Overrides:

  getPreferredSqlTypeCodeForArray in class Dialect

  Returns:

  one of the type codes defined bySqlTypes.

• 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

• getFractionalSecondPrecisionInNanos

  public long getFractionalSecondPrecisionInNanos()

  Since we're usingseconds_between() andadd_seconds(), it makes sense to use seconds as the "native" precision.

  Overrides:

  getFractionalSecondPrecisionInNanos in class Dialect

  Returns:

  the precision, specified as a quantity of nanoseconds

  See Also:

  • TemporalUnit.NATIVE

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

• timestampdiffPatternV10

  public static String timestampdiffPatternV10(TemporalUnit unit,TemporalType fromTemporalType,TemporalType toTemporalType)

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

• appendDateTimeLiteral

  public void appendDateTimeLiteral(SqlAppender appender,TemporalAccessor temporalAccessor,TemporalType precision,TimeZone jdbcTimeZone)

  Description copied from class: Dialect

  Append a datetime literal representing the givenjava.time value to the givenSqlAppender.

  Overrides:

  appendDateTimeLiteral in 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 givenDate value to the givenSqlAppender.

  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 givenCalendar value to the givenSqlAppender.

  Overrides:

  appendDateTimeLiteral in class Dialect

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

• getCreateIndexTail

  public String getCreateIndexTail(boolean unique,List<Column> columns)

  Description copied from class: Dialect

  A string to be appended to the end of thecreate index command, usually to specify thatnull values are to be considered distinct.

  Overrides:

  getCreateIndexTail in class Dialect

• getSequenceSupport

  public SequenceSupport getSequenceSupport()

  Description copied from class: Dialect

  Get the appropriateSequenceSupport for this dialect.

  Overrides:

  getSequenceSupport in class Dialect

• getQuerySequencesString

  public String getQuerySequencesString()

  Description copied from class: Dialect

  Get theselect command used retrieve the names of all sequences.

  Overrides:

  getQuerySequencesString in class Dialect

  Returns:

  The select command; or null if sequences are not supported.

• getSequenceInformationExtractor

  public SequenceInformationExtractor getSequenceInformationExtractor()

  Description copied from class: Dialect

  ASequenceInformationExtractor which is able to extractSequenceInformation from the JDBC result set returned whenDialect.getQuerySequencesString() is executed.

  Overrides:

  getSequenceInformationExtractor in class Dialect

• getForUpdateString

  public String getForUpdateString()

  Description copied from class: Dialect

  Get the string to append toSELECT statements to acquire pessimistic UPGRADE locks for this dialect.

  Overrides:

  getForUpdateString in class Dialect

  Returns:

  The appropriateFOR UPDATE clause string.

• supportsSkipLocked

  public boolean supportsSkipLocked()

  Description copied from class: Dialect

  Does this dialect supportSKIP_LOCKED timeout.

  Overrides:

  supportsSkipLocked in class Dialect

  Returns:

  true if SKIP_LOCKED is supported

• getForUpdateSkipLockedString

  public String getForUpdateSkipLockedString()

  Description copied from class: Dialect

  Retrieves theFOR UPDATE SKIP LOCKED syntax specific to this dialect.

  Overrides:

  getForUpdateSkipLockedString in class Dialect

  Returns:

  The appropriateFOR 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 class Dialect

  Parameters:

  aliases - The columns to be write locked.

  Returns:

  The appropriateFOR UPDATE colunm_list SKIP LOCKED clause string.

• getWriteLockString

  public String getWriteLockString(Timeout timeout)

  Description copied from class: Dialect

  Get the string to append toSELECT statements to acquire pessimistic WRITE locks for this dialect.

  Overrides:

  getWriteLockString in class Dialect

  Parameters:

  timeout - How long the database should wait to acquire the lock. SeeTimeouts for some "magic values".

  Returns:

  The appropriate lock clause.

• getReadLockString

  public String getReadLockString(Timeout timeout)

  Description copied from class: Dialect

  Get the string to append toSELECT statements to acquire READ locks for this dialect.

  Overrides:

  getReadLockString in class Dialect

  Parameters:

  timeout - How long the database should wait to acquire the lock. SeeTimeouts for some "magic values".

  Returns:

  The appropriateLOCK clause string.

• getWriteLockString

  public String getWriteLockString(int timeout)

  Description copied from class: Dialect

  Get the string to append toSELECT statements to acquire pessimistic WRITE locks for this dialect.

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

  Overrides:

  getWriteLockString in class Dialect

  Parameters:

  timeout - How long, in milliseconds, the database should wait to acquire the lock. SeeTimeouts for some "magic values".

  Returns:

  The appropriateLOCK clause string.

• getReadLockString

  public String getReadLockString(int timeout)

  Description copied from class: Dialect

  Get the string to append toSELECT statements to acquire READ locks for this dialect.

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

  Overrides:

  getReadLockString in class Dialect

  Parameters:

  timeout - in milliseconds, -1 for indefinite wait and 0 for no wait.

  Returns:

  The appropriateLOCK clause string.

• supportsOuterJoinForUpdate

  public boolean supportsOuterJoinForUpdate()

  Description copied from class: Dialect

  Does this dialect supportFOR UPDATE in conjunction with outer-joined rows?

  Overrides:

  supportsOuterJoinForUpdate in class Dialect

  Returns:

  True if outer-joined rows can be locked viaFOR UPDATE.

• supportsExistsInSelect

  public boolean supportsExistsInSelect()

  Description copied from class: Dialect

  Does the dialect support an exists statement in the select clause?

  Overrides:

  supportsExistsInSelect in class Dialect

  Returns:

  True if exists checks are allowed in the select clause; false otherwise.

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

• requiresCastForConcatenatingNonStrings

  public boolean requiresCastForConcatenatingNonStrings()

  Description copied from class: Dialect

  Does this dialect/database require casting of non-string arguments in theconcat() function?

  Overrides:

  requiresCastForConcatenatingNonStrings in class Dialect

  Returns:

  true if casting usingcast() is required

• getSelectClauseNullString

  public String getSelectClauseNullString(int sqlType,TypeConfiguration typeConfiguration)

  Description copied from class: Dialect

  Given aJDBC type code, return the expression for a literal null value of that type, to use in aselect clause.

  Theselect query will be an element of aUNION orUNION ALL.

  Overrides:

  getSelectClauseNullString in class Dialect

  Parameters:

  sqlType - TheTypes type code.

  typeConfiguration - The type configuration

  Returns:

  The appropriate select clause value fragment.

• selectNullString

  public static String selectNullString(int sqlType)

• supportsRefCursors

  public Boolean supportsRefCursors()

  Description copied from class: Dialect

  Whether this Dialect supports the JDBCTypes.REF_CURSOR type.

  Overrides:

  supportsRefCursors in class Dialect

  Returns:

  true indicates it does;false indicates it does not;null indicates it might and that database-metadata should be consulted

  See Also:

  • ExtractedDatabaseMetaData.supportsRefCursors()

• registerResultSetOutParameter

  public int registerResultSetOutParameter(CallableStatement statement, int col) throwsSQLException

  Description copied from class: Dialect

  Registers a parameter capable of returning aResultSetby position, either anOUT parameter, or aREF_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.

• registerResultSetOutParameter

  public int registerResultSetOutParameter(CallableStatement statement,String name) throwsSQLException

  Description copied from class: Dialect

  Registers a parameter capable of returning aResultSetby name, either anOUT parameter, or aREF_CURSOR parameter as defined in Java 8.

  Overrides:

  registerResultSetOutParameter in class Dialect

  Parameters:

  statement - The callable statement.

  name - The parameter name (for drivers which support named parameters).

  Returns:

  The number of (contiguous) bind positions used.

  Throws:

  SQLException - Indicates problems registering the param.

• getResultSet

  public ResultSet getResultSet(CallableStatement ps) throwsSQLException

  Description copied from class: Dialect

  Given acallable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract theResultSet from theOUT parameter.

  Overrides:

  getResultSet in class Dialect

  Parameters:

  ps - The callable statement.

  Returns:

  The extracted result set.

  Throws:

  SQLException - Indicates problems extracting the result set.

• getResultSet

  public ResultSet getResultSet(CallableStatement statement, int position) throwsSQLException

  Description copied from class: Dialect

  Given acallable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract theResultSet from the positionalOUT parameter.

  Overrides:

  getResultSet in class Dialect

  Parameters:

  statement - The callable statement.

  position - The bind position at which to register the output param.

  Returns:

  The extracted result set.

  Throws:

  SQLException - Indicates problems extracting the result set.

• getResultSet

  public ResultSet getResultSet(CallableStatement statement,String name) throwsSQLException

  Description copied from class: Dialect

  Given acallable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract theResultSet from the namedOUT parameter.

  Overrides:

  getResultSet in class Dialect

  Parameters:

  statement - The callable statement.

  name - The parameter name (for drivers which support named parameters).

  Returns:

  The extracted result set.

  Throws:

  SQLException - Indicates problems extracting the result set.

• 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

• getAlterColumnTypeString

  public String getAlterColumnTypeString(String columnName,String columnType,String columnDefinition)

  Description copied from class: Dialect

  The fragment of analter table command which modifies a column type, or null if column types cannot be modified. Oftenalter column col_name set data type col_type.

  Overrides:

  getAlterColumnTypeString in 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 toalter 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

• supportsIfExistsBeforeTableName

  public boolean supportsIfExistsBeforeTableName()

  Description copied from class: Dialect

  For dropping a table, can the phraseif exists be applied before the table name?

  Overrides:

  supportsIfExistsBeforeTableName in class Dialect

  Returns:

  true ifif exists can be applied before the table name

• getFallbackSqmMutationStrategy

  public SqmMultiTableMutationStrategy getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor,RuntimeModelCreationContext runtimeModelCreationContext)

  Description copied from class: Dialect

  TheSqmMultiTableMutationStrategy to use when not specified byQueryEngineOptions.getCustomSqmMultiTableMutationStrategy().

  Overrides:

  getFallbackSqmMutationStrategy in class Dialect

  See Also:

  • SqmMultiTableMutationStrategyProvider.createMutationStrategy(org.hibernate.metamodel.mapping.EntityMappingType, org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess)

• getFallbackSqmInsertStrategy

  public SqmMultiTableInsertStrategy getFallbackSqmInsertStrategy(EntityMappingType rootEntityDescriptor,RuntimeModelCreationContext runtimeModelCreationContext)

  Description copied from class: Dialect

  TheSqmMultiTableInsertStrategy to use when not specified byQueryEngineOptions.getCustomSqmMultiTableInsertStrategy().

  Overrides:

  getFallbackSqmInsertStrategy in class Dialect

  See Also:

  • SqmMultiTableMutationStrategyProvider.createInsertStrategy(org.hibernate.metamodel.mapping.EntityMappingType, org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess)

• supportsIsTrue

  public boolean supportsIsTrue()

  Description copied from class: Dialect

  Does this dialect support theis true andis false operators?

  Overrides:

  supportsIsTrue in class Dialect

  Returns:

  true if the database supportsis true andis false, orfalse if it does not. The default isis false.

• supportsCurrentTimestampSelection

  public boolean supportsCurrentTimestampSelection()

  Description copied from class: Dialect

  Does this dialect support some way to retrieve the current timestamp value from the database?

  Overrides:

  supportsCurrentTimestampSelection in class Dialect

  Returns:

  True if the current timestamp can be retrieved; 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

• doesRoundTemporalOnOverflow

  public boolean doesRoundTemporalOnOverflow()

  Description copied from class: Dialect

  Does this dialect round a temporal when converting from a precision higher to a lower one?

  Overrides:

  doesRoundTemporalOnOverflow in class Dialect

  Returns:

  true if rounding is applied, false if truncation is applied

• isCurrentTimestampSelectStringCallable

  public boolean isCurrentTimestampSelectStringCallable()

  Description copied from class: Dialect

  Is the command returned byDialect.getCurrentTimestampSelectString() treated as callable?

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

  Overrides:

  isCurrentTimestampSelectStringCallable in class Dialect

  Returns:

  if theDialect.getCurrentTimestampSelectString() is treated as callable; false otherwise.

• supportsResultSetPositionQueryMethodsOnForwardOnlyCursor

  public boolean supportsResultSetPositionQueryMethodsOnForwardOnlyCursor()

  Description copied from class: Dialect

  Does this dialect support asking the result set its positioning information on forward-only cursors?

  Specifically, in the case of scrolling fetches, Hibernate needs to useResultSet.isAfterLast() andResultSet.isBeforeFirst(). Certain drivers do not allow access to these methods for forward-only cursors.

  Overrides:

  supportsResultSetPositionQueryMethodsOnForwardOnlyCursor in class Dialect

  Returns:

  True if methods likeResultSet.isAfterLast() andResultSet.isBeforeFirst() are supported for forward only cursors; false otherwise.

• supportsLobValueChangePropagation

  public boolean supportsLobValueChangePropagation()

  Description copied from class: Dialect

  Does the dialect support propagating changes to LOB values back to the database? Talking about mutating the internal value of the locator, as opposed to supplying a new locator instance.

  • For BLOBs, the internal value might be changed by:Blob.setBinaryStream(long),Blob.setBytes(long, byte[]),Blob.setBytes(long, byte[], int, int), orBlob.truncate(long).
  • For CLOBs, the internal value might be changed by:Clob.setAsciiStream(long),Clob.setCharacterStream(long),Clob.setString(long, String),Clob.setString(long, String, int, int), orClob.truncate(long).

  Overrides:

  supportsLobValueChangePropagation in class Dialect

  Returns:

  True if the changes are propagated back to the database; false otherwise.

• useInputStreamToInsertBlob

  public boolean useInputStreamToInsertBlob()

  Description copied from class: Dialect

  Should LOBs (both BLOB and CLOB) be bound using stream operations, that is, usingPreparedStatement.setBinaryStream(int, java.io.InputStream, int)).

  Overrides:

  useInputStreamToInsertBlob in class Dialect

  Returns:

  True if BLOBs and CLOBs should be bound using stream operations.

• doesReadCommittedCauseWritersToBlockReaders

  public boolean doesReadCommittedCauseWritersToBlockReaders()

  Description copied from class: Dialect

  For the underlying database, isREAD_COMMITTED isolation implemented by forcing readers to wait for write locks to be released?

  Overrides:

  doesReadCommittedCauseWritersToBlockReaders in class Dialect

  Returns:

  True if writers block readers to achieveREAD_COMMITTED; false otherwise.

• supportsTupleDistinctCounts

  public boolean supportsTupleDistinctCounts()

  Description copied from class: Dialect

  Does this dialect supportcount(distinct a,b)?

  Overrides:

  supportsTupleDistinctCounts in class Dialect

  Returns:

  True if the database supports counting distinct tuples; false otherwise.

• contributeTypes

  public void contributeTypes(TypeContributions typeContributions,ServiceRegistry serviceRegistry)

  Description copied from class: Dialect

  A callback which allows theDialect to contribute types.

  Overrides:

  contributeTypes in class Dialect

  Parameters:

  typeContributions - Callback to contribute the types

  serviceRegistry - The service registry

• getAggregateSupport

  public AggregateSupport getAggregateSupport()

  Description copied from class: Dialect

  How does this dialect support aggregate types likeSqlTypes.STRUCT.

  Overrides:

  getAggregateSupport in class Dialect

• getCallableStatementSupport

  public CallableStatementSupport getCallableStatementSupport()

  Description copied from class: Dialect

  TheCallableStatementSupport for this database. Does this database support returning cursors?

  Overrides:

  getCallableStatementSupport in class Dialect

• appendBinaryLiteral

  public void appendBinaryLiteral(SqlAppender appender, byte[] bytes)

  Description copied from class: Dialect

  Append a binary literal to the givenSqlAppender.

  Overrides:

  appendBinaryLiteral in class Dialect

• getViolatedConstraintNameExtractor

  public ViolatedConstraintNameExtractor getViolatedConstraintNameExtractor()

  Description copied from class: Dialect

  AViolatedConstraintNameExtractor for extracting the name of a violated constraint from aSQLException.

  Specified by:

  getViolatedConstraintNameExtractor in interface ConversionContext

  Overrides:

  getViolatedConstraintNameExtractor in class Dialect

• buildSQLExceptionConversionDelegate

  public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate()

  Description copied from class: Dialect

  An instance ofSQLExceptionConversionDelegate for interpreting dialect-specificerror orSQLState 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:

  1. a "static" delegate based on the JDBC4-definedSQLException hierarchy, and
  2. a delegate that interprets SQLState codes as either X/Open or SQL-2003 codes, depending on what isreported by the JDBC driver.

  It is strongly recommended that everyDialect implementation override this method, since interpretation of a SQL error is much more accurate when based on the vendor-specificerror code, rather than on the SQLState.

  Overrides:

  buildSQLExceptionConversionDelegate in class Dialect

  Returns:

  TheSQLExceptionConversionDelegate for this dialect

• getUniqueDelegate

  public UniqueDelegate getUniqueDelegate()

  Description copied from class: Dialect

  Get theUniqueDelegate supported by this dialect

  Overrides:

  getUniqueDelegate in class Dialect

  Returns:

  The UniqueDelegate

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

• getLimitHandler

  public LimitHandler getLimitHandler()

  Description copied from class: Dialect

  Obtain aLimitHandler that implements pagination support forQuery.setMaxResults(int) andQuery.setFirstResult(int).

  Overrides:

  getLimitHandler in class Dialect

• supportsNullPrecedence

  public boolean supportsNullPrecedence()

  Description copied from class: Dialect

  Does this dialect supportnulls first andnulls last?

  Overrides:

  supportsNullPrecedence in class Dialect

• getSqlAstTranslatorFactory

  public SqlAstTranslatorFactory getSqlAstTranslatorFactory()

  Description copied from class: Dialect

  Return aSqlAstTranslatorFactory specific to this dialect, ornull to use thestandard translator.

  Overrides:

  getSqlAstTranslatorFactory in class Dialect

  See Also:

  • StandardSqlAstTranslatorFactory
  • JdbcEnvironment.getSqlAstTranslatorFactory()

• getIdentityColumnSupport

  public IdentityColumnSupport getIdentityColumnSupport()

  Description copied from class: Dialect

  Get the appropriateIdentityColumnSupport for this dialect.

  Overrides:

  getIdentityColumnSupport in class Dialect

  Returns:

  the IdentityColumnSupport

• supportsInsertReturning

  public boolean supportsInsertReturning()

  Description copied from class: Dialect

  Does this dialect fully support returning arbitrary generated column values after execution of aninsert statement, using native SQL syntax?

  Support for identity columns is insufficient here, we require something like:

  1. insert ... returning ..., or
  2. select from final table (insert ... ).

  Overrides:

  supportsInsertReturning in class Dialect

  Returns:

  true because we can useselect ... from new table (insert .... )

  See Also:

  • InsertReturningDelegate

• supportsInsertReturningRowId

  public boolean supportsInsertReturningRowId()

  Description copied from class: Dialect

  Does this dialect supports returning theRowId column after execution of aninsert statement, using native SQL syntax?

  Overrides:

  supportsInsertReturningRowId in class Dialect

  Returns:

  true is the dialect supports returning the rowid column

  See Also:

  • Dialect.supportsInsertReturning()

• supportsValuesList

  public boolean supportsValuesList()

  Description copied from class: Dialect

  Does this dialect supportvalues lists of formVALUES (1), (2), (3)?

  Overrides:

  supportsValuesList in class Dialect

  Returns:

  true ifvalues list are supported

• supportsPartitionBy

  public boolean supportsPartitionBy()

  Description copied from class: Dialect

  Does is dialect supportpartition by?

  Overrides:

  supportsPartitionBy in class Dialect

• supportsNonQueryWithCTE

  public boolean supportsNonQueryWithCTE()

  Description copied from class: Dialect

  Does this dialect support insert, update, and delete statements with Common Table Expressions (CTEs)?

  Overrides:

  supportsNonQueryWithCTE in class Dialect

  Returns:

  true if non-query statements are supported with CTE

• 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

• supportsOffsetInSubquery

  public boolean supportsOffsetInSubquery()

  Description copied from class: Dialect

  Does this dialect supportoffset in subqueries?

  For example:

   select * from Table1 where col1 in (select col1 from Table2 order by col2 limit 1 offset 1)

  Overrides:

  supportsOffsetInSubquery in class Dialect

  Returns:

  true if it does

• supportsWindowFunctions

  public boolean supportsWindowFunctions()

  Description copied from class: Dialect

  Does this dialect support window functions likerow_number() over (..)?

  Overrides:

  supportsWindowFunctions in class Dialect

  Returns:

  true if the underlying database supports window functions,false otherwise. The default isfalse.

• supportsLateral

  public boolean supportsLateral()

  Description copied from class: Dialect

  Does this dialect support the SQLlateral keyword or a proprietary alternative?

  Overrides:

  supportsLateral in class Dialect

  Returns:

  true if the underlying database supports lateral,false otherwise. The default isfalse.

• 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 every pattern letter sequences understood byDateTimeFormatter, 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

• translateExtractField

  public String translateExtractField(TemporalUnit unit)

  Description copied from class: Dialect

  Return the name used to identify the given field as an argument to theextract() function, or of this dialect'sequivalent function.

  This method does not need to handleTemporalUnit.NANOSECOND,TemporalUnit.NATIVE,TemporalUnit.OFFSET,TemporalUnit.DATE,TemporalUnit.TIME,TemporalUnit.WEEK_OF_YEAR, norTemporalUnit.WEEK_OF_MONTH, which are already desugared byExtractFunction.

  Overrides:

  translateExtractField in class Dialect

• appendBooleanValueString

  public void appendBooleanValueString(SqlAppender appender, boolean bool)

  Description copied from class: Dialect

  Append the SQL literal expression representing the given boolean value to the givenSqlAppender.

  Overrides:

  appendBooleanValueString in class Dialect

  Parameters:

  appender - TheSqlAppender to append the literal expression to

  bool - The boolean value

• extractPattern

  public String extractPattern(TemporalUnit unit)

  Description copied from class: Dialect

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

  This method does not need to handleTemporalUnit.NANOSECOND,TemporalUnit.NATIVE,TemporalUnit.OFFSET,TemporalUnit.DATE,TemporalUnit.TIME,TemporalUnit.WEEK_OF_YEAR, orTemporalUnit.WEEK_OF_MONTH, which are already desugared byExtractFunction.

  Overrides:

  extractPattern in class Dialect

  Parameters:

  unit - the first argument

• 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 class Dialect

  Parameters:

  from - aCastType indicating the type of the value argument

  to - aCastType indicating the type the value argument is cast to

• getInExpressionCountLimit

  public int getInExpressionCountLimit()

  Description copied from class: Dialect

  Return the limit that the underlying database places on the number of elements in anIN predicate. If the database defines no such limits, simply return zero or a number smaller than zero.

  Overrides:

  getInExpressionCountLimit in class Dialect

  Returns:

  The limit, or a non-positive integer to indicate no limit.

• generatedAs

  public String generatedAs(String generatedAs)

  Description copied from class: Dialect

  Thegenerated as clause, or similar, for generated column declarations in DDL statements.

  Overrides:

  generatedAs in class Dialect

  Parameters:

  generatedAs - a SQL expression used to generate the column value

  Returns:

  Thegenerated as clause containing the given expression

• buildIdentifierHelper

  public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuilder builder,DatabaseMetaData dbMetaData) throwsSQLException

  Description copied from class: Dialect

  TheIdentifierHelper indicated by this dialect for handling identifier conversions. Returningnull is allowed and indicates that Hibernate should fall back to building a "standard" helper. In the fallback path, any changes made to the IdentifierHelperBuilder during this call will still be incorporated into the built IdentifierHelper.

  The incoming builder will have the following set:

  • IdentifierHelperBuilder.isGloballyQuoteIdentifiers()
  • IdentifierHelperBuilder.getUnquotedCaseStrategy() - initialized to UPPER
  • IdentifierHelperBuilder.getQuotedCaseStrategy() - initialized to MIXED

  By default, Hibernate will do the following:

  • CallIdentifierHelperBuilder.applyIdentifierCasing(DatabaseMetaData)
  • CallIdentifierHelperBuilder.applyReservedWords(DatabaseMetaData)
  • AppliesAnsiSqlKeywords.sql2003() as reserved words
  • Applies the {#link #sqlKeywords} collected here as reserved words
  • Applies the Dialect'sNameQualifierSupport, if it defines one

  Overrides:

  buildIdentifierHelper in class Dialect

  Parameters:

  builder - A partially-configuredIdentifierHelperBuilder.

  dbMetaData - Access to the metadata returned from the driver if needed and if available.WARNING: it may benull.

  Returns:

  TheIdentifierHelper instance to use, ornull to indicate Hibernate should use its fallback path

  Throws:

  SQLException - Accessing theDatabaseMetaData can throw it. Just rethrow and Hibernate will handle it.

  See Also:

  • Dialect.getNameQualifierSupport()

• 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'tbatch 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:

  • Dialect.getDisableConstraintsStatement()
  • Dialect.getDisableConstraintStatement(String, String)

• getDisableConstraintStatement

  public String getDisableConstraintStatement(String tableName,String name)

  Description copied from class: Dialect

  A SQL statement that temporarily disables checking of the given foreign key constraint.

  Overrides:

  getDisableConstraintStatement in class Dialect

  Parameters:

  tableName - the name of the table

  name - the name of the constraint

• getEnableConstraintStatement

  public String getEnableConstraintStatement(String tableName,String name)

  Description copied from class: Dialect

  A SQL statement that re-enables checking of the given foreign key constraint.

  Overrides:

  getEnableConstraintStatement in class Dialect

  Parameters:

  tableName - the name of the table

  name - the name of the constraint

• getTruncateTableStatement

  public String getTruncateTableStatement(String tableName)

  Description copied from class: Dialect

  A SQL statement that truncates the given table.

  Overrides:

  getTruncateTableStatement in class Dialect

  Parameters:

  tableName - the name of the table

• getCreateUserDefinedTypeExtensionsString

  public String getCreateUserDefinedTypeExtensionsString()

  Description copied from class: Dialect

  An arbitrary extension to append to the end of the UDTcreate type command.

  Overrides:

  getCreateUserDefinedTypeExtensionsString in class Dialect

• rowId

  public String rowId(String rowId)

  The more "standard" syntax isrid_bit(alias) but here we usealias.rowid.

  There is also an alternativerid() of typebigint, but it cannot be used with partitioning.

  Overrides:

  rowId in class Dialect

  Parameters:

  rowId - the name specified byRowId.value(), which is ignored ifDialect.getRowIdColumnString(java.lang.String) is not overridden

• rowIdSqlType

  public int rowIdSqlType()

  Description copied from class: Dialect

  The JDBC type code of therowid-like pseudo-column which acts as a high-performance row locator.

  Overrides:

  rowIdSqlType in class Dialect

  Returns:

  Types.ROWID by default

• getDmlTargetColumnQualifierSupport

  public DmlTargetColumnQualifierSupport getDmlTargetColumnQualifierSupport()

  Description copied from class: Dialect

  Get the minimumDmlTargetColumnQualifierSupport 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 thefrom clause for update statements?

  Overrides:

  supportsFromClauseInUpdate in class Dialect

  Returns:

  true iffrom clause is supported

• getDual

  public String getDual()

  Description copied from class: Dialect

  Returns a table expression that has one row.

  Overrides:

  getDual in class Dialect

  Returns:

  the SQL equivalent to Oracle'sdual.

• getFromDualForSelectOnly

  public String getFromDualForSelectOnly()

  Overrides:

  getFromDualForSelectOnly in class Dialect

• supportsRowValueConstructorSyntax

  public boolean supportsRowValueConstructorSyntax()

  Description copied from class: Dialect

  Is this dialect known to support what ANSI-SQL terms "row value constructor" syntax; sometimes called tuple syntax.

  Basically, does it support syntax like... where (FIRST_NAME, LAST_NAME) = ('Steve', 'Ebersole') ...

  Overrides:

  supportsRowValueConstructorSyntax in class Dialect

  Returns:

  True if this SQL dialect is known to support "row value constructor" syntax; false otherwise.

• supportsWithClauseInSubquery

  public boolean supportsWithClauseInSubquery()

  Description copied from class: Dialect

  Whether the SQL with clause is supported within a subquery.

  Overrides:

  supportsWithClauseInSubquery in class Dialect

• supportsRowValueConstructorSyntaxInQuantifiedPredicates

  public boolean supportsRowValueConstructorSyntaxInQuantifiedPredicates()

  Description copied from class: Dialect

  Is this dialect known to support what ANSI-SQL terms "row value constructor" syntax; sometimes called tuple syntax with quantified predicates.

  Basically, does it support syntax like... where (FIRST_NAME, LAST_NAME) = ALL (select ...) ...

  Overrides:

  supportsRowValueConstructorSyntaxInQuantifiedPredicates in class Dialect

  Returns:

  True if this SQL dialect is known to support "row value constructor" syntax with quantified predicates; false otherwise.

• supportsRowValueConstructorSyntaxInInList

  public boolean supportsRowValueConstructorSyntaxInInList()

  Description copied from class: Dialect

  If the dialect supportsrow values, does it offer such support in IN lists as well?

  For example,... where (FIRST_NAME, LAST_NAME) IN ( (?, ?), (?, ?) ) ...

  Overrides:

  supportsRowValueConstructorSyntaxInInList in class Dialect

  Returns:

  True if this SQL dialect is known to support "row value constructor" syntax in the IN list; false otherwise.