Package org.hibernate.dialect

Class DB2Dialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.DB2Dialect

All Implemented Interfaces:

FunctionContributor, TypeContributor, ConversionContext

Direct Known Subclasses:

DB2iDialect, DB2SpatialDialect, DB2zDialect

public class DB2Dialect
extends Dialect

A SQL dialect for Db2 for LUW (Linux, Unix, and Windows) version 11.1 and above.

Please refer to the Db2 documentation.

See Also:

• DB2iDialect
• DB2zDialect

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, FALSE_STRING_VALUES, LEGACY_LOB_MERGE_STRATEGY, LOG_BASE2OF10, NEW_LOCATOR_LOB_MERGE_STRATEGY, QUOTE, STANDARD_MULTI_KEY_LOAD_SIZING_STRATEGY, STREAM_XFER_LOB_MERGE_STRATEGY, TRUE_STRING_VALUES

Constructor Summary

Constructors

Constructor	Description
DB2Dialect()
DB2Dialect(DatabaseVersion version)
DB2Dialect(DialectResolutionInfo info)

Method Summary

Modifier and Type	Method	Description
void	appendBinaryLiteral(SqlAppender appender, byte[] bytes)	Append a binary literal to the given SqlAppender.
void	appendBooleanValueString(SqlAppender appender, boolean bool)	Append the SQL literal expression representing the given boolean value to the given SqlAppender.
void	appendDatetimeFormat(SqlAppender appender, 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).
void	appendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone)	Append a datetime literal representing the given java.time value to the given SqlAppender.
void	appendDateTimeLiteral(SqlAppender appender, Calendar calendar, TemporalType precision, TimeZone jdbcTimeZone)	Append a datetime literal representing the given Calendar value to the given SqlAppender.
void	appendDateTimeLiteral(SqlAppender appender, Date date, TemporalType precision, TimeZone jdbcTimeZone)	Append a datetime literal representing the given Date value to the given SqlAppender.
IdentifierHelper	buildIdentifierHelper(IdentifierHelperBuilder builder, DatabaseMetaData metadata)	The IdentifierHelper indicated by this dialect for handling identifier conversions.
protected LockingSupport	buildLockingSupport()
SQLExceptionConversionDelegate	buildSQLExceptionConversionDelegate()	An instance of SQLExceptionConversionDelegate for interpreting dialect-specific error or SQLState codes.
boolean	canDisableConstraints()	Is there some way to disable foreign key constraint checking while truncating tables? (If there's no way to do it, and if we can't batch truncate, we must drop and recreate the constraints instead.)
String	castPattern(CastType from, CastType to)	Obtain a pattern for the SQL equivalent to a cast() function call.
protected String	columnType(int sqlTypeCode)	The database column type name for a given JDBC type code defined in Types or SqlTypes.
void	contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)	A callback which allows the Dialect to contribute types.
MutationOperation	createOptionalTableUpdateOperation(EntityMutationTarget mutationTarget, OptionalTableUpdate optionalTableUpdate, SessionFactoryImplementor factory)	Create a MutationOperation for a updating an optional table
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	doesRoundTemporalOnOverflow()	Does this dialect round a temporal when converting from a precision higher to a lower one?
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	generatedAs(String generatedAs)	The generated as clause, or similar, for generated column declarations in DDL statements.
AggregateSupport	getAggregateSupport()	How does this dialect support aggregate types like SqlTypes.STRUCT.
String	getAlterColumnTypeString(String columnName, String columnType, String columnDefinition)	The fragment of an alter table command which modifies a column type, or null if column types cannot be modified.
CallableStatementSupport	getCallableStatementSupport()	The CallableStatementSupport for this database.
String	getCreateIndexTail(boolean unique, List<Column> columns)	A string to be appended to the end of the create index command, usually to specify that null values are to be considered distinct.
String	getCreateUserDefinedTypeExtensionsString()	An arbitrary extension to append to the end of the UDT create type command.
String	getCurrentTimestampSelectString()	The command used to retrieve the current timestamp from the database.
DatabaseVersion	getDB2Version()	DB2 LUW Version
int	getDefaultDecimalPrecision()	This is the default precision for a generated column of exact numeric type DECIMAL or NUMERIC mapped to a BigInteger or BigDecimal.
int	getDefaultStatementBatchSize()	The default value to use for the configuration property "hibernate.jdbc.batch_size".
String	getDisableConstraintStatement(String tableName, String name)	A SQL statement that temporarily disables checking of the given foreign key constraint.
DmlTargetColumnQualifierSupport	getDmlTargetColumnQualifierSupport()	Get the minimum DmlTargetColumnQualifierSupport required by this dialect.
String[]	getDropSchemaCommand(String schemaName)	Get the SQL command used to drop the named schema.
String	getDual()	Returns a table expression that has one row.
String	getEnableConstraintStatement(String tableName, String name)	A SQL statement that re-enables checking of the given foreign key constraint.
SqmMultiTableInsertStrategy	getFallbackSqmInsertStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)	The SqmMultiTableInsertStrategy to use when not specified by QueryEngineOptions.getCustomSqmMultiTableInsertStrategy().
SqmMultiTableMutationStrategy	getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)	The SqmMultiTableMutationStrategy to use when not specified by QueryEngineOptions.getCustomSqmMultiTableMutationStrategy().
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 pessimistic UPGRADE 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	getFromDualForSelectOnly()
TemporaryTableStrategy	getGlobalTemporaryTableStrategy()	The strategy to use for global temporary tables.
IdentityColumnSupport	getIdentityColumnSupport()	Get the appropriate IdentityColumnSupport for this dialect.
int	getInExpressionCountLimit()	Return the limit that the underlying database places on the number of elements in an IN predicate.
LimitHandler	getLimitHandler()	Obtain a LimitHandler that implements pagination support for Query.setMaxResults(int) and Query.setFirstResult(int).
LockingSupport	getLockingSupport()	Access to various details and operations related to this Dialect's support for pessimistic locking.
int	getMaxIdentifierLength()	What is the maximum identifier length supported by this dialect?
protected int	getMaximumSeriesSize()	DB2 doesn't support the generate_series function or lateral 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.
int	getMaxVarcharLength()	The biggest size value that can be supplied as argument to a Types.VARCHAR-like type.
protected DatabaseVersion	getMinimumSupportedVersion()	Get the version of the SQL dialect that is the minimum supported by this implementation.
int	getPreferredSqlTypeCodeForArray()	The JDBC type code to use for mapping properties of basic Java array or Collection types.
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.
String	getReadLockString(Timeout 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.
ResultSet	getResultSet(CallableStatement statement, int position)	Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet from the positional OUT parameter.
ResultSet	getResultSet(CallableStatement statement, String name)	Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet from the named OUT parameter.
String	getSelectClauseNullString(int sqlType, TypeConfiguration typeConfiguration)	Given a JDBC type code, return the expression for a literal null value of that type, to use in a select clause.
SequenceInformationExtractor	getSequenceInformationExtractor()	A SequenceInformationExtractor which is able to extract SequenceInformation from the JDBC result set returned when Dialect.getQuerySequencesString() is executed.
SequenceSupport	getSequenceSupport()	Get the appropriate SequenceSupport for this dialect.
SqlAstTranslatorFactory	getSqlAstTranslatorFactory()	Return a SqlAstTranslatorFactory specific to this dialect, or null to use the standard translator.
Exporter<Table>	getTableExporter()	Get an Exporter for Tables, usually StandardTableExporter.
String	getTruncateTableStatement(String tableName)	A SQL statement that truncates the given table.
UniqueDelegate	getUniqueDelegate()	Get the UniqueDelegate supported by this dialect
ViolatedConstraintNameExtractor	getViolatedConstraintNameExtractor()	A ViolatedConstraintNameExtractor for extracting the name of a violated constraint from a SQLException.
String	getWriteLockString(int timeout)	Get the string to append to SELECT statements to acquire pessimistic WRITE locks for this dialect.
String	getWriteLockString(Timeout timeout)	Get the string to append to SELECT statements to acquire pessimistic WRITE locks for this dialect.
void	initializeFunctionRegistry(FunctionContributions functionContributions)	Initialize the given registry with any dialect-specific functions.
boolean	isCurrentTimestampSelectStringCallable()	Is the command returned by Dialect.getCurrentTimestampSelectString() treated as callable?
protected void	registerColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)	Register ANSI-standard column types using the length limits defined by Dialect.getMaxVarcharLength(), Dialect.getMaxNVarcharLength(), and Dialect.getMaxVarbinaryLength().
int	registerResultSetOutParameter(CallableStatement statement, int col)	Registers a parameter capable of returning a ResultSet by position, either an OUT parameter, or a REF_CURSOR parameter as defined in Java 8.
int	registerResultSetOutParameter(CallableStatement statement, String name)	Registers a parameter capable of returning a ResultSet by name, either an OUT parameter, or a REF_CURSOR parameter as defined in Java 8.
boolean	requiresCastForConcatenatingNonStrings()	Does this dialect/database require casting of non-string arguments in the concat() function?
String	rowId(String rowId)	The more "standard" syntax is rid_bit(alias) but here we use alias.rowid.
int	rowIdSqlType()	The JDBC type code of the rowid-like pseudo-column which acts as a high-performance row locator.
static String	selectNullString(int sqlType)
boolean	supportsAlterColumnType()	Does this dialect support modifying the type of an existing column?
boolean	supportsCommentOn()	Does this dialect support commenting on tables and columns?
boolean	supportsCurrentTimestampSelection()	Does this dialect support some way to retrieve the current timestamp value from the database?
boolean	supportsDistinctFromPredicate()	Does this dialect support some kind of distinct from predicate?
boolean	supportsExistsInSelect()	Does the dialect support an exists statement in the select clause?
boolean	supportsFromClauseInUpdate()	Does this dialect support the from clause for update statements?
boolean	supportsIfExistsBeforeTableName()	For dropping a table, can the phrase if exists be applied before the table name?
boolean	supportsInsertReturning()	Does this dialect fully support returning arbitrary generated column values after execution of an insert statement, using native SQL syntax?
boolean	supportsInsertReturningRowId()	Does this dialect supports returning the RowId column after execution of an insert statement, using native SQL syntax?
boolean	supportsIsTrue()	Does this dialect support the is true and is false operators?
boolean	supportsLateral()	Does this dialect support the SQL lateral keyword or a proprietary alternative?
boolean	supportsLobValueChangePropagation()	Does the dialect support propagating changes to LOB values back to the database? Talking about mutating the internal value of the locator, as opposed to supplying a new locator instance.
boolean	supportsNationalizedMethods()	Checks whether the JDBC driver implements methods for handling nationalized character data types ResultSet.getNString(int) / PreparedStatement.setNString(int, String), ResultSet.getNClob(int) /PreparedStatement.setNClob(int, NClob), ResultSet.getNCharacterStream(int) / PreparedStatement.setNCharacterStream(int, Reader, long)
boolean	supportsNonQueryWithCTE()	Does this dialect support insert, update, and delete statements with Common Table Expressions (CTEs)?
boolean	supportsNullPrecedence()	Does this dialect support nulls first and nulls last?
boolean	supportsOffsetInSubquery()	Does this dialect support offset in subqueries?
boolean	supportsPartitionBy()	Does is dialect support partition by in window functions?
boolean	supportsRecursiveCTE()	Does this dialect/database support recursive CTEs?
Boolean	supportsRefCursors()	Whether this Dialect supports the JDBC Types.REF_CURSOR type.
boolean	supportsResultSetPositionQueryMethodsOnForwardOnlyCursor()	Does this dialect support asking the result set its positioning information on forward-only cursors?
boolean	supportsRowValueConstructorSyntax()	Is this dialect known to support what ANSI-SQL terms "row value constructor" syntax; sometimes called tuple syntax.
boolean	supportsRowValueConstructorSyntaxInInList()	If the dialect supports row values, does it offer such support in IN lists as well?
boolean	supportsRowValueConstructorSyntaxInInSubQuery()	If the dialect supports row values, does it offer such support in IN subqueries as well?
boolean	supportsRowValueConstructorSyntaxInQuantifiedPredicates()	Is this dialect known to support what ANSI-SQL terms "row value constructor" syntax; sometimes called tuple syntax with quantified predicates.
boolean	supportsTupleDistinctCounts()	Does this dialect support count(distinct a,b)?
boolean	supportsUserDefinedTypes()	Does the database support user defined types?
boolean	supportsValuesList()	Does this dialect support values lists of form VALUES (1), (2), (3)?
boolean	supportsWindowFunctions()	Does this dialect support window functions like row_number() over (..)?
boolean	supportsWithClauseInSubquery()	Whether the SQL with clause is supported within a subquery.
String	timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType)	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	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.
boolean	useConnectionToCreateLob()	Should Blob, Clob, and NClob be created solely using Connection.createBlob(), Connection.createClob(), and Connection.createNClob(), instead of allowing the use of our own implementations.

