Package org.hibernate.dialect

Class HSQLDialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.HSQLDialect

All Implemented Interfaces:

FunctionContributor, TypeContributor, ConversionContext

public class HSQLDialect
extends Dialect

A SQL dialect for HSQLDB (HyperSQL) 2.6.1 and above.

Nested Class Summary

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

Dialect.SizeStrategy, Dialect.SizeStrategyImpl

Field Summary

Fields inherited from class org.hibernate.dialect.Dialect

CLOSED_QUOTE, LEGACY_LOB_MERGE_STRATEGY, LOG_BASE2OF10, NEW_LOCATOR_LOB_MERGE_STRATEGY, QUOTE, STANDARD_MULTI_KEY_LOAD_SIZING_STRATEGY, STREAM_XFER_LOB_MERGE_STRATEGY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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).
IdentifierHelper	buildIdentifierHelper(IdentifierHelperBuilder builder, DatabaseMetaData dbMetaData)	The IdentifierHelper indicated by this dialect for handling identifier conversions.
SQLExceptionConversionDelegate	buildSQLExceptionConversionDelegate()	An instance of SQLExceptionConversionDelegate for interpreting dialect-specific error or SQLState codes.
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.
String	currentTime()	Translation of the HQL/JPQL current_time function, which maps to the Java type Time which is a time with no time zone.
String	currentTimestamp()	Translation of the HQL/JPQL current_timestamp function, which maps to the Java type Timestamp which is a datetime with no time zone.
String	currentTimestampWithTimeZone()	Translation of the HQL offset_datetime function, which maps to the Java type OffsetDateTime which is a datetime with a time zone.
boolean	doesReadCommittedCauseWritersToBlockReaders()	For the underlying database, is READ_COMMITTED isolation implemented by forcing readers to wait for write locks to be released?
boolean	doesRepeatableReadCauseReadersToBlockWriters()	For the underlying database, is REPEATABLE_READ isolation implemented by forcing writers to wait for read 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	getCascadeConstraintsString()	The keyword that specifies that a drop table operation should be cascaded to its constraints, typically " cascade" where the leading space is required, or the empty string if there is no such keyword in this dialect.
String	getCurrentTimestampSelectString()	The command used to retrieve the current timestamp from the database.
int	getDefaultStatementBatchSize()	The default value to use for the configuration property "hibernate.jdbc.batch_size".
DmlTargetColumnQualifierSupport	getDmlTargetColumnQualifierSupport()	Get the minimum DmlTargetColumnQualifierSupport required by this dialect.
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().
FunctionalDependencyAnalysisSupport	getFunctionalDependencyAnalysisSupport()	Get this dialect's level of support for primary key functional dependency analysis within GROUP BY and ORDER BY clauses.
IdentityColumnSupport	getIdentityColumnSupport()	Get the appropriate IdentityColumnSupport for this dialect.
LimitHandler	getLimitHandler()	Obtain a LimitHandler that implements pagination support for Query.setMaxResults(int) and Query.setFirstResult(int).
protected DatabaseVersion	getMinimumSupportedVersion()	Get the version of the SQL dialect that is the minimum supported by this implementation.
NameQualifierSupport	getNameQualifierSupport()	The support for qualified identifiers.
NullOrdering	getNullOrdering()	Returns the default ordering of null.
String	getQuerySequencesString()	Get the select command used retrieve the names of all sequences.
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.
TemporaryTableKind	getSupportedTemporaryTableKind()	The kind of temporary tables that are supported on this database.
AfterUseAction	getTemporaryTableAfterUseAction()	The action to take after finishing use of a temporary table.
BeforeUseAction	getTemporaryTableBeforeUseAction()	The action to take before beginning use of a temporary table.
String	getTemporaryTableCreateCommand()	The command to create a temporary 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.
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?
String	quoteCollation(String collation)	Quote the given collation name if necessary.
protected void	registerDefaultKeywords()	Register the reserved words of ANSI-standard SQL as keywords.
boolean	requiresFloatCastingOfIntegerDivision()	Does this dialect require that integer divisions be wrapped in cast() calls to tell the db parser the expected type.
protected Integer	resolveSqlTypeCode(String typeName, String baseTypeName, TypeConfiguration typeConfiguration)	Resolves the SqlTypes type code for the given column type name as reported by the database and the base type name (i.e.
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	supportsIfExistsAfterTableName()	For dropping a table, can the phrase if exists be applied after the table name?
boolean	supportsIfExistsBeforeTableName()	For dropping a table, can the phrase if exists be applied before the table name?
boolean	supportsLateral()	Does this dialect support the SQL lateral keyword or a proprietary alternative?
boolean	supportsLobValueChangePropagation()	Does the dialect support propagating changes to LOB values back to the database? Talking about mutating the internal value of the locator, as opposed to supplying a new locator instance.
boolean	supportsLockTimeouts()	Does this dialect support specifying timeouts when requesting locks.
boolean	supportsNamedParameters(DatabaseMetaData databaseMetaData)	Override DatabaseMetaData.supportsNamedParameters().
boolean	supportsOffsetInSubquery()	Does this dialect support offset in subqueries?
boolean	supportsRecursiveCTE()	Does this dialect/database support recursive CTEs?
boolean	supportsStandardArrays()	Does this database have native support for ANSI SQL standard arrays which are expressed in terms of the element type name: integer array.
boolean	supportsTupleCounts()	Does this dialect support count(a,b)?
boolean	supportsTupleDistinctCounts()	Does this dialect support count(distinct a,b)?
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.

Methods inherited from class org.hibernate.dialect.Dialect

addSqlHintOrComment, appendArrayLiteral, appendBinaryLiteral, appendDateTimeLiteral, appendDateTimeLiteral, appendDateTimeLiteral, appendIntervalLiteral, appendLiteral, appendLockHint, appendUUIDLiteral, applyLocksToSql, augmentPhysicalTableTypes, augmentRecognizedTableTypes, canBatchTruncate, canCreateCatalog, canCreateSchema, canDisableConstraints, castType, checkVersion, closeQuote, contribute, contributeFunctions, contributeTypes, createOptionalTableUpdateOperation, currentDate, currentLocalTime, currentLocalTimestamp, defaultScrollMode, equivalentTypes, escapeComment, forceLobAsLastValue, generatedAs, getAddColumnString, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAggregateSupport, getAlterColumnTypeString, getAlterTableString, getArrayTypeName, getAuxiliaryDatabaseObjectExporter, getBatchLoadSizingStrategy, getBeforeDropStatement, getCallableStatementSupport, getCaseInsensitiveLike, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getColumnAliasExtractor, getColumnComment, getCreateCatalogCommand, getCreateEnumTypeCommand, getCreateEnumTypeCommand, getCreateIndexString, getCreateIndexTail, getCreateMultisetTableString, getCreateSchemaCommand, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getCreateUserDefinedTypeExtensionsString, getCreateUserDefinedTypeKindString, getCrossReferenceParentTableFilter, getCurrentSchemaCommand, getDefaultDecimalPrecision, getDefaultIntervalSecondScale, getDefaultLobLength, getDefaultNonContextualLobCreation, getDefaultProperties, getDefaultTimestampPrecision, getDefaultUseGetGeneratedKeys, getDisableConstraintsStatement, getDisableConstraintStatement, getDoublePrecision, getDropCatalogCommand, getDropEnumTypeCommand, getDropEnumTypeCommand, getDropForeignKeyString, getDropSchemaCommand, getDropTableString, getDropUniqueKeyString, getEnableConstraintsStatement, getEnableConstraintStatement, getEnumTypeDeclaration, getEnumTypeDeclaration, getFallbackSchemaManagementTool, getFloatPrecision, getForeignKeyExporter, getForUpdateNowaitString, getForUpdateNowaitString, getForUpdateSkipLockedString, getForUpdateSkipLockedString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getFractionalSecondPrecisionInNanos, getGroupBySelectItemReferenceStrategy, getHqlTranslator, getIndexExporter, getInExpressionCountLimit, getKeywords, getLobMergeStrategy, getLockingStrategy, getLockRowIdentifier, getLowercaseFunction, getMaxAliasLength, getMaxIdentifierLength, getMaxNVarcharCapacity, getMaxNVarcharLength, getMaxVarbinaryCapacity, getMaxVarbinaryLength, getMaxVarcharCapacity, getMaxVarcharLength, getMultiKeyLoadSizingStrategy, getNationalizationSupport, getNativeIdentifierGeneratorStrategy, getNativeParameterMarkerStrategy, getNoColumnsInsertString, getNullColumnString, getNullColumnString, getParameterCountLimit, getPreferredSqlTypeCodeForArray, getPreferredSqlTypeCodeForBoolean, getQueryHintString, getQueryHintString, getReadLockString, getReadLockString, getReadRowLockStrategy, getResultSet, getResultSet, getResultSet, getRowIdColumnString, getSchemaNameResolver, getSelectGUIDString, getSequenceExporter, getSizeStrategy, getSqmTranslatorFactory, getTableCleaner, getTableComment, getTableExporter, getTableMigrator, getTableTypeString, getTemporaryTableCreateOptions, getTemporaryTableDdlTransactionHandling, getTemporaryTableDropCommand, getTemporaryTableExporter, getTemporaryTableTruncateCommand, getTimeoutInSeconds, getTimeZoneSupport, getTruncateTableStatement, getTruncateTableStatements, getUniqueKeyExporter, getUserDefinedTypeComment, getUserDefinedTypeExporter, getVersion, getWriteLockString, getWriteLockString, getWriteRowLockStrategy, hasAlterTable, hasDataTypeBeforeGeneratedAs, hasSelfReferentialForeignKeyBug, initDefaultProperties, inlineLiteral, isAnsiNullOn, isEmptyStringTreatedAsNull, isJdbcLogWarningsEnabledByDefault, isLob, isLockTimeoutParameterized, openQuote, ordinal, prependComment, qualifyIndexName, quote, registerColumnTypes, registerKeyword, registerKeywords, registerResultSetOutParameter, registerResultSetOutParameter, requiresCastForConcatenatingNonStrings, requiresParensForTupleCounts, requiresParensForTupleDistinctCounts, resolveSqlTypeCode, resolveSqlTypeDescriptor, resolveSqlTypeLength, rowId, rowIdSqlType, supportsAlterColumnType, supportsBatchUpdates, supportsBindAsCallableArgument, supportsBitType, supportsCascadeDelete, supportsCaseInsensitiveLike, supportsCircularCascadeDeleteConstraints, supportsColumnCheck, supportsConflictClauseForInsertCTE, supportsExistsInSelect, supportsExpectedLobUsagePattern, supportsFetchClause, supportsFractionalTimestampArithmetic, supportsFromClauseInUpdate, supportsIfExistsAfterAlterTable, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTypeName, supportsIfExistsBeforeConstraintName, supportsIfExistsBeforeTypeName, supportsInsertReturning, supportsInsertReturningGeneratedKeys, supportsInsertReturningRowId, supportsIsTrue, supportsJdbcConnectionLobCreation, supportsMaterializedLobAccess, supportsNationalizedMethods, supportsNoColumnsInsert, supportsNonQueryWithCTE, supportsNoWait, supportsNullPrecedence, supportsOrderByInSubquery, supportsOrdinalSelectItemReference, supportsOuterJoinForUpdate, supportsParametersInInsertSelect, supportsPartitionBy, supportsPredicateAsExpression, supportsRefCursors, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsSkipLocked, supportsStandardCurrentTimestampFunction, supportsSubqueryInSelect, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTemporalLiteralOffset, supportsTemporaryTablePrimaryKey, supportsTemporaryTables, supportsTruncateWithCast, supportsUnboundedLobLocatorMaterialization, supportsUnionAll, supportsUnionInSubquery, supportsUpdateReturning, supportsValuesList, supportsValuesListForInsert, supportsWait, supportsWindowFunctions, toBooleanValueString, toQuotedIdentifier, toString, transformSelectString, translateDurationField, trimPattern, trimPattern, unquoteGetGeneratedKeys, useArrayForMultiValuedParameters, useConnectionToCreateLob, useCrossReferenceForeignKeys, useFollowOnLocking, useInputStreamToInsertBlob, useMaterializedLobWhenCapacityExceeded

Methods inherited from class java.lang.Object

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

Constructor Details

HSQLDialect

public HSQLDialect(DialectResolutionInfo info)

HSQLDialect

public HSQLDialect()

HSQLDialect

public HSQLDialect(DatabaseVersion version)

Method Details

getMinimumSupportedVersion

protected DatabaseVersion getMinimumSupportedVersion()

Description copied from class: Dialect

Get the version of the SQL dialect that is the minimum supported by this implementation.

Overrides:

getMinimumSupportedVersion in class Dialect

registerDefaultKeywords

protected void registerDefaultKeywords()

Description copied from class: Dialect

Register the reserved words of ANSI-standard SQL as keywords.

Overrides:

registerDefaultKeywords in class Dialect

See Also:

• AnsiSqlKeywords

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

resolveSqlTypeCode

protected Integer resolveSqlTypeCode(String typeName,
 String baseTypeName,
 TypeConfiguration typeConfiguration)

Description copied from class: Dialect

Resolves the SqlTypes type code for the given column type name as reported by the database and the base type name (i.e. without precision, length and scale), or null if it can't be resolved.

Overrides:

resolveSqlTypeCode 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

initializeFunctionRegistry

public void initializeFunctionRegistry(FunctionContributions functionContributions)

Description copied from class: Dialect

Initialize the given registry with any dialect-specific functions.

Support for certain SQL functions is required, and if the database does not support a required function, then the dialect must define a way to emulate it.

These required functions include the functions defined by the JPA query language specification:

• avg(arg) - aggregate function
• count([distinct ]arg) - aggregate function
• max(arg) - aggregate function
• min(arg) - aggregate function
• sum(arg) - aggregate function

• coalesce(arg0, arg1, ...)
• nullif(arg0, arg1)

• lower(arg)
• upper(arg)
• length(arg)
• concat(arg0, arg1, ...)
• locate(pattern, string[, start])
• substring(string, start[, length])
• trim([[spec ][character ]from] string)

• abs(arg)
• mod(arg0, arg1)
• sqrt(arg)

• current date
• current time
• current timestamp

Along with an additional set of functions defined by ANSI SQL:

• any(arg) - aggregate function
• every(arg) - aggregate function

• var_samp(arg) - aggregate function
• var_pop(arg) - aggregate function
• stddev_samp(arg) - aggregate function
• stddev_pop(arg) - aggregate function

• cast(arg as Type)
• extract(field from arg)

• ln(arg)
• exp(arg)
• power(arg0, arg1)
• floor(arg)
• ceiling(arg)

• position(pattern in string)
• substring(string from start[ for length])
• overlay(string placing replacement from start[ for length])

And the following functions for working with java.time types:

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

And a number of additional "standard" functions:

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

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

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

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

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

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

Overrides:

initializeFunctionRegistry in class Dialect

currentTime

public String currentTime()

Description copied from class: Dialect

Translation of the HQL/JPQL current_time function, which maps to the Java type Time which is a time with no time zone. This contradicts ANSI SQL where current_time has the type TIME WITH TIME ZONE.

It is recommended to override this in dialects for databases which support localtime or time at local.

Overrides:

currentTime in class Dialect

currentTimestamp

public String currentTimestamp()

Description copied from class: Dialect

Translation of the HQL/JPQL current_timestamp function, which maps to the Java type Timestamp which is a datetime with no time zone. This contradicts ANSI SQL where current_timestamp has the type TIMESTAMP WITH TIME ZONE.

It is recommended to override this in dialects for databases which support localtimestamp or timestamp at local.

Overrides:

currentTimestamp in class Dialect

currentTimestampWithTimeZone

public String currentTimestampWithTimeZone()

Description copied from class: Dialect

Translation of the HQL offset_datetime function, which maps to the Java type OffsetDateTime which is a datetime with a time zone. This in principle correctly maps to the ANSI SQL current_timestamp which has the type TIMESTAMP WITH TIME ZONE.

Overrides:

currentTimestampWithTimeZone 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()

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

timestampaddPattern

public String timestampaddPattern(TemporalUnit unit,
 TemporalType temporalType,
 IntervalType intervalType)

Description copied from class: Dialect

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

Overrides:

timestampaddPattern in class Dialect

Parameters:

unit - The unit to add to the temporal

temporalType - The type of the temporal

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

timestampdiffPattern

public String timestampdiffPattern(TemporalUnit unit,
 TemporalType fromTemporalType,
 TemporalType toTemporalType)

Description copied from class: Dialect

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

Overrides:

timestampdiffPattern in class Dialect

Parameters:

unit - the first argument

fromTemporalType - true if the first argument is a timestamp, false if a date

toTemporalType - true if the second argument is

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

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

supportsLockTimeouts

public boolean supportsLockTimeouts()

Description copied from class: Dialect

Does this dialect support specifying timeouts when requesting locks.

Overrides:

supportsLockTimeouts in class Dialect

Returns:

True is this dialect supports specifying lock timeouts.

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

supportsIfExistsAfterTableName

public boolean supportsIfExistsAfterTableName()

Description copied from class: Dialect

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

Overrides:

supportsIfExistsAfterTableName in class Dialect

Returns:

true if if exists can be applied after the table name

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

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

supportsStandardArrays

public boolean supportsStandardArrays()

Description copied from class: Dialect

Does this database have native support for ANSI SQL standard arrays which are expressed in terms of the element type name: integer array.

Overrides:

supportsStandardArrays in class Dialect

Returns:

boolean

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

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.

getNullOrdering

public NullOrdering getNullOrdering()

Description copied from class: Dialect

Returns the default ordering of null.

Overrides:

getNullOrdering in class Dialect

getFallbackSqmMutationStrategy

public SqmMultiTableMutationStrategy getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor,
 RuntimeModelCreationContext runtimeModelCreationContext)

