Package org.hibernate.dialect

Class DerbyDialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.DerbyDialect

All Implemented Interfaces:

FunctionContributor, TypeContributor, ConversionContext

public class DerbyDialect
extends Dialect

A SQL dialect for Apache Derby 10.15.2 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
DerbyDialect()
DerbyDialect(DatabaseVersion version)
DerbyDialect(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)	Derby does have a real Types.BOOLEAN type, but it doesn't know how to cast to it.
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.
boolean	doesReadCommittedCauseWritersToBlockReaders()	For the underlying database, is READ_COMMITTED isolation implemented by forcing readers to wait for write locks to be released?
String	extractPattern(TemporalUnit unit)	Derby doesn't have an extract() function, and has no functions at all for calendaring, but we can emulate the most basic functionality of extract() using the functions it does have.
String	getCurrentTimestampSelectString()	The command used to retrieve the current timestamp from the database.
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".
int	getDefaultTimestampPrecision()	This is the default precision for a generated column of type TIMESTAMP mapped to a Timestamp or LocalDateTime.
DmlTargetColumnQualifierSupport	getDmlTargetColumnQualifierSupport()	Get the minimum DmlTargetColumnQualifierSupport required by this dialect.
int	getDoublePrecision()	This is the default precision for a generated column mapped to a Java Double or double.
String[]	getDropSchemaCommand(String schemaName)	Get the SQL command used to drop the named schema.
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().
int	getFloatPrecision()	This is the default precision for a generated column mapped to a Java Float or float.
String	getForUpdateString()	Get the string to append to SELECT statements to acquire pessimistic UPGRADE locks for this dialect.
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).
int	getMaxVarcharCapacity()	The longest possible length of a Types.VARCHAR-like column.
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.
NationalizationSupport	getNationalizationSupport()	Determines whether this database requires the use of explicitly nationalized character (Unicode) data 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.
RowLockStrategy	getReadRowLockStrategy()	The row lock strategy to use for read locks.
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.
BeforeUseAction	getTemporaryTableBeforeUseAction()	The action to take before beginning use of a temporary table.
String	getTemporaryTableCreateCommand()	The command to create a temporary table.
String	getTemporaryTableCreateOptions()	An arbitrary SQL fragment appended to the end of the statement to create a temporary table, specifying dialect-specific options, or null if there are no options to specify.
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.
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().
protected void	registerDefaultKeywords()	Register the reserved words of ANSI-standard SQL as keywords.
boolean	requiresCastForConcatenatingNonStrings()	Does this dialect/database require casting of non-string arguments in the concat() function?
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	supportsExistsInSelect()	Does the dialect support an exists statement in the select clause?
boolean	supportsLobValueChangePropagation()	Does the dialect support propagating changes to LOB values back to the database? Talking about mutating the internal value of the locator, as opposed to supplying a new locator instance.
boolean	supportsLockTimeouts()	Does this dialect support specifying timeouts when requesting locks.
boolean	supportsOrderByInSubquery()	Does this dialect support the order by clause in subqueries?
boolean	supportsOuterJoinForUpdate()	Does this dialect support FOR UPDATE in conjunction with outer-joined rows?
boolean	supportsPartitionBy()	Does is dialect support partition by?
boolean	supportsResultSetPositionQueryMethodsOnForwardOnlyCursor()	Does this dialect support asking the result set its positioning information on forward-only cursors?
boolean	supportsTemporaryTablePrimaryKey()	Does this database support primary keys for temporary tables?
boolean	supportsTupleDistinctCounts()	Does this dialect support count(distinct a,b)?
boolean	supportsUnboundedLobLocatorMaterialization()	Is it supported to materialize a LOB locator outside the transaction in which it was created?
boolean	supportsWindowFunctions()	Does this dialect support window functions like row_number() over (..)?
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, createOptionalTableUpdateOperation, currentDate, currentLocalTime, currentLocalTimestamp, currentTime, currentTimestamp, currentTimestampWithTimeZone, defaultScrollMode, doesRepeatableReadCauseReadersToBlockWriters, doesRoundTemporalOnOverflow, dropConstraints, equivalentTypes, escapeComment, forceLobAsLastValue, generatedAs, getAddColumnString, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAggregateSupport, getAlterColumnTypeString, getAlterTableString, getArrayTypeName, getAuxiliaryDatabaseObjectExporter, getBatchLoadSizingStrategy, getBeforeDropStatement, getCallableStatementSupport, getCascadeConstraintsString, getCaseInsensitiveLike, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getColumnAliasExtractor, getColumnComment, getCreateCatalogCommand, getCreateEnumTypeCommand, getCreateEnumTypeCommand, getCreateIndexString, getCreateIndexTail, getCreateMultisetTableString, getCreateSchemaCommand, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getCreateUserDefinedTypeExtensionsString, getCreateUserDefinedTypeKindString, getCrossReferenceParentTableFilter, getCurrentSchemaCommand, getDefaultIntervalSecondScale, getDefaultLobLength, getDefaultNonContextualLobCreation, getDefaultProperties, getDefaultUseGetGeneratedKeys, getDisableConstraintsStatement, getDisableConstraintStatement, getDropCatalogCommand, getDropEnumTypeCommand, getDropEnumTypeCommand, getDropForeignKeyString, getDropTableString, getDropUniqueKeyString, getEnableConstraintsStatement, getEnableConstraintStatement, getEnumTypeDeclaration, getEnumTypeDeclaration, getFallbackSchemaManagementTool, getForeignKeyExporter, getForUpdateNowaitString, getForUpdateNowaitString, getForUpdateSkipLockedString, getForUpdateSkipLockedString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getFractionalSecondPrecisionInNanos, getFunctionalDependencyAnalysisSupport, getGroupBySelectItemReferenceStrategy, getHqlTranslator, getIndexExporter, getKeywords, getLobMergeStrategy, getLockingStrategy, getLockRowIdentifier, getLowercaseFunction, getMaxAliasLength, getMaxIdentifierLength, getMaxNVarcharCapacity, getMaxNVarcharLength, getMaxVarbinaryCapacity, getMaxVarbinaryLength, getMultiKeyLoadSizingStrategy, getNameQualifierSupport, getNativeIdentifierGeneratorStrategy, getNativeParameterMarkerStrategy, getNoColumnsInsertString, getNullColumnString, getNullColumnString, getNullOrdering, getParameterCountLimit, getPreferredSqlTypeCodeForArray, getPreferredSqlTypeCodeForBoolean, getQueryHintString, getQueryHintString, getReadLockString, getResultSet, getResultSet, getResultSet, getRowIdColumnString, getSchemaNameResolver, getSelectGUIDString, getSequenceExporter, getSizeStrategy, getSqmTranslatorFactory, getTableCleaner, getTableComment, getTableExporter, getTableMigrator, getTableTypeString, getTemporaryTableAfterUseAction, getTemporaryTableDdlTransactionHandling, getTemporaryTableDropCommand, getTemporaryTableExporter, getTemporaryTableTruncateCommand, getTimeoutInSeconds, getTimeZoneSupport, getTruncateTableStatement, getTruncateTableStatements, getUniqueKeyExporter, getUserDefinedTypeComment, getUserDefinedTypeExporter, getVersion, getWriteLockString, getWriteRowLockStrategy, hasAlterTable, hasDataTypeBeforeGeneratedAs, hasSelfReferentialForeignKeyBug, initDefaultProperties, inlineLiteral, isAnsiNullOn, isEmptyStringTreatedAsNull, isJdbcLogWarningsEnabledByDefault, isLob, isLockTimeoutParameterized, openQuote, ordinal, prependComment, qualifyIndexName, quote, quoteCollation, registerKeyword, registerKeywords, registerResultSetOutParameter, registerResultSetOutParameter, requiresFloatCastingOfIntegerDivision, requiresParensForTupleCounts, requiresParensForTupleDistinctCounts, resolveSqlTypeCode, resolveSqlTypeCode, resolveSqlTypeDescriptor, resolveSqlTypeLength, rowId, rowIdSqlType, supportsAlterColumnType, supportsBatchUpdates, supportsBindAsCallableArgument, supportsBitType, supportsCascadeDelete, supportsCaseInsensitiveLike, supportsCircularCascadeDeleteConstraints, supportsColumnCheck, supportsConflictClauseForInsertCTE, supportsDistinctFromPredicate, supportsExpectedLobUsagePattern, supportsFetchClause, supportsFractionalTimestampArithmetic, supportsFromClauseInUpdate, supportsIfExistsAfterAlterTable, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsAfterTypeName, supportsIfExistsBeforeConstraintName, supportsIfExistsBeforeTableName, supportsIfExistsBeforeTypeName, supportsInsertReturning, supportsInsertReturningGeneratedKeys, supportsInsertReturningRowId, supportsIsTrue, supportsJdbcConnectionLobCreation, supportsLateral, supportsMaterializedLobAccess, supportsNamedParameters, supportsNationalizedMethods, supportsNoColumnsInsert, supportsNonQueryWithCTE, supportsNoWait, supportsNullPrecedence, supportsOffsetInSubquery, supportsOrdinalSelectItemReference, supportsParametersInInsertSelect, supportsPredicateAsExpression, supportsRecursiveCTE, supportsRefCursors, supportsSkipLocked, supportsStandardArrays, supportsStandardCurrentTimestampFunction, supportsSubqueryInSelect, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTemporalLiteralOffset, supportsTemporaryTables, supportsTruncateWithCast, supportsTupleCounts, supportsUnionAll, supportsUnionInSubquery, supportsUpdateReturning, supportsValuesList, supportsValuesListForInsert, supportsWait, 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