Methods inherited from class org.hibernate.dialect.Dialect

addPartitionKeyToPrimaryKey, addSqlHintOrComment, addUseIndexQueryHint, appendArrayLiteral, appendCheckConstraintOptions, appendIntervalLiteral, appendIntervalLiteral, appendLiteral, appendLockHint, appendUUIDLiteral, applyLocksToSql, augmentPhysicalTableTypes, augmentRecognizedTableTypes, buildLockingClauseStrategy, buildOptimisticForceIncrementStrategy, buildOptimisticStrategy, buildPessimisticForceIncrementStrategy, buildPessimisticReadStrategy, buildPessimisticWriteStrategy, buildReadStrategy, buildStringToBooleanCast, buildStringToBooleanCastDecode, buildStringToBooleanDecode, canBatchTruncate, canCreateCatalog, canCreateSchema, castType, checkVersion, closeQuote, contribute, contributeFunctions, currentDate, currentLocalTime, currentLocalTimestamp, currentTime, currentTimestamp, currentTimestampWithTimeZone, defaultScrollMode, determineDatabaseVersion, doesRepeatableReadCauseReadersToBlockWriters, equivalentTypes, escapeComment, forceLobAsLastValue, getAddColumnString, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAlterTableString, getArrayTypeName, getAuxiliaryDatabaseObjectExporter, getBatchLoadSizingStrategy, getBeforeDropStatement, getCascadeConstraintsString, getCaseInsensitiveLike, getCatalogSeparator, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckConstraintString, getColumnAliasExtractor, getColumnComment, getCreateCatalogCommand, getCreateEnumTypeCommand, getCreateEnumTypeCommand, getCreateIndexString, getCreateMultisetTableString, getCreateSchemaCommand, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getCreateUserDefinedTypeKindString, getCrossReferenceParentTableFilter, getCurrentSchemaCommand, getDefaultIntervalSecondScale, getDefaultLobLength, getDefaultNonContextualLobCreation, getDefaultOrdinalityColumnName, getDefaultProperties, getDefaultTimestampPrecision, getDefaultUseGetGeneratedKeys, getDisableConstraintsStatement, getDoublePrecision, getDropCatalogCommand, getDropEnumTypeCommand, getDropEnumTypeCommand, getDropForeignKeyString, getDropTableString, getDropUniqueKeyString, getEnableConstraintsStatement, getEnumTypeDeclaration, getEnumTypeDeclaration, getFallbackSchemaManagementTool, getFloatPrecision, getForeignKeyExporter, getForUpdateNowaitString, getForUpdateNowaitString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getFunctionalDependencyAnalysisSupport, getGroupBySelectItemReferenceStrategy, getHqlTranslator, getIndexExporter, getKeywords, getLobMergeStrategy, getLocalTemporaryTableStrategy, getLockingClauseStrategy, getLockingStrategy, getLockingStrategy, getLockRowIdentifier, getLowercaseFunction, getMaxAliasLength, getMaxNVarcharCapacity, getMaxNVarcharLength, getMaxVarbinaryCapacity, getMaxVarbinaryLength, getMaxVarcharCapacity, getMultiKeyLoadSizingStrategy, getNameQualifierSupport, getNationalizationSupport, getNativeIdentifierGeneratorStrategy, getNativeParameterMarkerStrategy, getNativeValueGenerationStrategy, getNoColumnsInsertString, getNullColumnString, getNullColumnString, getNullOrdering, getParameterCountLimit, getPersistentTemporaryTableStrategy, getPessimisticLockStyle, getPreferredSqlTypeCodeForBoolean, getQueryHintString, getQueryHintString, getReadLockString, getReadLockString, getReadRowLockStrategy, getRowIdColumnString, getSchemaNameResolver, getSelectClauseNullString, getSelectGUIDString, getSequenceExporter, getSizeStrategy, getSqmTranslatorFactory, getSupportedTemporaryTableKind, getTableCleaner, getTableComment, getTableMigrator, getTableTypeString, getTemporaryTableAfterUseAction, getTemporaryTableBeforeUseAction, getTemporaryTableCreateCommand, getTemporaryTableCreateOptions, getTemporaryTableDdlTransactionHandling, getTemporaryTableDropCommand, getTemporaryTableExporter, getTemporaryTableTruncateCommand, getTimeoutInSeconds, getTimeZoneSupport, getTruncateTableStatements, getUniqueKeyExporter, getUserDefinedTypeComment, getUserDefinedTypeExporter, getVersion, getWriteLockString, getWriteLockString, getWriteRowLockStrategy, hasAlterTable, hasDataTypeBeforeGeneratedAs, hasSelfReferentialForeignKeyBug, initDefaultProperties, isEmptyStringTreatedAsNull, isJdbcLogWarningsEnabledByDefault, isLob, openQuote, ordinal, prependComment, qualifyIndexName, quote, quoteCollation, registerDefaultKeywords, registerKeyword, registerKeywords, requiresColumnListInCreateView, requiresFloatCastingOfIntegerDivision, requiresParensForTupleCounts, requiresParensForTupleDistinctCounts, resolveSqlTypeCode, resolveSqlTypeCode, resolveSqlTypeDescriptor, resolveSqlTypeLength, stripsTrailingSpacesFromChar, supportsArrayConstructor, supportsBatchUpdates, supportsBindAsCallableArgument, supportsBindingNullForSetObject, supportsBindingNullSqlTypeForSetNull, supportsBitType, supportsCascadeDelete, supportsCaseInsensitiveLike, supportsCircularCascadeDeleteConstraints, supportsColumnCheck, supportsConflictClauseForInsertCTE, supportsCrossJoin, supportsDuplicateSelectItemsInQueryGroup, supportsExpectedLobUsagePattern, supportsFetchClause, supportsFilterClause, supportsForUpdate, supportsFractionalTimestampArithmetic, supportsIfExistsAfterAlterTable, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsAfterTypeName, supportsIfExistsBeforeConstraintName, supportsIfExistsBeforeTypeName, supportsInsertReturningGeneratedKeys, supportsIntersect, supportsJdbcConnectionLobCreation, supportsJoinInMutationStatementSubquery, supportsJoinsInDelete, supportsLockTimeouts, supportsMaterializedLobAccess, supportsNamedColumnCheck, supportsNamedParameters, supportsNestedSubqueryCorrelation, supportsNestedWithClause, supportsNoColumnsInsert, supportsNoWait, supportsOrderByInSubquery, supportsOrdinalSelectItemReference, supportsOuterJoinForUpdate, supportsPredicateAsExpression, supportsRecursiveCycleClause, supportsRecursiveCycleUsingClause, supportsRecursiveSearchClause, supportsRowConstructor, supportsRowValueConstructorDistinctFromSyntax, supportsRowValueConstructorGtLtSyntax, supportsSimpleQueryGrouping, supportsSkipLocked, supportsStandardArrays, supportsStandardCurrentTimestampFunction, supportsSubqueryInSelect, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTableOptions, supportsTemporalLiteralOffset, supportsTemporaryTablePrimaryKey, supportsTemporaryTables, supportsTruncateWithCast, supportsTupleCounts, supportsUnboundedLobLocatorMaterialization, supportsUnionAll, supportsUnionInSubquery, supportsUpdateReturning, supportsValuesListForInsert, supportsWait, supportsWithClause, toBooleanValueString, toQuotedIdentifier, toString, transformSelectString, translateDurationField, trimPattern, unquoteGetGeneratedKeys, useArrayForMultiValuedParameters, useCrossReferenceForeignKeys, useFollowOnLocking, useInputStreamToInsertBlob, useMaterializedLobWhenCapacityExceeded

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DB2Dialect

