DB2Dialect (hibernate-core JavaDocs)

java.lang.Object
- org.hibernate.dialect.Dialect
- - org.hibernate.dialect.DB2Dialect

All Implemented Interfaces:

ConversionContext

Direct Known Subclasses:

DB2390Dialect, DB2400Dialect, DB297Dialect, DB2iDialect, DB2zDialect
```
public class DB2Dialect
extends Dialect
```
An SQL dialect for DB2.

Nested Class Summary
- Nested classes/interfaces inherited from class org.hibernate.dialect.Dialect
  Dialect.SizeStrategy, Dialect.SizeStrategyImpl

Field Summary
- Fields inherited from class org.hibernate.dialect.Dialect
  CLOSED_QUOTE, DEFAULT_BATCH_SIZE, LEGACY_LOB_MERGE_STRATEGY, NEW_LOCATOR_LOB_MERGE_STRATEGY, NO_BATCH, QUOTE, STANDARD_DEFAULT_BATCH_LOAD_SIZING_STRATEGY, STREAM_XFER_LOB_MERGE_STRATEGY, TWO_SINGLE_QUOTES_REPLACEMENT

Constructor Summary

Constructors
Constructor and Description

DB2Dialect()

DB2Dialect(DialectResolutionInfo info)

DB2Dialect(int version)