DerbyDialect

public DerbyDialect()

DerbyDialect

public DerbyDialect(DatabaseVersion version)

DerbyDialect

public DerbyDialect(DialectResolutionInfo info)

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

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

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

getMaxVarcharCapacity

public int getMaxVarcharCapacity()

Description copied from class: Dialect

The longest possible length of a Types.VARCHAR-like column.

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

Overrides:

getMaxVarcharCapacity 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

getNationalizationSupport

public NationalizationSupport getNationalizationSupport()

Description copied from class: Dialect

Determines whether this database requires the use of explicitly nationalized character (Unicode) data types.

That is, whether the use of Types.NCHAR, Types.NVARCHAR, and Types.NCLOB is required for nationalized character data.

Overrides:

getNationalizationSupport 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

getFloatPrecision

public int getFloatPrecision()

Description copied from class: Dialect

This is the default precision for a generated column mapped to a Java Float or float. That is, a value representing "single precision".

Usually 24 binary digits, at least for databases with a conventional interpretation of the ANSI SQL specification.

Overrides:

getFloatPrecision in class Dialect

Returns:

a value representing "single precision", usually in binary digits, but sometimes in decimal digits

getDoublePrecision

public int getDoublePrecision()

Description copied from class: Dialect

This is the default precision for a generated column mapped to a Java Double or double. That is, a value representing "double precision".