public DB2Dialect()

DB2Dialect

public DB2Dialect(DialectResolutionInfo info)

DB2Dialect

public DB2Dialect(DatabaseVersion version)

Method Details

buildLockingSupport

protected LockingSupport buildLockingSupport()

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 an Exporter for Tables, usually StandardTableExporter.

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 in Types or SqlTypes. This default implementation returns the ANSI-standard type name.

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

Note that:

1. Implementations of this method are expected to define a sensible mapping forTypes.NCLOB Types.NCHAR, and Types.NVARCHAR. On some database, these types are simply remapped to CLOB, CHAR, and VARCHAR.
2. Mappings for Types.TIMESTAMP and Types.TIMESTAMP_WITH_TIMEZONE should support explicit specification of precision if possible.
3. As specified by DdlTypeRegistry.getDescriptor(int), this method never receives Types.LONGVARCHAR, Types.LONGNVARCHAR, nor Types.LONGVARBINARY, which are considered synonyms for their non-LONG counterparts.
4. On the other hand, the types SqlTypes.LONG32VARCHAR, SqlTypes.LONG32NVARCHAR, and SqlTypes.LONG32VARBINARY are not synonyms, and implementations of this method must define sensible mappings, for example to database-native TEXT or CLOB types.

Overrides:

columnType in class Dialect