Description copied from class: Dialect

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

Overrides:

getFallbackSqmMutationStrategy in class Dialect

See Also:

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

getSupportedTemporaryTableKind

public TemporaryTableKind getSupportedTemporaryTableKind()

Description copied from class: Dialect

The kind of temporary tables that are supported on this database.

Overrides:

getSupportedTemporaryTableKind in class Dialect

getTemporaryTableCreateCommand

public String getTemporaryTableCreateCommand()

Description copied from class: Dialect

The command to create a temporary table.

Overrides:

getTemporaryTableCreateCommand in class Dialect

getTemporaryTableAfterUseAction

public AfterUseAction getTemporaryTableAfterUseAction()

Description copied from class: Dialect

The action to take after finishing use of a temporary table.

Overrides:

getTemporaryTableAfterUseAction in class Dialect

getTemporaryTableBeforeUseAction

public BeforeUseAction getTemporaryTableBeforeUseAction()

Description copied from class: Dialect

The action to take before beginning use of a temporary table.

Overrides:

getTemporaryTableBeforeUseAction in class Dialect

supportsCurrentTimestampSelection

public boolean supportsCurrentTimestampSelection()

Description copied from class: Dialect

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

Overrides:

supportsCurrentTimestampSelection in class Dialect

Returns:

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