Usually 53 binary digits, at least for databases with a conventional interpretation of the ANSI SQL specification.

Overrides:

getDoublePrecision in class Dialect

Returns:

a value representing "double precision", usually in binary digits, but sometimes in decimal digits

getDefaultTimestampPrecision

public int getDefaultTimestampPrecision()

Description copied from class: Dialect

This is the default precision for a generated column of type TIMESTAMP mapped to a Timestamp or LocalDateTime.

Usually 6 (microseconds) or 3 (milliseconds).

Overrides:

getDefaultTimestampPrecision in class Dialect

Returns:

the default precision, in decimal digits, of the fractional seconds field

See Also:

• JdbcTimestampJavaType
• LocalDateTimeJavaType
• OffsetDateTimeJavaType
• ZonedDateTimeJavaType
• InstantJavaType

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

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

extractPattern

public String extractPattern(TemporalUnit unit)

Derby doesn't have an extract() function, and has no functions at all for calendaring, but we can emulate the most basic functionality of extract() using the functions it does have.

The only supported TemporalUnits are: TemporalUnit.YEAR, TemporalUnit.MONTH TemporalUnit.DAY, TemporalUnit.HOUR, TemporalUnit.MINUTE, TemporalUnit.SECOND (along with TemporalUnit.NANOSECOND, TemporalUnit.DATE, and TemporalUnit.TIME, which are desugared by the parser).