Parameters:

sqlTypeCode - a SQL type code

Returns:

a column type name, with $l, $p, $s placeholders for length, precision, scale

See Also:

• SqlTypes

registerColumnTypes

protected void registerColumnTypes(TypeContributions typeContributions,
 ServiceRegistry serviceRegistry)

Description copied from class: Dialect

Register ANSI-standard column types using the length limits defined by Dialect.getMaxVarcharLength(), Dialect.getMaxNVarcharLength(), and Dialect.getMaxVarbinaryLength().

This method is always called when a Dialect is instantiated.

Overrides:

registerColumnTypes in class Dialect

createOptionalTableUpdateOperation

public MutationOperation createOptionalTableUpdateOperation(EntityMutationTarget mutationTarget,
 OptionalTableUpdate optionalTableUpdate,
 SessionFactoryImplementor factory)

Description copied from class: Dialect

Create a MutationOperation for a updating an optional table

Overrides:

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

For longer column lengths, use some sort of text-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 type DECIMAL or NUMERIC 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

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

supportsDistinctFromPredicate

public boolean supportsDistinctFromPredicate()

Description copied from class: Dialect

Does this dialect support some kind of distinct 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 of distinct 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 with java.time types:

• local date
• local time
• local datetime
• offset datetime
• instant

And a number of additional "standard" functions:

• left(string, length)
• right(string, length)
• replace(string, pattern, replacement)
• pad(string with length spec[ character])
• repeat(string, times)

• pi
• log10(arg)
• log(base, arg)
• sign(arg)
• sin(arg)
• cos(arg)
• tan(arg)
• asin(arg)
• acos(arg)
• atan(arg)
• atan2(arg0, arg1)
• round(arg0[, arg1])
• truncate(arg0[, arg1])
• sinh(arg)
• tanh(arg)
• cosh(arg)
• least(arg0, arg1, ...)
• greatest(arg0, arg1, ...)
• degrees(arg)
• radians(arg)
• bitand(arg1, arg1)
• bitor(arg1, arg1)
• bitxor(arg1, arg1)

• format(datetime as pattern)
• collate(string as collation)
• str(arg) - synonym of cast(a as String)
• ifnull(arg0, arg1) - synonym of coalesce(a, b)

• ordinal(arg)
• string(arg)

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

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

Note that according to this definition, the second() function returns a floating point value, contrary to the integer type returned by the native function with this name on many databases. Thus, we don't just naively map these HQL functions to the native SQL functions with the same names.

Overrides:

initializeFunctionRegistry in class Dialect

getMaximumSeriesSize

protected int getMaximumSeriesSize()

DB2 doesn't support the generate_series function or lateral 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 JDBC type code to use for mapping properties of basic Java array or Collection types.

Usually SqlTypes.ARRAY or SqlTypes.VARBINARY.

Overrides:

getPreferredSqlTypeCodeForArray in class Dialect

Returns:

one of the type codes defined by SqlTypes.

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,
 IntervalType intervalType)

Description copied from class: Dialect

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

Overrides:

timestampaddPattern in class Dialect

Parameters:

unit - The unit to add to the temporal

temporalType - The type of the temporal

intervalType - The type of interval to add or null if it's not a native interval

appendDateTimeLiteral

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

Description copied from class: Dialect

Append a datetime literal representing the given java.time value to the given SqlAppender.

Overrides:

appendDateTimeLiteral in class Dialect

appendDateTimeLiteral

public void appendDateTimeLiteral(SqlAppender appender,
 Date date,
 TemporalType precision,
 TimeZone jdbcTimeZone)

Description copied from class: Dialect

Append a datetime literal representing the given Date value to the given SqlAppender.

Overrides:

appendDateTimeLiteral in class Dialect

appendDateTimeLiteral

public void appendDateTimeLiteral(SqlAppender appender,
 Calendar calendar,
 TemporalType precision,
 TimeZone jdbcTimeZone)