Constructors
Constructor and Description
`DB2Dialect()`
`DB2Dialect(DialectResolutionInfo info)`
`DB2Dialect(int version)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SQLExceptionConversionDelegate`	`buildSQLExceptionConversionDelegate()` Build an instance of a `SQLExceptionConversionDelegate` for interpreting dialect-specific error or SQLState codes.
`protected UniqueDelegate`	`createUniqueDelegate()`
`boolean`	`doesReadCommittedCauseWritersToBlockReaders()` For the underlying database, is READ_COMMITTED isolation implemented by forcing readers to wait for write locks to be released?
`boolean`	`dropConstraints()` Do we need to drop constraints before dropping tables in this dialect?
`String`	`extractPattern(TemporalUnit unit)` Obtain a pattern for the SQL equivalent to an `extract()` function call.
`String`	`formatBinaryLiteral(byte[] bytes)`
`String`	`getCrossJoinSeparator()` The separator to use for declaring cross joins in a SQL query, typically either `" cross join "` or a comma `", "`, where the spaces are required.
`String`	`getCurrentTimestampSelectString()` Retrieve the command used to retrieve the current timestamp from the database.
`int`	`getDefaultDecimalPrecision()` This is the default precision for a generated column mapped to a `BigInteger` or `BigDecimal`.
`String[]`	`getDropSchemaCommand(String schemaName)` Get the SQL command used to drop the named schema
`SqmMultiTableMutationStrategy`	`getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)`
`String`	`getForUpdateSkipLockedString()` Retrieves the `FOR UPDATE SKIP LOCKED` syntax specific to this dialect.
`String`	`getForUpdateSkipLockedString(String aliases)` Get the `FOR UPDATE OF column_list SKIP LOCKED` fragment appropriate for this dialect given the aliases of the columns to be write locked.
`String`	`getForUpdateString()` Get the string to append to SELECT statements to acquire locks for this dialect.
`long`	`getFractionalSecondPrecisionInNanos()` Since we're using `seconds_between()` and `add_seconds()`, it makes sense to use seconds as the "native" precision.
`String`	`getFromDual()` Some databases require a bit of syntactic noise when there are no tables in the from clause.
`GroupByConstantRenderingStrategy`	`getGroupByConstantRenderingStrategy()` The strategy to use for rendering constants in the GROUP BY clause.
`GroupBySummarizationRenderingStrategy`	`getGroupBySummarizationRenderingStrategy()` The strategy to use for rendering summarizations in the GROUP BY clause.
`IdentityColumnSupport`	`getIdentityColumnSupport()` Get the appropriate `IdentityColumnSupport`
`LimitHandler`	`getLimitHandler()` Returns a `LimitHandler` that implements support for `Query.setMaxResults(int)` and `Query.setFirstResult(int)` for this dialect.
`String`	`getLowercaseFunction()` The name of the SQL function that transforms a string to lowercase
`String`	`getNotExpression(String expression)` Negate an expression
`String`	`getQuerySequencesString()` Get the select command used retrieve the names of all sequences.
`String`	`getReadLockString(int timeout)` Get the string to append to SELECT statements to acquire READ locks for this dialect.
`ResultSet`	`getResultSet(CallableStatement ps)` Given a callable statement previously processed by `Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int)`, extract the `ResultSet` from the OUT parameter.
`String`	`getSelectClauseNullString(int sqlType)` Given a `Types` type code, determine an appropriate null value to use in a select clause.
`SequenceInformationExtractor`	`getSequenceInformationExtractor()` A source of `SequenceInformation`.
`SequenceSupport`	`getSequenceSupport()`
`SqlAstTranslatorFactory`	`getSqlAstTranslatorFactory()` Return an SqlAstTranslatorFactory specific for the Dialect.
`protected JdbcTypeDescriptor`	`getSqlTypeDescriptorOverride(int sqlCode)` Returns the `JdbcTypeDescriptor` that should be used to handle the given JDBC type code.
`UniqueDelegate`	`getUniqueDelegate()` Get the UniqueDelegate supported by this dialect
`int`	`getVersion()`
`String`	`getWriteLockString(int timeout)` Get the string to append to SELECT statements to acquire WRITE locks for this dialect.
`void`	`initializeFunctionRegistry(QueryEngine queryEngine)` Initialize the given registry with any dialect-specific functions.
`boolean`	`isCurrentTimestampSelectStringCallable()` Should the value returned by `Dialect.getCurrentTimestampSelectString()` be treated as callable.
`int`	`registerResultSetOutParameter(CallableStatement statement, int col)` Registers a parameter (either OUT, or the new REF_CURSOR param type available in Java 8) capable of returning `ResultSet` by position.
`String`	`renderOrderByElement(String expression, String collation, String order, NullPrecedence nullPrecedence)` Handle DB2 "support" for null precedence...
`boolean`	`requiresCastingOfParametersInSelectClause()` Does this dialect require that parameters appearing in the `SELECT` clause be wrapped in `cast()` calls to tell the db parser the expected type.
`boolean`	`supportsCommentOn()` Does this dialect/database support commenting on tables, columns, etc?
`boolean`	`supportsCurrentTimestampSelection()` Does this dialect support a way to retrieve the database's current timestamp value?
`boolean`	`supportsEmptyInList()` Does this dialect support empty IN lists? For example, is [where XYZ in ()] a supported construct?
`boolean`	`supportsExistsInSelect()` Does the dialect support an exists statement in the select clause?
`boolean`	`supportsLobValueChangePropagation()` Does the dialect support propagating changes to LOB values back to the database? Talking about mutating the internal value of the locator as opposed to supplying a new locator instance...
`boolean`	`supportsLockTimeouts()` Informational metadata about whether this dialect is known to support specifying timeouts for requested lock acquisitions.
`boolean`	`supportsNonQueryWithCTE()` Does this dialect/database support non-query statements (e.g.
`boolean`	`supportsNullPrecedence()`
`boolean`	`supportsOffsetInSubquery()` Does this dialect support offset in subqueries? Ex: select * from Table1 where col1 in (select col1 from Table2 order by col2 limit 1 offset 1)
`boolean`	`supportsOuterJoinForUpdate()` Does this dialect support `FOR UPDATE` in conjunction with outer joined rows?
`boolean`	`supportsParametersInInsertSelect()` Does this dialect support parameters within the `SELECT` clause of `INSERT ...`
`boolean`	`supportsPartitionBy()` Does the underlying database support partition by
`boolean`	`supportsResultSetPositionQueryMethodsOnForwardOnlyCursor()` Does this dialect support asking the result set its positioning information on forward only cursors.
`boolean`	`supportsRowValueConstructorSyntaxInInList()` If the dialect supports `row values`, does it offer such support in IN lists as well? For example, "...
`boolean`	`supportsSelectQueryWithoutFromClause()`
`boolean`	`supportsSkipLocked()` Does this dialect/database support SKIP_LOCKED timeout.
`boolean`	`supportsTupleDistinctCounts()` Does this dialect support `count(distinct a,b)`?
`boolean`	`supportsValuesList()` Does this dialect/database support VALUES list (e.g.
`boolean`	`supportsWindowFunctions()` Does this dialect support window functions like `row_number() over (..)`
`String`	`timestampaddPattern(TemporalUnit unit, TemporalType temporalType)` Obtain a pattern for the SQL equivalent to a `timestampadd()` function call.
`String`	`timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalType, TemporalType toTemporalType)` Obtain a pattern for the SQL equivalent to a `timestampdiff()` function call.
`String`	`toBooleanValueString(boolean bool)` The SQL literal value to which this database maps boolean values.
`String`	`translateDatetimeFormat(String format)` 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).
`String`	`translateExtractField(TemporalUnit unit)` Return the name used to identify the given field as an argument to the `extract()` function, or of this dialect's `equivalent` function.

Methods inherited from class org.hibernate.dialect.Dialect
addSqlHintOrComment, appendLockHint, appendLockHint, applyLocksToSql, areStringComparisonsCaseInsensitive, augmentRecognizedTableTypes, binaryToDecimalPrecision, bindLimitParametersFirst, bindLimitParametersInReverseOrder, buildIdentifierHelper, buildSQLExceptionConverter, canCreateCatalog, canCreateSchema, castPattern, closeQuote, contributeTypes, convertToFirstRowValue, createCaseFragment, createOuterJoinFragment, currentDate, currentLocalTime, currentLocalTimestamp, currentTime, currentTimestamp, currentTimestampWithTimeZone, defaultScrollMode, doesRepeatableReadCauseReadersToBlockWriters, equivalentTypes, escapeComment, escapeLiteral, forceLimitUsage, forceLobAsLastValue, formatAsTimestamp, formatAsTimestamp, formatAsTimestamp, formatDateTimeLiteral, formatDateTimeLiteral, formatDateTimeLiteral, forUpdateOfColumns, getAddColumnString, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAddUniqueConstraintString, getAlterTableString, getAuxiliaryDatabaseObjectExporter, getBooleanCheckCondition, getCallableStatementSupport, getCascadeConstraintsString, getCaseInsensitiveLike, getCastTypeName, getColumnAliasExtractor, getColumnComment, getCreateCatalogCommand, getCreateMultisetTableString, getCreateSchemaCommand, getCreateSequenceString, getCreateSequenceString, getCreateSequenceStrings, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getCurrentSchemaCommand, getCurrentTimestampSQLFunctionName, getDefaultBatchLoadSizingStrategy, getDefaultLobLength, getDefaultProperties, getDefaultTimestampPrecision, getDialect, getDialect, getDoublePrecision, getDropCatalogCommand, getDropForeignKeyString, getDropSequenceString, getDropSequenceStrings, getDropTableString, getEnumCheckCondition, getFloatPrecision, getForeignKeyExporter, getForUpdateNowaitString, getForUpdateNowaitString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getHibernateTypeName, getHibernateTypeName, getHqlTranslator, getIndexExporter, getInExpressionCountLimit, getKeywords, getLimitString, getLimitString, getLobMergeStrategy, getLockingStrategy, getLockRowIdentifier, getMaxAliasLength, getNameQualifierSupport, getNationalizationSupport, getNativeIdentifierGeneratorClass, getNativeIdentifierGeneratorStrategy, getNoColumnsInsertString, getNullColumnString, getNullColumnString, getNullOrdering, getPreferredSqlTypeCodeForBoolean, getQueryHintString, getQueryHintString, getRawTypeName, getRawTypeName, getReadLockString, getReadRowLockStrategy, getResultSet, getResultSet, getSchemaNameResolver, getSelectGUIDString, getSelectSequenceNextValString, getSequenceExporter, getSequenceNextValString, getSequenceNextValString, getSizeStrategy, getSqmTranslatorFactory, getTableAliasSeparator, getTableComment, getTableExporter, getTableTypeString, getTypeName, getTypeName, getTypeName, getTypeName, getUniqueKeyExporter, getViolatedConstraintNameExtractor, getWriteLockString, getWriteRowLockStrategy, hasAlterTable, hasSelfReferentialForeignKeyBug, inlineLiteral, isEmptyStringTreatedAsNull, isJdbcLogWarningsEnabledByDefault, isLockTimeoutParameterized, isTypeNameRegistered, openQuote, prependComment, qualifyIndexName, quote, registerColumnType, registerColumnType, registerHibernateType, registerHibernateType, registerKeyword, registerResultSetOutParameter, remapSqlTypeDescriptor, replaceResultVariableInOrderByClauseWithPosition, requiresFloatCastingOfIntegerDivision, requiresParensForTupleDistinctCounts, resolveSqlTypeDescriptor, supportsBindAsCallableArgument, supportsBitType, supportsCascadeDelete, supportsCaseInsensitiveLike, supportsCircularCascadeDeleteConstraints, supportsColumnCheck, supportsExpectedLobUsagePattern, supportsFetchClause, supportsFractionalTimestampArithmetic, supportsIfExistsAfterAlterTable, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsBeforeConstraintName, supportsIfExistsBeforeTableName, supportsJdbcConnectionLobCreation, supportsLimit, supportsLimitOffset, supportsNamedParameters, supportsNationalizedTypes, supportsNoColumnsInsert, supportsNotNullUnique, supportsNoWait, supportsOrderByInSubquery, supportsOrdinalSelectItemReference, supportsPooledSequences, supportsRowValueConstructorSyntax, supportsRowValueConstructorSyntaxInInSubquery, supportsRowValueConstructorSyntaxInQuantifiedPredicates, supportsRowValueConstructorSyntaxInSet, supportsSelectAliasInGroupByClause, supportsSequences, supportsSubqueryInSelect, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTemporalLiteralOffset, supportsTemporaryTables, supportsTimezoneTypes, supportsTruncateWithCast, supportsTupleCounts, supportsTuplesInSubqueries, supportsUnboundedLobLocatorMaterialization, supportsUnionAll, supportsUnionInSubquery, supportsUnique, supportsUniqueConstraintInCreateAlterTable, supportsValuesListForInsert, supportsVariableLimit, supportsWait, toString, transformSelectString, translateDurationField, trimPattern, useFollowOnLocking, useInputStreamToInsertBlob, useMaxForLimit, wrapDateLiteral, wrapTimeLiteral, wrapTimestampLiteral

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DB2Dialect
```
public DB2Dialect(DialectResolutionInfo info)
```
  - DB2Dialect
```
public DB2Dialect()
```
  - DB2Dialect
```
public DB2Dialect(int version)
```
- Method Detail
  - createUniqueDelegate
```
protected UniqueDelegate createUniqueDelegate()
```
  - getDefaultDecimalPrecision
```
public int getDefaultDecimalPrecision()
```
    Description copied from class: Dialect
    
    This is the default precision for a generated column mapped to a BigInteger or BigDecimal.
    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
  - getVersion
```
public int getVersion()
```
    Specified by:
    
    getVersion in class Dialect
  - initializeFunctionRegistry
```
public void initializeFunctionRegistry(QueryEngine queryEngine)
```
    Description copied from class: Dialect
    Initialize the given registry with any dialect-specific functions. Support for certain SQL functions is required, and if the database does not support a required function, then the dialect must define a way to emulate it. These required functions include the functions defined by the JPA query language specification:
    - avg(arg) - aggregate function
    - count([distinct ]arg) - aggregate function
    - max(arg) - aggregate function
    - min(arg) - aggregate function
    - sum(arg) - aggregate function
    - coalesce(arg0, arg1, ...)
    - nullif(arg0, arg1)
    - lower(arg)
    - upper(arg)
    - length(arg)
    - concat(arg0, arg1, ...)
    - locate(pattern, string[, start])
    - substring(string, start[, length])
    - trim([[spec ][character ]from] string)
    - abs(arg)
    - mod(arg0, arg1)
    - sqrt(arg)
    - current date
    - current time
    - current timestamp
    Along with an additional set of functions defined by ANSI SQL:
    - any(arg) - aggregate function
    - every(arg) - aggregate function
    - cast(arg as Type)
    - extract(field from arg)
    - ln(arg)
    - exp(arg)
    - power(arg0, arg1)
    - floor(arg)
    - ceiling(arg)
    - position(pattern in string)
    - substring(string from start[ for length])
    - overlay(string placing replacement from start[ for length])
    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])
    - sign(arg)
    - sin(arg)
    - cos(arg)
    - tan(arg)
    - asin(arg)
    - acos(arg)
    - atan(arg)
    - atan2(arg0, arg1)
    - round(arg0, arg1)
    - least(arg0, arg1, ...)
    - greatest(arg0, arg1, ...)
    - format(datetime as pattern)
    - 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)
    Overrides:
    
    initializeFunctionRegistry in class Dialect
  - 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 using seconds_between() and add_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 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
  - timestampaddPattern