Overrides:

extractPattern in class Dialect

Parameters:

unit - the first argument

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

castPattern

public String castPattern(CastType from,
 CastType to)

Derby does have a real Types.BOOLEAN type, but it doesn't know how to cast to it. Worse, Derby makes us use the double() function to cast things to its floating point types.

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

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

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

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

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.

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

getReadRowLockStrategy

public RowLockStrategy getReadRowLockStrategy()

Description copied from class: Dialect

The row lock strategy to use for read locks.

Overrides:

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

getWriteLockString

public String getWriteLockString(int timeout)

Description copied from class: Dialect

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

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

Overrides:

getWriteLockString in class Dialect

Parameters:

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

Returns:

The appropriate LOCK clause string.

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.

supportsOuterJoinForUpdate

public boolean supportsOuterJoinForUpdate()

Description copied from class: Dialect

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

Overrides:

supportsOuterJoinForUpdate in class Dialect

Returns:

True if outer-joined rows can be locked via FOR UPDATE.

supportsExistsInSelect

public boolean supportsExistsInSelect()

Description copied from class: Dialect

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

Overrides:

supportsExistsInSelect in class Dialect

Returns:

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

supportsLockTimeouts

public boolean supportsLockTimeouts()

Description copied from class: Dialect

Does this dialect support specifying timeouts when requesting locks.

Overrides:

supportsLockTimeouts in class Dialect

Returns:

True is this dialect supports specifying lock timeouts.

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

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.

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

getIdentityColumnSupport

public IdentityColumnSupport getIdentityColumnSupport()

Description copied from class: Dialect

Get the appropriate IdentityColumnSupport for this dialect.

Overrides:

getIdentityColumnSupport in class Dialect

Returns:

the IdentityColumnSupport

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.

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.

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.

supportsOrderByInSubquery

public boolean supportsOrderByInSubquery()

Description copied from class: Dialect

Does this dialect support the order by clause in subqueries?

For example:

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

Overrides:

supportsOrderByInSubquery in class Dialect

Returns:

true if it does

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

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

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.

supportsUnboundedLobLocatorMaterialization

public boolean supportsUnboundedLobLocatorMaterialization()

Description copied from class: Dialect

Is it supported to materialize a LOB locator outside the transaction in which it was created?

Overrides:

supportsUnboundedLobLocatorMaterialization in class Dialect

Returns:

True if unbounded materialization is supported; false otherwise.

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.

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

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

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

getFallbackSqmMutationStrategy

public SqmMultiTableMutationStrategy getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor,
 RuntimeModelCreationContext runtimeModelCreationContext)

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

From Derby docs:

     The DECLARE GLOBAL TEMPORARY TABLE statement defines a temporary table for the current connection.
 

DB2Dialect returns a GlobalTemporaryTableMutationStrategy that will make temporary tables created at startup and hence unavailable for subsequent connections.
see HHH-10238.

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

getTemporaryTableCreateOptions

public String getTemporaryTableCreateOptions()

Description copied from class: Dialect

An arbitrary SQL fragment appended to the end of the statement to create a temporary table, specifying dialect-specific options, or null if there are no options to specify.

Overrides:

getTemporaryTableCreateOptions in class Dialect

supportsTemporaryTablePrimaryKey

public boolean supportsTemporaryTablePrimaryKey()

Description copied from class: Dialect

Does this database support primary keys for temporary tables?

Overrides:

supportsTemporaryTablePrimaryKey in class Dialect

Returns:

true by default, since most do

getTemporaryTableCreateCommand

public String getTemporaryTableCreateCommand()

Description copied from class: Dialect

The command to create a temporary table.

Overrides:

getTemporaryTableCreateCommand 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

supportsPartitionBy

public boolean supportsPartitionBy()

Description copied from class: Dialect

Does is dialect support partition by?

Overrides:

supportsPartitionBy in class Dialect

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.

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

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