Description copied from class: Dialect

Append a datetime literal representing the given Calendar value to the given SqlAppender.

Overrides:

appendDateTimeLiteral in class Dialect

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 the create index command, usually to specify that null values are to be considered distinct.

Overrides:

getCreateIndexTail in class Dialect

getSequenceSupport

public SequenceSupport getSequenceSupport()

Description copied from class: Dialect

Get the appropriate SequenceSupport for this dialect.

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.

getSequenceInformationExtractor

public SequenceInformationExtractor getSequenceInformationExtractor()

Description copied from class: Dialect

A SequenceInformationExtractor which is able to extract SequenceInformation from the JDBC result set returned when Dialect.getQuerySequencesString() is executed.

Overrides:

getSequenceInformationExtractor in class Dialect

getLockingSupport

public LockingSupport getLockingSupport()

Description copied from class: Dialect

Access to various details and operations related to this Dialect's support for pessimistic locking.

Overrides:

getLockingSupport in class Dialect

getForUpdateString

public String getForUpdateString()

Description copied from class: Dialect

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

Overrides:

getForUpdateString in class Dialect

Returns:

The appropriate FOR UPDATE clause string.

getForUpdateSkipLockedString

public String getForUpdateSkipLockedString()

Description copied from class: Dialect

Retrieves the FOR UPDATE SKIP LOCKED syntax specific to this dialect.

Overrides:

getForUpdateSkipLockedString in class Dialect

Returns:

The appropriate FOR UPDATE SKIP LOCKED clause string.

getForUpdateSkipLockedString

public String getForUpdateSkipLockedString(String aliases)

Description copied from class: Dialect

Get the FOR UPDATE OF column_list SKIP LOCKED fragment appropriate for this dialect, given the aliases of the columns to be write locked.

Overrides:

getForUpdateSkipLockedString in class Dialect

Parameters:

aliases - The columns to be write locked.

Returns:

The appropriate FOR UPDATE colunm_list SKIP LOCKED clause string.

getWriteLockString

public String getWriteLockString(Timeout timeout)

Description copied from class: Dialect

Get the string to append to SELECT 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. See Timeouts 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 to SELECT 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. See Timeouts for some "magic values".

Returns:

The appropriate LOCK clause string.

getWriteLockString

public String getWriteLockString(int timeout)

Description copied from class: Dialect

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

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

Overrides:

getWriteLockString in class Dialect

Parameters:

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

Returns:

The appropriate LOCK clause string.

getReadLockString

public String getReadLockString(int timeout)

Description copied from class: Dialect

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

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

Overrides:

getReadLockString in class Dialect

Parameters:

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

Returns:

The appropriate LOCK clause string.

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.

requiresCastForConcatenatingNonStrings

public boolean requiresCastForConcatenatingNonStrings()

Description copied from class: Dialect

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

Overrides:

requiresCastForConcatenatingNonStrings in class Dialect

Returns:

true if casting using cast() is required

getSelectClauseNullString

public String getSelectClauseNullString(int sqlType,
 TypeConfiguration typeConfiguration)

Description copied from class: Dialect

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

The select query will be an element of a UNION or UNION ALL.

Overrides:

getSelectClauseNullString in class Dialect

Parameters:

sqlType - The Types 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 JDBC Types.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)
                                  throws SQLException

Description copied from class: Dialect

Registers a parameter capable of returning a ResultSet by position, either an OUT parameter, or a REF_CURSOR parameter as defined in Java 8.

Overrides:

registerResultSetOutParameter in class Dialect

Parameters:

statement - The callable statement.

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

Returns:

The number of (contiguous) bind positions used.

Throws:

SQLException - Indicates problems registering the param.

registerResultSetOutParameter

public int registerResultSetOutParameter(CallableStatement statement,
 String name)
                                  throws SQLException

Description copied from class: Dialect

Registers a parameter capable of returning a ResultSet by name, either an OUT parameter, or a REF_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)
                       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.

getResultSet

public ResultSet getResultSet(CallableStatement statement,
 int position)
                       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 positional OUT 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)
                       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 named OUT 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 an alter table command which modifies a column type, or null if column types cannot be modified. Often alter column col_name set data type col_type.

Overrides:

getAlterColumnTypeString in class Dialect

Parameters:

columnName - the name of the column

columnType - the new type of the column

columnDefinition - the full column definition

Returns:

a fragment to be appended to alter table

supportsAlterColumnType

public boolean supportsAlterColumnType()

Description copied from class: Dialect

Does this dialect support modifying the type of an existing column?

Overrides:

supportsAlterColumnType in class Dialect

supportsIfExistsBeforeTableName

public boolean supportsIfExistsBeforeTableName()

Description copied from class: Dialect

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

Overrides:

supportsIfExistsBeforeTableName in class Dialect

Returns:

true if if exists can be applied before the table name

getFallbackSqmMutationStrategy

public SqmMultiTableMutationStrategy getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor,
 RuntimeModelCreationContext runtimeModelCreationContext)

Description copied from class: Dialect

The SqmMultiTableMutationStrategy to use when not specified by QueryEngineOptions.getCustomSqmMultiTableMutationStrategy().