```
public String timestampaddPattern(TemporalUnit unit,
                                  TemporalType temporalType)
```
    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 first argument
    
    temporalType - true if the third argument is a
  - getLowercaseFunction
```
public String getLowercaseFunction()
```
    Description copied from class: Dialect
    
    The name of the SQL function that transforms a string to lowercase
    
    Overrides:
    
    getLowercaseFunction in class Dialect
    
    Returns:
    
    The dialect-specific lowercase function.
  - 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.
  - getSequenceSupport
```
public SequenceSupport getSequenceSupport()
```
    Overrides:
    
    getSequenceSupport in class Dialect
  - getQuerySequencesString
```
public String getQuerySequencesString()
```
    Description copied from class: Dialect
    
    Get the select command used retrieve the names of all sequences.
    
    Overrides:
    
    getQuerySequencesString in class Dialect
    
    Returns:
    
    The select command; or null if sequences are not supported.
    
    See Also:
    
    SchemaUpdate
  - getSequenceInformationExtractor
```
public SequenceInformationExtractor getSequenceInformationExtractor()
```
    Description copied from class: Dialect
    
    A source of SequenceInformation.
    
    Overrides:
    
    getSequenceInformationExtractor in class Dialect
  - getForUpdateString
```
public String getForUpdateString()
```
    Description copied from class: Dialect
    
    Get the string to append to SELECT statements to acquire locks for this dialect.
    
    Overrides:
    
    getForUpdateString in class Dialect
    
    Returns:
    
    The appropriate FOR UPDATE clause string.
  - supportsSkipLocked