isCurrentTimestampSelectStringCallable

public boolean isCurrentTimestampSelectStringCallable()

Description copied from class: Dialect

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

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

Overrides:

isCurrentTimestampSelectStringCallable in class Dialect

Returns:

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

getCurrentTimestampSelectString

public String getCurrentTimestampSelectString()

Description copied from class: Dialect

The command used to retrieve the current timestamp from the database.

Overrides:

getCurrentTimestampSelectString in class Dialect

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

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

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.

doesRepeatableReadCauseReadersToBlockWriters

public boolean doesRepeatableReadCauseReadersToBlockWriters()

Description copied from class: Dialect

For the underlying database, is REPEATABLE_READ isolation implemented by forcing writers to wait for read locks to be released?

Overrides:

doesRepeatableReadCauseReadersToBlockWriters in class Dialect

Returns:

True if readers block writers to achieve REPEATABLE_READ; 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.

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

supportsTupleCounts

public boolean supportsTupleCounts()

Description copied from class: Dialect

Does this dialect support count(a,b)?

Overrides:

supportsTupleCounts in class Dialect

Returns:

True if the database supports counting tuples; 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.

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

supportsLateral

public boolean supportsLateral()

Description copied from class: Dialect

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

Overrides:

supportsLateral in class Dialect

Returns:

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