Overrides:

getFallbackSqmMutationStrategy in class Dialect

See Also:

• 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

The SqmMultiTableInsertStrategy to use when not specified by QueryEngineOptions.getCustomSqmMultiTableInsertStrategy().

Overrides:

getFallbackSqmInsertStrategy in class Dialect

See Also:

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

getGlobalTemporaryTableStrategy

public TemporaryTableStrategy getGlobalTemporaryTableStrategy()

Description copied from class: Dialect

The strategy to use for global temporary tables.

Overrides:

getGlobalTemporaryTableStrategy in class Dialect

supportsIsTrue

public boolean supportsIsTrue()

Description copied from class: Dialect

Does this dialect support the is true and is false operators?

Overrides:

supportsIsTrue in class Dialect

Returns:

true if the database supports is true and is false, or false if it does not. The default is is false.

supportsCurrentTimestampSelection

public boolean supportsCurrentTimestampSelection()

Description copied from class: Dialect

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

Overrides:

supportsCurrentTimestampSelection in class Dialect

Returns:

True if the current timestamp can be retrieved; false otherwise.

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 by Dialect.getCurrentTimestampSelectString() treated as callable?

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

Overrides:

isCurrentTimestampSelectStringCallable in class Dialect

Returns:

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

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.

Overrides:

supportsResultSetPositionQueryMethodsOnForwardOnlyCursor in class Dialect

Returns:

True if methods like ResultSet.isAfterLast() and ResultSet.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), 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).

Overrides:

supportsLobValueChangePropagation in class Dialect

Returns:

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

useConnectionToCreateLob

public boolean useConnectionToCreateLob()

Description copied from class: Dialect

Should Blob, Clob, and NClob be created solely using Connection.createBlob(), Connection.createClob(), and Connection.createNClob(), instead of allowing the use of our own implementations.

Overrides:

useConnectionToCreateLob in class Dialect

Returns:

True if these types should be instantiated using Connection.

supportsNationalizedMethods

public boolean supportsNationalizedMethods()

Description copied from class: Dialect

Checks whether the JDBC driver implements methods for handling nationalized character data types ResultSet.getNString(int) / PreparedStatement.setNString(int, String), ResultSet.getNClob(int) /PreparedStatement.setNClob(int, NClob), ResultSet.getNCharacterStream(int) / PreparedStatement.setNCharacterStream(int, Reader, long)

Overrides:

supportsNationalizedMethods in class Dialect

Returns:

true if the driver implements these methods

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.

contributeTypes

public void contributeTypes(TypeContributions typeContributions,
 ServiceRegistry serviceRegistry)

Description copied from class: Dialect

A callback which allows the Dialect to contribute types.

Overrides:

contributeTypes in class Dialect

Parameters:

typeContributions - Callback to contribute the types

serviceRegistry - The service registry

getAggregateSupport

public AggregateSupport getAggregateSupport()

Description copied from class: Dialect

How does this dialect support aggregate types like SqlTypes.STRUCT.

Overrides:

getAggregateSupport in class Dialect

getCallableStatementSupport

public CallableStatementSupport getCallableStatementSupport()

Description copied from class: Dialect

The CallableStatementSupport 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 given SqlAppender.

Overrides:

appendBinaryLiteral in class Dialect

getViolatedConstraintNameExtractor

public ViolatedConstraintNameExtractor getViolatedConstraintNameExtractor()

Description copied from class: Dialect

A ViolatedConstraintNameExtractor for extracting the name of a violated constraint from a SQLException.

Specified by:

getViolatedConstraintNameExtractor in interface ConversionContext

Overrides:

getViolatedConstraintNameExtractor in class Dialect

buildSQLExceptionConversionDelegate

public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate()

Description copied from class: Dialect

An instance of SQLExceptionConversionDelegate for interpreting dialect-specific error or SQLState codes.

If this method is overridden to return a non-null value, the default SQLExceptionConverter will use the returned SQLExceptionConversionDelegate in addition to the following standard delegates:

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

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

Overrides:

buildSQLExceptionConversionDelegate in class Dialect

Returns:

The SQLExceptionConversionDelegate for this dialect

getUniqueDelegate

public UniqueDelegate getUniqueDelegate()

Description copied from class: Dialect

Get the UniqueDelegate 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 a LimitHandler that implements pagination support for Query.setMaxResults(int) and Query.setFirstResult(int).

Overrides:

getLimitHandler in class Dialect

supportsNullPrecedence

public boolean supportsNullPrecedence()

Description copied from class: Dialect

Does this dialect support nulls first and nulls last?

Overrides:

supportsNullPrecedence in class Dialect

getSqlAstTranslatorFactory

public SqlAstTranslatorFactory getSqlAstTranslatorFactory()

Description copied from class: Dialect

Return a SqlAstTranslatorFactory specific to this dialect, or null to use the standard translator.

Overrides:

getSqlAstTranslatorFactory in class Dialect

See Also:

• StandardSqlAstTranslatorFactory
• JdbcEnvironment.getSqlAstTranslatorFactory()

getIdentityColumnSupport

public IdentityColumnSupport getIdentityColumnSupport()

Description copied from class: Dialect