```
public boolean supportsSkipLocked()
```
    Description copied from class: Dialect
    
    Does this dialect/database support SKIP_LOCKED timeout.
    
    Overrides:
    
    supportsSkipLocked in class Dialect
    
    Returns:
    
    true if SKIP_LOCKED is supported
  - 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.
  - getWriteLockString
```
public String getWriteLockString(int timeout)
```
    Description copied from class: Dialect
    
    Get the string to append to SELECT statements to acquire WRITE locks for this dialect. Location of the returned string is treated the same as getForUpdateString.
    
    Overrides:
    
    getWriteLockString in 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(int timeout)
```
    Description copied from class: Dialect
    
    Get the string to append to SELECT statements to acquire READ locks for this dialect. Location of the returned string is treated the same as getForUpdateString.
    
    Overrides:
    
    getReadLockString in class Dialect
    
    Parameters:
    
    timeout - in milliseconds, -1 for indefinite wait and 0 for no wait.
    
    Returns:
    
    The appropriate LOCK clause string.
  - supportsOuterJoinForUpdate
```
public boolean supportsOuterJoinForUpdate()
```
    Description copied from class: Dialect
    
    Does this dialect support FOR UPDATE in conjunction with outer joined rows?
    
    Overrides:
    
    supportsOuterJoinForUpdate in class Dialect
    
    Returns:
    
    True if outer joined rows can be locked via FOR 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
    
    Informational metadata about whether this dialect is known to support specifying timeouts for requested lock acquisitions.
    
    Overrides:
    
    supportsLockTimeouts in class Dialect
    
    Returns:
    
    True is this dialect supports specifying lock timeouts.
  - getSelectClauseNullString
```
public String getSelectClauseNullString(int sqlType)
```
    Description copied from class: Dialect
    
    Given a Types type code, determine an appropriate null value to use in a select clause.
    One thing to consider here is that certain databases might require proper casting for the nulls here since the select here will be part of a UNION/UNION ALL.
    
    Overrides:
    
    getSelectClauseNullString in class Dialect
    
    Parameters:
    
    sqlType - The Types type code.
    
    Returns:
    
    The appropriate select clause value fragment.
  - registerResultSetOutParameter
```
public int registerResultSetOutParameter(CallableStatement statement,
                                         int col)
                                  throws SQLException