supportsRecursiveCTE

public boolean supportsRecursiveCTE()

Description copied from class: Dialect

Does this dialect/database support recursive CTEs?

Overrides:

supportsRecursiveCTE in class Dialect

Returns:

true if recursive CTEs are supported

requiresFloatCastingOfIntegerDivision

public boolean requiresFloatCastingOfIntegerDivision()

Description copied from class: Dialect

Does this dialect require that integer divisions be wrapped in cast() calls to tell the db parser the expected type.

Overrides:

requiresFloatCastingOfIntegerDivision in class Dialect

Returns:

True if integer divisions must be cast()ed to float

getIdentityColumnSupport

public IdentityColumnSupport getIdentityColumnSupport()

Description copied from class: Dialect

Get the appropriate IdentityColumnSupport for this dialect.

Overrides:

getIdentityColumnSupport in class Dialect

Returns:

the IdentityColumnSupport

getNameQualifierSupport

public NameQualifierSupport getNameQualifierSupport()

Description copied from class: Dialect

The support for qualified identifiers.

By default, decide based on DatabaseMetaData.

Overrides:

getNameQualifierSupport in class Dialect

Returns:

The NameQualifierSupport, or null to use DatabaseMetaData.

supportsNamedParameters

public boolean supportsNamedParameters(DatabaseMetaData databaseMetaData)