Get the appropriate IdentityColumnSupport 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 an insert 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 use select ... from new table (insert .... )

See Also:

• InsertReturningDelegate

supportsInsertReturningRowId

public boolean supportsInsertReturningRowId()

Description copied from class: Dialect

Does this dialect supports returning the RowId column after execution of an insert 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 support values lists of form VALUES (1), (2), (3)?

Overrides:

supportsValuesList in class Dialect

Returns:

true if values list are supported

supportsPartitionBy

public boolean supportsPartitionBy()

Description copied from class: Dialect

Does is dialect support partition by in window functions?

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 support offset in subqueries?

For example:

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

Overrides:

supportsOffsetInSubquery in class Dialect

Returns:

true if it does

supportsWindowFunctions

public boolean supportsWindowFunctions()

Description copied from class: Dialect

Does this dialect support window functions like row_number() over (..)?

Overrides:

supportsWindowFunctions in class Dialect

Returns:

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

supportsLateral

public boolean supportsLateral()

Description copied from class: Dialect

Does this dialect support the SQL lateral keyword or a proprietary alternative?

Overrides:

supportsLateral in class Dialect

Returns:

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

appendDatetimeFormat

public void appendDatetimeFormat(SqlAppender appender,
 String format)

Description copied from class: Dialect

Translate the given datetime format string from the pattern language defined by Java's DateTimeFormatter to whatever pattern language is understood by the native datetime formatting function for this database (often the to_char() function).

Since it's never possible to translate every pattern letter sequences understood by DateTimeFormatter, only the following subset of pattern letters is accepted by Hibernate:

• G: era
• y: year of era
• Y: year of week-based year
• M: month of year
• w: week of week-based year (ISO week number)
• W: week of month
• E: day of week (name)
• e: day of week (number)
• d: day of month
• D: day of year
• a: AM/PM
• H: hour of day (24 hour time)
• h: hour of AM/PM (12 hour time)
• m: minutes
• s: seconds
• z,Z,x: timezone offset

In addition, punctuation characters and single-quoted literal strings are accepted.

Appends a pattern accepted by the function that formats dates and times in this dialect to a SQL fragment that is being constructed.

Overrides:

appendDatetimeFormat in class Dialect

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

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 given SqlAppender.

Overrides:

appendBooleanValueString in class Dialect

Parameters:

appender - The SqlAppender 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 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

castPattern

public String castPattern(CastType from,
 CastType to)

Description copied from class: Dialect

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

Overrides:

castPattern in class Dialect

Parameters:

from - a CastType indicating the type of the value argument

to - a CastType indicating the type the value argument is cast to

getInExpressionCountLimit

public int getInExpressionCountLimit()

Description copied from class: Dialect

Return the limit that the underlying database places on the number of elements in an IN 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

The generated 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:

The generated as clause containing the given expression

buildIdentifierHelper

public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuilder builder,
 DatabaseMetaData metadata)
                                       throws SQLException

Description copied from class: Dialect

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

The incoming builder will have the following set:

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

By default, Hibernate will do the following:

• Call IdentifierHelperBuilder.applyIdentifierCasing(DatabaseMetaData)
• Call IdentifierHelperBuilder.applyReservedWords(DatabaseMetaData)
• Applies AnsiSqlKeywords.sql2003() as reserved words
• Applies the Dialect.sqlKeywords collected here as reserved words
• Applies the Dialect's NameQualifierSupport, if it defines one

Overrides:

buildIdentifierHelper in class Dialect

Parameters:

builder - A partially-configured IdentifierHelperBuilder.

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

Returns:

The IdentifierHelper instance to use, or null to indicate Hibernate should use its fallback path

Throws:

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

See Also:

• 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't batch truncate, we must drop and recreate the constraints instead.)

Overrides:

canDisableConstraints in class Dialect

Returns:

true if there is some way to do it

See Also:

• 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 UDT create type command.

Overrides:

getCreateUserDefinedTypeExtensionsString in class Dialect

rowId

public String rowId(String rowId)

The more "standard" syntax is rid_bit(alias) but here we use alias.rowid.

There is also an alternative rid() of type bigint, but it cannot be used with partitioning.

Overrides:

rowId in class Dialect

Parameters:

rowId - the name specified by RowId.value(), which is ignored if Dialect.getRowIdColumnString(java.lang.String) is not overridden

rowIdSqlType

public int rowIdSqlType()

Description copied from class: Dialect

The JDBC type code of the rowid-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 minimum DmlTargetColumnQualifierSupport required by this dialect.

Overrides:

getDmlTargetColumnQualifierSupport in class Dialect

Returns:

the column qualifier support required by this dialect

supportsFromClauseInUpdate

public boolean supportsFromClauseInUpdate()

Description copied from class: Dialect

Does this dialect support the from clause for update statements?

Overrides:

supportsFromClauseInUpdate in class Dialect

Returns:

true if from clause is supported

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's dual.

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

supportsRowValueConstructorSyntaxInInSubQuery

public boolean supportsRowValueConstructorSyntaxInInSubQuery()

Description copied from class: Dialect

If the dialect supports row values, does it offer such support in IN subqueries as well?

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

Overrides:

supportsRowValueConstructorSyntaxInInSubQuery in class Dialect

Returns:

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