```
    Description copied from class: Dialect
    
    Registers a parameter (either OUT, or the new REF_CURSOR param type available in Java 8) capable of returning ResultSet *by position*. Pre-Java 8, registering such ResultSet-returning parameters varied greatly across database and drivers; hence its inclusion as part of the Dialect contract.
    
    Overrides:
    
    registerResultSetOutParameter in 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.
  - supportsCommentOn
```
public boolean supportsCommentOn()
```
    Description copied from class: Dialect
    
    Does this dialect/database support commenting on tables, columns, etc?
    
    Overrides:
    
    supportsCommentOn in class Dialect
    
    Returns:
    
    true if commenting is supported
  - getFallbackSqmMutationStrategy
```
public SqmMultiTableMutationStrategy getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor,
                                                                    RuntimeModelCreationContext runtimeModelCreationContext)
```
    Overrides:
    
    getFallbackSqmMutationStrategy in class Dialect
  - supportsCurrentTimestampSelection
```
public boolean supportsCurrentTimestampSelection()
```
    Description copied from class: Dialect
    
    Does this dialect support a way to retrieve the database's current timestamp value?
    
    Overrides:
    
    supportsCurrentTimestampSelection in class Dialect
    
    Returns:
    
    True if the current timestamp can be retrieved; false otherwise.
  - getCurrentTimestampSelectString
```
public String getCurrentTimestampSelectString()
```
    Description copied from class: Dialect
    
    Retrieve the command used to retrieve the current timestamp from the database.
    
    Overrides:
    
    getCurrentTimestampSelectString in class Dialect
    
    Returns:
    
    The command.
  - isCurrentTimestampSelectStringCallable
```
public boolean isCurrentTimestampSelectStringCallable()
```
    Description copied from class: Dialect
    
    Should the value returned by Dialect.getCurrentTimestampSelectString() be treated as callable. Typically this indicates that JDBC escape syntax is being used...
    
    Overrides:
    
    isCurrentTimestampSelectStringCallable in class Dialect
    
    Returns:
    
    True if the Dialect.getCurrentTimestampSelectString() return is callable; false otherwise.
  - supportsParametersInInsertSelect
```
public boolean supportsParametersInInsertSelect()
```
    Does this dialect support parameters within the SELECT clause of INSERT ... SELECT ... statements?
    NOTE : DB2 is known to support parameters in the SELECT clause, but only in casted form (see requiresCastingOfParametersInSelectClause()).
    
    Overrides:
    
    supportsParametersInInsertSelect in class Dialect
    
    Returns:
    
    True if this is supported; false otherwise.
  - requiresCastingOfParametersInSelectClause
```
public boolean requiresCastingOfParametersInSelectClause()
```
    Does this dialect require that parameters appearing in the SELECT clause be wrapped in cast() calls to tell the db parser the expected type.
    DB2 in fact does require that parameters appearing in the select clause be wrapped in cast() calls to tell the DB parser the type of the select value.
    
    Overrides:
    
    requiresCastingOfParametersInSelectClause in class Dialect
    
    Returns:
    
    True if select clause parameter must be cast()ed
  - 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 use ResultSet.isAfterLast() and ResultSet.isBeforeFirst(). Certain drivers do not allow access to these methods for forward only cursors.
    NOTE : this is highly driver dependent!
    
    Overrides:
    
    supportsResultSetPositionQueryMethodsOnForwardOnlyCursor in class Dialect
    
    Returns:
    
    True if methods like ResultSet.isAfterLast() and ResultSet.isBeforeFirst() are supported for forward only cursors; false otherwise.
  - getCrossJoinSeparator
```
public String getCrossJoinSeparator()
```
    Description copied from class: Dialect
    
    The separator to use for declaring cross joins in a SQL query, typically either " cross join " or a comma ", ", where the spaces are required.
    
    Overrides:
    
    getCrossJoinSeparator in class Dialect
    
    Returns:
    
    The cross join separator, with spaces
  - supportsEmptyInList
```
public boolean supportsEmptyInList()
```
    Description copied from class: Dialect
    
    Does this dialect support empty IN lists?
    For example, is [where XYZ in ()] a supported construct?
    
    Overrides:
    
    supportsEmptyInList in class Dialect
    
    Returns:
    
    True if empty in lists are supported; 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), or Blob.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), or Clob.truncate(long).
    NOTE : I do not know the correct answer currently for databases which (1) are not part of the cruise control process or (2) do not Dialect.supportsExpectedLobUsagePattern().
    
    Overrides:
    
    supportsLobValueChangePropagation in class Dialect
    
    Returns:
    
    True if the changes are propagated back to the database; false otherwise.
  - doesReadCommittedCauseWritersToBlockReaders
```
public boolean doesReadCommittedCauseWritersToBlockReaders()
```
    Description copied from class: Dialect
    
    For the underlying database, is READ_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 achieve READ_COMMITTED; false otherwise.
  - supportsTupleDistinctCounts
```
public boolean supportsTupleDistinctCounts()
```
    Description copied from class: Dialect
    
    Does this dialect support `count(distinct a,b)`?
    
    Overrides:
    
    supportsTupleDistinctCounts in class Dialect
    
    Returns:
    
    True if the database supports counting distinct tuples; false otherwise.
  - getFromDual
```
public String getFromDual()
```
    Description copied from class: Dialect
    
    Some databases require a bit of syntactic noise when there are no tables in the from clause.
    
    Overrides:
    
    getFromDual in class Dialect
    
    Returns:
    
    the SQL equivalent to Oracle's from dual.
  - supportsSelectQueryWithoutFromClause
```
public boolean supportsSelectQueryWithoutFromClause()
```
    Overrides:
    
    supportsSelectQueryWithoutFromClause in class Dialect
  - getSqlTypeDescriptorOverride
```
protected JdbcTypeDescriptor getSqlTypeDescriptorOverride(int sqlCode)
```
    Description copied from class: Dialect
    
    Returns the JdbcTypeDescriptor that should be used to handle the given JDBC type code. Returns null if there is no override.
    
    Overrides:
    
    getSqlTypeDescriptorOverride in class Dialect
    
    Parameters:
    
    sqlCode - A Types constant indicating the SQL column type
    
    Returns:
    
    The JdbcTypeDescriptor to use as an override, or null if there is no override.
  - formatBinaryLiteral
```
public String formatBinaryLiteral(byte[] bytes)
```
    Overrides:
    
    formatBinaryLiteral in class Dialect
  - buildSQLExceptionConversionDelegate
```
public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate()
```
    Description copied from class: Dialect
    Build an instance of a SQLExceptionConversionDelegate for interpreting dialect-specific error or SQLState codes.
    When Dialect.buildSQLExceptionConverter() returns null, the default SQLExceptionConverter is used to interpret SQLState and error 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 JDBC 4 defined SQLException hierarchy;
    2. a delegate that interprets SQLState codes for either X/Open or SQL-2003 codes, depending on java.sql.DatabaseMetaData#getSQLStateType
    It is strongly recommended that specific Dialect implementations override this method, since interpretation of a SQL error is much more accurate when based on the vendor-specific ErrorCode rather than the SQLState.
    Specific Dialects may override to return whatever is most appropriate for that vendor.
    Overrides:
    
    buildSQLExceptionConversionDelegate in class Dialect
    
    Returns:
    
    The SQLExceptionConversionDelegate for this dialect
  - getUniqueDelegate
```
public UniqueDelegate getUniqueDelegate()
```
    Description copied from class: Dialect
    
    Get the UniqueDelegate supported by this dialect
    
    Overrides:
    
    getUniqueDelegate in class Dialect
    
    Returns:
    
    The UniqueDelegate
  - getNotExpression
```
public String getNotExpression(String expression)
```
    Description copied from class: Dialect
    
    Negate an expression
    
    Overrides:
    
    getNotExpression in class Dialect
    
    Parameters:
    
    expression - The expression to negate
    
    Returns:
    
    The negated expression
  - getLimitHandler
```
public LimitHandler getLimitHandler()
```
    Description copied from class: Dialect
    
    Returns a LimitHandler that implements support for Query.setMaxResults(int) and Query.setFirstResult(int) for this dialect.
    
    Overrides:
    
    getLimitHandler in class Dialect
  - supportsNullPrecedence
```
public boolean supportsNullPrecedence()
```
    Overrides:
    
    supportsNullPrecedence in class Dialect
  - getSqlAstTranslatorFactory
```
public SqlAstTranslatorFactory getSqlAstTranslatorFactory()
```
    Description copied from class: Dialect
    
    Return an SqlAstTranslatorFactory specific for the Dialect. Return null to use Hibernate's standard translator.
    
    Overrides:
    
    getSqlAstTranslatorFactory in class Dialect
    
    See Also:
    
    StandardSqlAstTranslatorFactory, JdbcEnvironment.getSqlAstTranslatorFactory()
  - renderOrderByElement
```
public String renderOrderByElement(String expression,
                                   String collation,
                                   String order,
                                   NullPrecedence nullPrecedence)