Description copied from class: Dialect

Override DatabaseMetaData.supportsNamedParameters().

Overrides:

supportsNamedParameters in class Dialect

getFunctionalDependencyAnalysisSupport

public FunctionalDependencyAnalysisSupport getFunctionalDependencyAnalysisSupport()

Description copied from class: Dialect

Get this dialect's level of support for primary key functional dependency analysis within GROUP BY and ORDER BY clauses.

Overrides:

getFunctionalDependencyAnalysisSupport in class Dialect

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.

getCascadeConstraintsString

public String getCascadeConstraintsString()

Description copied from class: Dialect

The keyword that specifies that a drop table operation should be cascaded to its constraints, typically " cascade" where the leading space is required, or the empty string if there is no such keyword in this dialect.

Overrides:

getCascadeConstraintsString in class Dialect

Returns:

The cascade drop keyword, if any, with a leading space

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

buildIdentifierHelper

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

Description copied from class: Dialect

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

The incoming builder will have the following set:

• 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 {#link #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.

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

Returns:

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

Throws:

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

See Also:

• Dialect.getNameQualifierSupport()

getUniqueDelegate

public UniqueDelegate getUniqueDelegate()

Description copied from class: Dialect

Get the UniqueDelegate supported by this dialect

Overrides:

getUniqueDelegate in class Dialect

Returns:

The UniqueDelegate

quoteCollation

public String quoteCollation(String collation)

Description copied from class: Dialect

Quote the given collation name if necessary.

Overrides:

quoteCollation in class Dialect

getDmlTargetColumnQualifierSupport

public DmlTargetColumnQualifierSupport getDmlTargetColumnQualifierSupport()

Description copied from class: Dialect

Get the minimum DmlTargetColumnQualifierSupport required by this dialect.

Overrides:

getDmlTargetColumnQualifierSupport in class Dialect

Returns:

the column qualifier support required by this dialect