```
    Handle DB2 "support" for null precedence...
    
    Overrides:
    
    renderOrderByElement in class Dialect
    
    Parameters:
    
    expression - The SQL order expression. In case of @OrderBy annotation user receives property placeholder (e.g. attribute name enclosed in '{' and '}' signs).
    
    collation - Collation string in format collate IDENTIFIER, or null if expression has not been explicitly specified.
    
    order - Order direction. Possible values: asc, desc, or null if expression has not been explicitly specified.
    
    nullPrecedence - Nulls precedence. Default value: NullPrecedence.NONE.
    
    Returns:
    
    SQL string.
  - getIdentityColumnSupport
```
public IdentityColumnSupport getIdentityColumnSupport()
```
    Description copied from class: Dialect
    
    Get the appropriate IdentityColumnSupport
    
    Overrides:
    
    getIdentityColumnSupport in class Dialect
    
    Returns:
    
    the IdentityColumnSupport
  - supportsValuesList
```
public boolean supportsValuesList()
```
    Description copied from class: Dialect
    
    Does this dialect/database support VALUES list (e.g. VALUES (1), (2), (3) )
    
    Overrides:
    
    supportsValuesList in class Dialect
    
    Returns:
    
    true if VALUES list are supported
  - supportsRowValueConstructorSyntaxInInList
```
public boolean supportsRowValueConstructorSyntaxInInList()
```
    Description copied from class: Dialect
    
    If the dialect supports row 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.
  - supportsPartitionBy
```
public boolean supportsPartitionBy()
```
    Description copied from class: Dialect
    
    Does the underlying database support partition by
    
    Overrides:
    
    supportsPartitionBy in class Dialect
    
    Returns:
    
    boolean
  - supportsNonQueryWithCTE
```
public boolean supportsNonQueryWithCTE()
```
    Description copied from class: Dialect
    
    Does this dialect/database support non-query statements (e.g. INSERT, UPDATE, DELETE) with CTE (Common Table Expressions)?
    
    Overrides:
    
    supportsNonQueryWithCTE in class Dialect
    
    Returns:
    
    true if non-query statements are supported with CTE
  - supportsOffsetInSubquery
```
public boolean supportsOffsetInSubquery()
```
    Description copied from class: Dialect
    
    Does this dialect support offset in subqueries? Ex: select * from Table1 where col1 in (select col1 from Table2 order by col2 limit 1 offset 1)
    
    Overrides:
    
    supportsOffsetInSubquery in class Dialect
    
    Returns:
    
    boolean
  - 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.
  - getGroupBySummarizationRenderingStrategy
```
public GroupBySummarizationRenderingStrategy getGroupBySummarizationRenderingStrategy()
```
    Description copied from class: Dialect
    
    The strategy to use for rendering summarizations in the GROUP BY clause.
    
    Overrides:
    
    getGroupBySummarizationRenderingStrategy in class Dialect
  - getGroupByConstantRenderingStrategy
```
public GroupByConstantRenderingStrategy getGroupByConstantRenderingStrategy()
```
    Description copied from class: Dialect
    
    The strategy to use for rendering constants in the GROUP BY clause.
    
    Overrides:
    
    getGroupByConstantRenderingStrategy in class Dialect
  - translateDatetimeFormat
```
public String translateDatetimeFormat(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 all of the pattern letter sequences understood by DateTimeFormatter, only the following subset of pattern letters is accepted by Hibernate:
    - G: era
    - y: year of era
    - Y: year of week-based year
    - M: month of year
    - w: week of week-based year (ISO week number)
    - W: week of month
    - E: day of week (name)
    - e: day of week (number)
    - d: day of month
    - D: day of year
    - a: AM/PM
    - H: hour of day (24 hour time)
    - h: hour of AM/PM (12 hour time)
    - m: minutes
    - s: seconds
    - z,Z,x: timezone offset
    In addition, punctuation characters and single-quoted literal strings are accepted.
    Overrides:
    
    translateDatetimeFormat in class Dialect
    
    Returns:
    
    a pattern accepted by the function that formats dates and times in this 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 the extract() function, or of this dialect's equivalent function.
    This method does not need to handle TemporalUnit.NANOSECOND, TemporalUnit.NATIVE, TemporalUnit.OFFSET, TemporalUnit.DATE, TemporalUnit.TIME, TemporalUnit.WEEK_OF_YEAR, nor TemporalUnit.WEEK_OF_MONTH, which are already desugared by ExtractFunction.
    
    Overrides:
    
    translateExtractField in class Dialect
  - toBooleanValueString
```
public String toBooleanValueString(boolean bool)
```
    Description copied from class: Dialect
    
    The SQL literal value to which this database maps boolean values.
    
    Overrides:
    
    toBooleanValueString in class Dialect
    
    Parameters:
    
    bool - The boolean value
    
    Returns:
    
    The appropriate SQL literal.
  - extractPattern
```
public String extractPattern(TemporalUnit unit)
```
    Description copied from class: Dialect
    
    Obtain a pattern for the SQL equivalent to an extract() function call. The resulting pattern must contain ?1 and ?2 placeholders for the arguments.
    This method does not need to handle TemporalUnit.NANOSECOND, TemporalUnit.NATIVE, TemporalUnit.OFFSET, TemporalUnit.DATE, TemporalUnit.TIME, TemporalUnit.WEEK_OF_YEAR, or TemporalUnit.WEEK_OF_MONTH, which are already desugared by ExtractFunction.
    
    Overrides:
    
    extractPattern in class Dialect
    
    Parameters:
    
    unit - the first argument

Class DB2Dialect

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.dialect.Dialect

Field Summary

Fields inherited from class org.hibernate.dialect.Dialect

Constructor Summary

Method Summary

Methods inherited from class org.hibernate.dialect.Dialect

Methods inherited from class java.lang.Object

Constructor Detail

DB2Dialect

DB2Dialect

DB2Dialect

Method Detail

createUniqueDelegate

getDefaultDecimalPrecision

getVersion

initializeFunctionRegistry

getDropSchemaCommand

getFractionalSecondPrecisionInNanos

timestampdiffPattern

timestampaddPattern

getLowercaseFunction

dropConstraints

getSequenceSupport

getQuerySequencesString

getSequenceInformationExtractor

getForUpdateString

supportsSkipLocked

getForUpdateSkipLockedString

getForUpdateSkipLockedString

getWriteLockString

getReadLockString

supportsOuterJoinForUpdate

supportsExistsInSelect

supportsLockTimeouts

getSelectClauseNullString

registerResultSetOutParameter

getResultSet

supportsCommentOn

getFallbackSqmMutationStrategy

supportsCurrentTimestampSelection

getCurrentTimestampSelectString

isCurrentTimestampSelectStringCallable

supportsParametersInInsertSelect

requiresCastingOfParametersInSelectClause

supportsResultSetPositionQueryMethodsOnForwardOnlyCursor

getCrossJoinSeparator

supportsEmptyInList

supportsLobValueChangePropagation

doesReadCommittedCauseWritersToBlockReaders

supportsTupleDistinctCounts

getFromDual

supportsSelectQueryWithoutFromClause

getSqlTypeDescriptorOverride

formatBinaryLiteral

buildSQLExceptionConversionDelegate

getUniqueDelegate

getNotExpression

getLimitHandler

supportsNullPrecedence

getSqlAstTranslatorFactory

renderOrderByElement

getIdentityColumnSupport

supportsValuesList

supportsRowValueConstructorSyntaxInInList

supportsPartitionBy

supportsNonQueryWithCTE

supportsOffsetInSubquery

supportsWindowFunctions

getGroupBySummarizationRenderingStrategy

getGroupByConstantRenderingStrategy

translateDatetimeFormat

translateExtractField

toBooleanValueString

extractPattern