org.hibernate.dialect

Class OracleDialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.OracleDialect

All Implemented Interfaces:

ConversionContext

Direct Known Subclasses:

Oracle10gDialect, Oracle12cDialect, Oracle8iDialect, Oracle9iDialect

public class OracleDialect
extends Dialect

A dialect for Oracle 8i and above.

Nested Class Summary

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

Dialect.SizeStrategy, Dialect.SizeStrategyImpl

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFER_LONG_RAW

Fields inherited from class org.hibernate.dialect.Dialect

CLOSED_QUOTE, DEFAULT_BATCH_SIZE, LEGACY_LOB_MERGE_STRATEGY, NEW_LOCATOR_LOB_MERGE_STRATEGY, NO_BATCH, QUOTE, STANDARD_DEFAULT_BATCH_LOAD_SIZING_STRATEGY, STREAM_XFER_LOB_MERGE_STRATEGY, TWO_SINGLE_QUOTES_REPLACEMENT

Constructor Summary

Constructors

Constructor and Description
OracleDialect()
OracleDialect(DialectResolutionInfo info)
OracleDialect(int version)

Method Summary

Modifier and Type	Method and Description
SQLExceptionConversionDelegate	buildSQLExceptionConversionDelegate() Build an instance of a SQLExceptionConversionDelegate for interpreting dialect-specific error or SQLState codes.
boolean	canCreateSchema() Does this dialect support schema creation?
String	castPattern(CastType from, CastType to) Oracle doesn't have any sort of Types.BOOLEAN type or Types.TIME type, and its default behavior for casting dates and timestamps to and from strings is just awful.
void	contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry) Allows the Dialect to contribute additional types
CaseFragment	createCaseFragment() Map case support to the Oracle DECODE function.
JoinFragment	createOuterJoinFragment() Create a JoinFragment strategy responsible for handling this dialect's variations in how joins are handled.
String	currentDate() Translation of the HQL/JPQL current_date function, which maps to the Java type java.sql.Date, and of the HQL local_date function which maps to the Java type java.sql.LocalDate.
String	currentLocalTime() Translation of the HQL local_time function, which maps to the Java type java.time.LocalTime which is a time with no time zone.
String	currentLocalTimestamp() Translation of the HQL local_datetime function, which maps to the Java type java.time.LocalDateTime which is a datetime with no time zone.
String	currentTime() Translation of the HQL/JPQL current_time function, which maps to the Java type java.sql.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 java.sql.Timestamp which is a datetime with no time zone.
String	currentTimestampWithTimeZone() Translation of the HQL offset_datetime function, which maps to the Java type java.time.OffsetDateTime which is a datetime with a time zone.
static Replacer	datetimeFormat(String format, boolean useFm, boolean resetFm)
boolean	dropConstraints() Do we need to drop constraints before dropping tables in this dialect?
String	extractPattern(TemporalUnit unit) Oracle supports a limited list of temporal fields in the extract() function, but we can emulate some of them by using to_char() with a format string instead of extract().
boolean	forceLobAsLastValue() HHH-4635 Oracle expects all Lob values to be last in inserts and updates.
String	formatBinaryLiteral(byte[] bytes)
boolean	forUpdateOfColumns() Does the FOR UPDATE OF clause accept a list of columns instead of a list of table aliases?
String	getAddColumnString() The syntax used to add a column to a table (optional).
CallableStatementSupport	getCallableStatementSupport()
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	getCrossJoinSeparator() The separator to use for declaring cross joins in a SQL query, typically either " cross join " or a comma ", ", where the spaces are required.
String	getCurrentSchemaCommand() Get the SQL command used to retrieve the current schema name.
String	getCurrentTimestampSelectString() Retrieve the command used to retrieve the current timestamp from the database.
String	getCurrentTimestampSQLFunctionName() The name of the database-specific SQL function for retrieving the current timestamp.
SqmMultiTableMutationStrategy	getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)
String	getForUpdateNowaitString() Retrieves the FOR UPDATE NOWAIT syntax specific to this dialect.
String	getForUpdateNowaitString(String aliases) Get the FOR UPDATE OF column_list NOWAIT fragment appropriate for this dialect given the aliases of the columns to be write locked.
String	getForUpdateSkipLockedString() Retrieves the FOR UPDATE SKIP LOCKED syntax specific to this dialect.
String	getForUpdateSkipLockedString(String aliases) Get the FOR UPDATE OF column_list SKIP LOCKED fragment appropriate for this dialect given the aliases of the columns to be write locked.
String	getForUpdateString(String aliases) Get the FOR UPDATE OF column_list fragment appropriate for this dialect given the aliases of the columns to be write locked.
long	getFractionalSecondPrecisionInNanos() We minimize multiplicative factors by using seconds (with fractional part) as the "native" precision for duration arithmetic.
String	getFromDual() Some databases require a bit of syntactic noise when there are no tables in the from clause.
GroupByConstantRenderingStrategy	getGroupByConstantRenderingStrategy() The strategy to use for rendering constants in the GROUP BY clause.
GroupBySummarizationRenderingStrategy	getGroupBySummarizationRenderingStrategy() The strategy to use for rendering summarizations in the GROUP BY clause.
IdentityColumnSupport	getIdentityColumnSupport() Get the appropriate IdentityColumnSupport
int	getInExpressionCountLimit() Return the limit that the underlying database places on the number of elements in an IN predicate.
LimitHandler	getLimitHandler() Returns a LimitHandler that implements support for Query.setMaxResults(int) and Query.setFirstResult(int) for this dialect.
int	getMaxAliasLength() What is the maximum length Hibernate can use for generated aliases? The maximum here should account for the fact that Hibernate often needs to append "uniqueing" information to the end of generated aliases.
String	getNativeIdentifierGeneratorStrategy() Resolves the native generation strategy associated to this dialect.
String	getNotExpression(String expression) Negate an expression
int	getPreferredSqlTypeCodeForBoolean() The JDBC type code to use for mapping properties of Java type boolean.
String	getQueryHintString(String sql, String hints) Apply a hint to the query.
String	getQuerySequencesString() Get the select command used retrieve the names of all sequences.
String	getReadLockString(int timeout) Get the string to append to SELECT statements to acquire READ locks for this dialect.
String	getReadLockString(String aliases, int timeout) Get the string to append to SELECT statements to acquire READ locks for this dialect given the aliases of the columns to be read locked.
ResultSet	getResultSet(CallableStatement ps) Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet from the OUT parameter.
ResultSet	getResultSet(CallableStatement statement, int position) Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet.
ResultSet	getResultSet(CallableStatement statement, String name) Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet from the OUT parameter.
String	getSelectClauseNullString(int sqlType) Given a Types type code, determine an appropriate null value to use in a select clause.
String	getSelectGUIDString() Get the command used to select a GUID from the underlying database.
SequenceInformationExtractor	getSequenceInformationExtractor() A source of SequenceInformation.
SequenceSupport	getSequenceSupport()
SqlAstTranslatorFactory	getSqlAstTranslatorFactory() Return an SqlAstTranslatorFactory specific for the Dialect.
String	getTableAliasSeparator() The separator to use between a table name and its alias in a SQL query, typically either " as " where the spaces are required, or a space character " ".
int	getVersion()
ViolatedConstraintNameExtractor	getViolatedConstraintNameExtractor()
String	getWriteLockString(int timeout) Get the string to append to SELECT statements to acquire WRITE locks for this dialect.
String	getWriteLockString(String aliases, int timeout) Get the string to append to SELECT statements to acquire WRITE locks for this dialect given the aliases of the columns to be write locked.
RowLockStrategy	getWriteRowLockStrategy() The row lock strategy to use for write locks.
void	initializeFunctionRegistry(QueryEngine queryEngine) Initialize the given registry with any dialect-specific functions.
boolean	isCurrentTimestampSelectStringCallable() Should the value returned by Dialect.getCurrentTimestampSelectString() be treated as callable.
boolean	isEmptyStringTreatedAsNull() Return whether the dialect considers an empty-string value as null.
protected void	registerBinaryTypeMappings()
protected void	registerCharacterTypeMappings()
protected void	registerDateTimeTypeMappings()
protected void	registerDefaultProperties()
protected void	registerNumericTypeMappings()
int	registerResultSetOutParameter(CallableStatement statement, int col) Registers a parameter (either OUT, or the new REF_CURSOR param type available in Java 8) capable of returning ResultSet *by position*.
int	registerResultSetOutParameter(CallableStatement statement, String name) Registers a parameter (either OUT, or the new REF_CURSOR param type available in Java 8) capable of returning ResultSet *by name*.
protected void	registerReverseHibernateTypeMappings()
JdbcTypeDescriptor	resolveSqlTypeDescriptor(int jdbcTypeCode, int precision, int scale, JdbcTypeDescriptorRegistry jdbcTypeDescriptorRegistry)
boolean	supportsBitType() Oracle has neither BIT nor BOOLEAN.
boolean	supportsCommentOn() Does this dialect/database support commenting on tables, columns, etc?
boolean	supportsCurrentTimestampSelection() Does this dialect support a way to retrieve the database's current timestamp value?
boolean	supportsEmptyInList() Does this dialect support empty IN lists? For example, is [where XYZ in ()] a supported construct?
boolean	supportsExistsInSelect() Does the dialect support an exists statement in the select clause?
boolean	supportsFetchClause(FetchClauseType type) Does this dialect support the given fetch clause type.
boolean	supportsNoWait() Does this dialect/database support NO_WAIT timeout.
boolean	supportsOffsetInSubquery() Does this dialect support offset in subqueries? Ex: select * from Table1 where col1 in (select col1 from Table2 order by col2 limit 1 offset 1)
boolean	supportsPartitionBy() Does the underlying database support partition by
boolean	supportsRowValueConstructorSyntaxInInList() HHH-4907, I don't know if oracle 8 supports this syntax, so I'd think it is better add this method here.
boolean	supportsRowValueConstructorSyntaxInInSubquery()
boolean	supportsSelectQueryWithoutFromClause()
boolean	supportsSkipLocked() Does this dialect/database support SKIP_LOCKED timeout.
boolean	supportsTimezoneTypes() Whether the Dialect supports timezone types like Types.TIMESTAMP_WITH_TIMEZONE.
boolean	supportsTupleDistinctCounts() Does this dialect support `count(distinct a,b)`?
boolean	supportsWindowFunctions() Does this dialect support window functions like `row_number() over (..)`
String	timestampaddPattern(TemporalUnit unit, TemporalType temporalType) Obtain a pattern for the SQL equivalent to a timestampadd() function call.
String	timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalType, TemporalType toTemporalType) Obtain a pattern for the SQL equivalent to a timestampdiff() function call.
String	translateDatetimeFormat(String format) Translate the given datetime format string from the pattern language defined by Java's DateTimeFormatter to whatever pattern language is understood by the native datetime formatting function for this database (often the to_char() function).
boolean	useFollowOnLocking(String sql, QueryOptions queryOptions) For Oracle, the FOR UPDATE clause cannot be applied when using ORDER BY, DISTINCT or views.

Methods inherited from class org.hibernate.dialect.Dialect

addSqlHintOrComment, appendLockHint, appendLockHint, applyLocksToSql, areStringComparisonsCaseInsensitive, augmentRecognizedTableTypes, binaryToDecimalPrecision, bindLimitParametersFirst, bindLimitParametersInReverseOrder, buildIdentifierHelper, buildSQLExceptionConverter, canCreateCatalog, closeQuote, convertToFirstRowValue, defaultScrollMode, doesReadCommittedCauseWritersToBlockReaders, doesRepeatableReadCauseReadersToBlockWriters, equivalentTypes, escapeComment, escapeLiteral, forceLimitUsage, formatAsTimestamp, formatAsTimestamp, formatAsTimestamp, formatDateTimeLiteral, formatDateTimeLiteral, formatDateTimeLiteral, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAddUniqueConstraintString, getAlterTableString, getAuxiliaryDatabaseObjectExporter, getBooleanCheckCondition, getCaseInsensitiveLike, getCastTypeName, getColumnAliasExtractor, getColumnComment, getCreateCatalogCommand, getCreateMultisetTableString, getCreateSchemaCommand, getCreateSequenceString, getCreateSequenceString, getCreateSequenceStrings, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getDefaultBatchLoadSizingStrategy, getDefaultDecimalPrecision, getDefaultLobLength, getDefaultProperties, getDefaultTimestampPrecision, getDialect, getDialect, getDoublePrecision, getDropCatalogCommand, getDropForeignKeyString, getDropSchemaCommand, getDropSequenceString, getDropSequenceStrings, getDropTableString, getEnumCheckCondition, getFloatPrecision, getForeignKeyExporter, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getHibernateTypeName, getHibernateTypeName, getHqlTranslator, getIndexExporter, getKeywords, getLimitString, getLimitString, getLobMergeStrategy, getLockingStrategy, getLockRowIdentifier, getLowercaseFunction, getNameQualifierSupport, getNationalizationSupport, getNativeIdentifierGeneratorClass, getNoColumnsInsertString, getNullColumnString, getNullColumnString, getNullOrdering, getQueryHintString, getRawTypeName, getRawTypeName, getReadRowLockStrategy, getSchemaNameResolver, getSelectSequenceNextValString, getSequenceExporter, getSequenceNextValString, getSequenceNextValString, getSizeStrategy, getSqlTypeDescriptorOverride, getSqmTranslatorFactory, getTableComment, getTableExporter, getTableTypeString, getTypeName, getTypeName, getTypeName, getTypeName, getUniqueDelegate, getUniqueKeyExporter, hasAlterTable, hasSelfReferentialForeignKeyBug, inlineLiteral, isJdbcLogWarningsEnabledByDefault, isLockTimeoutParameterized, isTypeNameRegistered, openQuote, prependComment, qualifyIndexName, quote, registerColumnType, registerColumnType, registerHibernateType, registerHibernateType, registerKeyword, remapSqlTypeDescriptor, renderOrderByElement, replaceResultVariableInOrderByClauseWithPosition, requiresCastingOfParametersInSelectClause, requiresFloatCastingOfIntegerDivision, requiresParensForTupleDistinctCounts, supportsBindAsCallableArgument, supportsCascadeDelete, supportsCaseInsensitiveLike, supportsCircularCascadeDeleteConstraints, supportsColumnCheck, supportsExpectedLobUsagePattern, supportsFractionalTimestampArithmetic, supportsIfExistsAfterAlterTable, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsBeforeConstraintName, supportsIfExistsBeforeTableName, supportsJdbcConnectionLobCreation, supportsLimit, supportsLimitOffset, supportsLobValueChangePropagation, supportsLockTimeouts, supportsNamedParameters, supportsNationalizedTypes, supportsNoColumnsInsert, supportsNonQueryWithCTE, supportsNotNullUnique, supportsNullPrecedence, supportsOrderByInSubquery, supportsOrdinalSelectItemReference, supportsOuterJoinForUpdate, supportsParametersInInsertSelect, supportsPooledSequences, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsRowValueConstructorSyntax, supportsRowValueConstructorSyntaxInQuantifiedPredicates, supportsRowValueConstructorSyntaxInSet, supportsSelectAliasInGroupByClause, supportsSequences, supportsSubqueryInSelect, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTemporalLiteralOffset, supportsTemporaryTables, supportsTruncateWithCast, supportsTupleCounts, supportsTuplesInSubqueries, supportsUnboundedLobLocatorMaterialization, supportsUnionAll, supportsUnionInSubquery, supportsUnique, supportsUniqueConstraintInCreateAlterTable, supportsValuesList, supportsValuesListForInsert, supportsVariableLimit, supportsWait, toBooleanValueString, toString, transformSelectString, translateDurationField, translateExtractField, trimPattern, useInputStreamToInsertBlob, useMaxForLimit, wrapDateLiteral, wrapTimeLiteral, wrapTimestampLiteral

Methods inherited from class java.lang.Object

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

Field Detail

PREFER_LONG_RAW

public static final String PREFER_LONG_RAW

See Also:

Constant Field Values

Constructor Detail

OracleDialect

public OracleDialect(DialectResolutionInfo info)

OracleDialect

public OracleDialect()

OracleDialect

public OracleDialect(int version)

Method Detail

getVersion

public int getVersion()

Specified by:

getVersion in class Dialect

getPreferredSqlTypeCodeForBoolean

public int getPreferredSqlTypeCodeForBoolean()

Description copied from class: Dialect

The JDBC type code to use for mapping properties of Java type boolean.

Usually Types.BOOLEAN or Types.BIT.

Overrides:

getPreferredSqlTypeCodeForBoolean in class Dialect

Returns:

one of the type codes defined by Types.

initializeFunctionRegistry

public void initializeFunctionRegistry(QueryEngine queryEngine)

Description copied from class: Dialect

Initialize the given registry with any dialect-specific functions. Support for certain SQL functions is required, and if the database does not support a required function, then the dialect must define a way to emulate it. These required functions include the functions defined by the JPA query language specification:

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

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

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

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

• current date
• current time
• current timestamp

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

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

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

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

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

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

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

And a number of additional "standard" functions:

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

• sign(arg)
• sin(arg)
• cos(arg)
• tan(arg)
• asin(arg)
• acos(arg)
• atan(arg)
• atan2(arg0, arg1)
• round(arg0, arg1)
• least(arg0, arg1, ...)
• greatest(arg0, arg1, ...)

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

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

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

Overrides:

initializeFunctionRegistry in class Dialect

getSqlAstTranslatorFactory

public SqlAstTranslatorFactory getSqlAstTranslatorFactory()

Description copied from class: Dialect

Return an SqlAstTranslatorFactory specific for the Dialect. Return null to use Hibernate's standard translator.

Overrides:

getSqlAstTranslatorFactory in class Dialect

See Also:

StandardSqlAstTranslatorFactory, JdbcEnvironment.getSqlAstTranslatorFactory()

currentDate

public String currentDate()

Description copied from class: Dialect

Translation of the HQL/JPQL current_date function, which maps to the Java type java.sql.Date, and of the HQL local_date function which maps to the Java type java.sql.LocalDate.

Overrides:

currentDate 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 java.sql.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 java.sql.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

currentLocalTime

public String currentLocalTime()

Description copied from class: Dialect

Translation of the HQL local_time function, which maps to the Java type java.time.LocalTime which is a time with no time zone. It should usually be the same SQL function as for Dialect.currentTime().

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

Overrides:

currentLocalTime in class Dialect

currentLocalTimestamp

public String currentLocalTimestamp()

Description copied from class: Dialect

Translation of the HQL local_datetime function, which maps to the Java type java.time.LocalDateTime which is a datetime with no time zone. It should usually be the same SQL function as for Dialect.currentTimestamp().

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

Overrides:

currentLocalTimestamp 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 java.time.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

castPattern

public String castPattern(CastType from,
                          CastType to)

Oracle doesn't have any sort of Types.BOOLEAN type or Types.TIME type, and its default behavior for casting dates and timestamps to and from strings is just awful.

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

getFractionalSecondPrecisionInNanos

public long getFractionalSecondPrecisionInNanos()

We minimize multiplicative factors by using seconds (with fractional part) as the "native" precision for duration arithmetic.

Overrides:

getFractionalSecondPrecisionInNanos in class Dialect

Returns:

the precision, specified as a quantity of nanoseconds

See Also:

TemporalUnit.NATIVE

extractPattern

public String extractPattern(TemporalUnit unit)

Oracle supports a limited list of temporal fields in the extract() function, but we can emulate some of them by using to_char() with a format string instead of extract(). Thus, the additional supported fields are TemporalUnit.DAY_OF_YEAR, TemporalUnit.DAY_OF_MONTH, TemporalUnit.DAY_OF_YEAR, and TemporalUnit.WEEK.

Overrides:

extractPattern in class Dialect

Parameters:

unit - the first argument

timestampaddPattern

public String timestampaddPattern(TemporalUnit unit,
                                  TemporalType temporalType)

Description copied from class: Dialect

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

Overrides:

timestampaddPattern in class Dialect

Parameters:

unit - the first argument

temporalType - true if the third argument is a

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

registerCharacterTypeMappings

protected void registerCharacterTypeMappings()

registerNumericTypeMappings

protected void registerNumericTypeMappings()

registerDateTimeTypeMappings

protected void registerDateTimeTypeMappings()

supportsTimezoneTypes

public boolean supportsTimezoneTypes()

Description copied from class: Dialect

Whether the Dialect supports timezone types like Types.TIMESTAMP_WITH_TIMEZONE.

Overrides:

supportsTimezoneTypes in class Dialect

registerBinaryTypeMappings

protected void registerBinaryTypeMappings()

registerReverseHibernateTypeMappings

protected void registerReverseHibernateTypeMappings()

registerDefaultProperties

protected void registerDefaultProperties()

resolveSqlTypeDescriptor

public JdbcTypeDescriptor resolveSqlTypeDescriptor(int jdbcTypeCode,
                                                   int precision,
                                                   int scale,
                                                   JdbcTypeDescriptorRegistry jdbcTypeDescriptorRegistry)

Overrides:

resolveSqlTypeDescriptor in class Dialect

supportsBitType

public boolean supportsBitType()

Oracle has neither BIT nor BOOLEAN.

Overrides:

supportsBitType in class Dialect

Returns:

false

contributeTypes

public void contributeTypes(TypeContributions typeContributions,
                            ServiceRegistry serviceRegistry)

Description copied from class: Dialect

Allows the Dialect to contribute additional types

Overrides:

contributeTypes in class Dialect

Parameters:

typeContributions - Callback to contribute the types

serviceRegistry - The service registry

getNativeIdentifierGeneratorStrategy

public String getNativeIdentifierGeneratorStrategy()

Description copied from class: Dialect

Resolves the native generation strategy associated to this dialect.

Comes into play whenever the user specifies the native generator.

Overrides:

getNativeIdentifierGeneratorStrategy in class Dialect

Returns:

The native generator strategy.

getTableAliasSeparator

public String getTableAliasSeparator()

Description copied from class: Dialect

The separator to use between a table name and its alias in a SQL query, typically either " as " where the spaces are required, or a space character " ".

Overrides:

getTableAliasSeparator in class Dialect

Returns:

The separator keyword, if any, with spaces

getIdentityColumnSupport

public IdentityColumnSupport getIdentityColumnSupport()

Description copied from class: Dialect

Get the appropriate IdentityColumnSupport

Overrides:

getIdentityColumnSupport in class Dialect

Returns:

the IdentityColumnSupport

createOuterJoinFragment

public JoinFragment createOuterJoinFragment()

Description copied from class: Dialect

Create a JoinFragment strategy responsible for handling this dialect's variations in how joins are handled.

Overrides:

createOuterJoinFragment in class Dialect

Returns:

This dialect's JoinFragment strategy.

getCrossJoinSeparator

public String getCrossJoinSeparator()

Description copied from class: Dialect

The separator to use for declaring cross joins in a SQL query, typically either " cross join " or a comma ", ", where the spaces are required.

Overrides:

getCrossJoinSeparator in class Dialect

Returns:

The cross join separator, with spaces

createCaseFragment

public CaseFragment createCaseFragment()

Map case support to the Oracle DECODE function. Oracle did not add support for CASE until 9i.

Create a CaseFragment strategy responsible for handling this dialect's variations in how CASE statements are handled.

Overrides:

createCaseFragment in class Dialect

Returns:

This dialect's CaseFragment strategy.

getLimitHandler

public LimitHandler getLimitHandler()

Description copied from class: Dialect

Returns a LimitHandler that implements support for Query.setMaxResults(int) and Query.setFirstResult(int) for this dialect.

Overrides:

getLimitHandler in class Dialect

getSelectClauseNullString

public String getSelectClauseNullString(int sqlType)

Description copied from class: Dialect

Given a Types type code, determine an appropriate null value to use in a select clause.

One thing to consider here is that certain databases might require proper casting for the nulls here since the select here will be part of a UNION/UNION ALL.

Overrides:

getSelectClauseNullString in class Dialect

Parameters:

sqlType - The Types type code.

Returns:

The appropriate select clause value fragment.

getCurrentTimestampSelectString

public String getCurrentTimestampSelectString()

Description copied from class: Dialect

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

Overrides:

getCurrentTimestampSelectString in class Dialect

Returns:

The command.

getCurrentTimestampSQLFunctionName

public String getCurrentTimestampSQLFunctionName()

Description copied from class: Dialect

The name of the database-specific SQL function for retrieving the current timestamp.

Overrides:

getCurrentTimestampSQLFunctionName in class Dialect

Returns:

The function name.

getAddColumnString

public String getAddColumnString()

Description copied from class: Dialect

The syntax used to add a column to a table (optional).

Overrides:

getAddColumnString in class Dialect

Returns:

The "add column" fragment.

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

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.

getFromDual

public String getFromDual()

Description copied from class: Dialect

Some databases require a bit of syntactic noise when there are no tables in the from clause.

Overrides:

getFromDual in class Dialect

Returns:

the SQL equivalent to Oracle's from dual.

supportsSelectQueryWithoutFromClause

public boolean supportsSelectQueryWithoutFromClause()

Overrides:

supportsSelectQueryWithoutFromClause in class Dialect

getSequenceSupport

public SequenceSupport getSequenceSupport()

Overrides:

getSequenceSupport in class Dialect

getQuerySequencesString

public String getQuerySequencesString()

Description copied from class: Dialect

Get the select command used retrieve the names of all sequences.

Overrides:

getQuerySequencesString in class Dialect

Returns:

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

See Also:

SchemaUpdate

getSequenceInformationExtractor

public SequenceInformationExtractor getSequenceInformationExtractor()

Description copied from class: Dialect

A source of SequenceInformation.

Overrides:

getSequenceInformationExtractor in class Dialect

getSelectGUIDString

public String getSelectGUIDString()

Description copied from class: Dialect

Get the command used to select a GUID from the underlying database.

Optional operation.

Overrides:

getSelectGUIDString in class Dialect

Returns:

The appropriate command.

getViolatedConstraintNameExtractor

public ViolatedConstraintNameExtractor getViolatedConstraintNameExtractor()

Specified by:

getViolatedConstraintNameExtractor in interface ConversionContext

Overrides:

getViolatedConstraintNameExtractor in class Dialect

buildSQLExceptionConversionDelegate

public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate()

Description copied from class: Dialect

Build an instance of a SQLExceptionConversionDelegate for interpreting dialect-specific error or SQLState codes.

When Dialect.buildSQLExceptionConverter() returns null, the default SQLExceptionConverter is used to interpret SQLState and error codes. If this method is overridden to return a non-null value, the default SQLExceptionConverter will use the returned SQLExceptionConversionDelegate in addition to the following standard delegates:

1. a "static" delegate based on the JDBC 4 defined SQLException hierarchy;
2. a delegate that interprets SQLState codes for either X/Open or SQL-2003 codes, depending on java.sql.DatabaseMetaData#getSQLStateType

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

Specific Dialects may override to return whatever is most appropriate for that vendor.

Overrides:

buildSQLExceptionConversionDelegate in class Dialect

Returns:

The SQLExceptionConversionDelegate for this dialect

registerResultSetOutParameter

public int registerResultSetOutParameter(CallableStatement statement,
                                         int col)
                                  throws SQLException

Description copied from class: Dialect

Registers a parameter (either OUT, or the new REF_CURSOR param type available in Java 8) capable of returning ResultSet *by position*. Pre-Java 8, registering such ResultSet-returning parameters varied greatly across database and drivers; hence its inclusion as part of the Dialect contract.

Overrides:

registerResultSetOutParameter in class Dialect

Parameters:

statement - The callable statement.

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

Returns:

The number of (contiguous) bind positions used.

Throws:

SQLException - Indicates problems registering the param.

getResultSet

public ResultSet getResultSet(CallableStatement ps)
                       throws SQLException

Description copied from class: Dialect

Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet from the OUT parameter.

Overrides:

getResultSet in class Dialect

Parameters:

ps - The callable statement.

Returns:

The extracted result set.

Throws:

SQLException - Indicates problems extracting the result set.

supportsCommentOn

public boolean supportsCommentOn()

Description copied from class: Dialect

Does this dialect/database support commenting on tables, columns, etc?

Overrides:

supportsCommentOn in class Dialect

Returns:

true if commenting is supported

supportsCurrentTimestampSelection

public boolean supportsCurrentTimestampSelection()

Description copied from class: Dialect

Does this dialect support a way to retrieve the database's current timestamp value?

Overrides:

supportsCurrentTimestampSelection in class Dialect

Returns:

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

isCurrentTimestampSelectStringCallable

public boolean isCurrentTimestampSelectStringCallable()

Description copied from class: Dialect

Should the value returned by Dialect.getCurrentTimestampSelectString() be treated as callable. Typically this indicates that JDBC escape syntax is being used...

Overrides:

isCurrentTimestampSelectStringCallable in class Dialect

Returns:

True if the Dialect.getCurrentTimestampSelectString() return is callable; false otherwise.

supportsEmptyInList

public boolean supportsEmptyInList()

Description copied from class: Dialect

Does this dialect support empty IN lists?

For example, is [where XYZ in ()] a supported construct?

Overrides:

supportsEmptyInList in class Dialect

Returns:

True if empty in lists are supported; false otherwise.

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.

getGroupBySummarizationRenderingStrategy

public GroupBySummarizationRenderingStrategy getGroupBySummarizationRenderingStrategy()

Description copied from class: Dialect

The strategy to use for rendering summarizations in the GROUP BY clause.

Overrides:

getGroupBySummarizationRenderingStrategy in class Dialect

getGroupByConstantRenderingStrategy

public GroupByConstantRenderingStrategy getGroupByConstantRenderingStrategy()

Description copied from class: Dialect

The strategy to use for rendering constants in the GROUP BY clause.

Overrides:

getGroupByConstantRenderingStrategy in class Dialect

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 less-than-zero.

Overrides:

getInExpressionCountLimit in class Dialect

Returns:

int The limit, or zero-or-less to indicate no limit.

forceLobAsLastValue

public boolean forceLobAsLastValue()

Description copied from class: Dialect

HHH-4635 Oracle expects all Lob values to be last in inserts and updates.

Overrides:

forceLobAsLastValue in class Dialect

Returns:

boolean True if Lob values should be last, false if it does not matter.

isEmptyStringTreatedAsNull

public boolean isEmptyStringTreatedAsNull()

Description copied from class: Dialect

Return whether the dialect considers an empty-string value as null.

Overrides:

isEmptyStringTreatedAsNull in class Dialect

Returns:

boolean True if an empty string is treated as null, false othrwise.

getFallbackSqmMutationStrategy

public SqmMultiTableMutationStrategy getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor,
                                                                    RuntimeModelCreationContext runtimeModelCreationContext)

Overrides:

getFallbackSqmMutationStrategy in class Dialect

useFollowOnLocking

public boolean useFollowOnLocking(String sql,
                                  QueryOptions queryOptions)

For Oracle, the FOR UPDATE clause cannot be applied when using ORDER BY, DISTINCT or views.

Overrides:

useFollowOnLocking in class Dialect

Returns:

true indicates that the dialect requests that locking be applied by subsequent select; false (the default) indicates that locking should be applied to the main SQL statement..

See Also:

Oracle FOR UPDATE restrictions

getNotExpression

public String getNotExpression(String expression)

Description copied from class: Dialect

Negate an expression

Overrides:

getNotExpression in class Dialect

Parameters:

expression - The expression to negate

Returns:

The negated expression

getQueryHintString

public String getQueryHintString(String sql,
                                 String hints)

Description copied from class: Dialect

Apply a hint to the query. The entire query is provided, allowing the Dialect full control over the placement and syntax of the hint. By default, ignore the hint and simply return the query.

Overrides:

getQueryHintString in class Dialect

Parameters:

sql - The query to which to apply the hint.

hints - The hints to apply

Returns:

The modified SQL

getMaxAliasLength

public int getMaxAliasLength()

Description copied from class: Dialect

What is the maximum length Hibernate can use for generated aliases?

The maximum here should account for the fact that Hibernate often needs to append "uniqueing" information to the end of generated aliases. That "uniqueing" information will be added to the end of a identifier generated to the length specified here; so be sure to leave some room (generally speaking 5 positions will suffice).

Overrides:

getMaxAliasLength in class Dialect

Returns:

The maximum length.

getCallableStatementSupport

public CallableStatementSupport getCallableStatementSupport()

Overrides:

getCallableStatementSupport in class Dialect

canCreateSchema

public boolean canCreateSchema()

Description copied from class: Dialect

Does this dialect support schema creation?

Overrides:

canCreateSchema in class Dialect

Returns:

True if the dialect supports schema creation; false otherwise.

getCurrentSchemaCommand

public String getCurrentSchemaCommand()

Description copied from class: Dialect

Get the SQL command used to retrieve the current schema name. Works in conjunction with Dialect.getSchemaNameResolver(), unless the return from there does not need this information. E.g., a custom impl might make use of the Java 1.7 addition of the Connection.getSchema() method

Overrides:

getCurrentSchemaCommand in class Dialect

Returns:

The current schema retrieval SQL

supportsPartitionBy

public boolean supportsPartitionBy()

Description copied from class: Dialect

Does the underlying database support partition by

Overrides:

supportsPartitionBy in class Dialect

Returns:

boolean

supportsRowValueConstructorSyntaxInInList

public boolean supportsRowValueConstructorSyntaxInInList()

HHH-4907, I don't know if oracle 8 supports this syntax, so I'd think it is better add this method here. Reopen this issue if you found/know 8 supports it.

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

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

Overrides:

supportsRowValueConstructorSyntaxInInList in class Dialect

Returns:

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

supportsRowValueConstructorSyntaxInInSubquery

public boolean supportsRowValueConstructorSyntaxInInSubquery()

Overrides:

supportsRowValueConstructorSyntaxInInSubquery in class Dialect

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? Ex: select * from Table1 where col1 in (select col1 from Table2 order by col2 limit 1 offset 1)

Overrides:

supportsOffsetInSubquery in class Dialect

Returns:

boolean

supportsFetchClause

public boolean supportsFetchClause(FetchClauseType type)

Description copied from class: Dialect

Does this dialect support the given fetch clause type.

Overrides:

supportsFetchClause in class Dialect

Parameters:

type - The fetch clause type

Returns:

true if the underlying database supports the given fetch clause type, false otherwise. The default is false.

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.

supportsNoWait

public boolean supportsNoWait()

Description copied from class: Dialect

Does this dialect/database support NO_WAIT timeout.

Overrides:

supportsNoWait in class Dialect

Returns:

true if NO_WAIT is supported

supportsSkipLocked

public boolean supportsSkipLocked()

Description copied from class: Dialect

Does this dialect/database support SKIP_LOCKED timeout.

Overrides:

supportsSkipLocked in class Dialect

Returns:

true if SKIP_LOCKED is supported

forUpdateOfColumns

public boolean forUpdateOfColumns()

Description copied from class: Dialect

Does the FOR UPDATE OF clause accept a list of columns instead of a list of table aliases?

Overrides:

forUpdateOfColumns in class Dialect

Returns:

True if the database supports FOR UPDATE OF syntax; false otherwise.

getWriteRowLockStrategy

public RowLockStrategy getWriteRowLockStrategy()

Description copied from class: Dialect

The row lock strategy to use for write locks.

Overrides:

getWriteRowLockStrategy in class Dialect

getForUpdateNowaitString

public String getForUpdateNowaitString()

Description copied from class: Dialect

Retrieves the FOR UPDATE NOWAIT syntax specific to this dialect.

Overrides:

getForUpdateNowaitString in class Dialect

Returns:

The appropriate FOR UPDATE NOWAIT clause string.

getForUpdateString

public String getForUpdateString(String aliases)

Description copied from class: Dialect

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

Overrides:

getForUpdateString in class Dialect

Parameters:

aliases - The columns to be write locked.

Returns:

The appropriate FOR UPDATE OF column_list clause string.

getForUpdateNowaitString

public String getForUpdateNowaitString(String aliases)

Description copied from class: Dialect

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

Overrides:

getForUpdateNowaitString in class Dialect

Parameters:

aliases - The columns to be write locked.

Returns:

The appropriate FOR UPDATE OF colunm_list NOWAIT clause string.

getForUpdateSkipLockedString

public String getForUpdateSkipLockedString()

Description copied from class: Dialect

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

Overrides:

getForUpdateSkipLockedString in class Dialect

Returns:

The appropriate FOR UPDATE SKIP LOCKED clause string.

getForUpdateSkipLockedString

public String getForUpdateSkipLockedString(String aliases)

Description copied from class: Dialect

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

Overrides:

getForUpdateSkipLockedString in class Dialect

Parameters:

aliases - The columns to be write locked.

Returns:

The appropriate FOR UPDATE colunm_list SKIP LOCKED clause string.

getWriteLockString

public String getWriteLockString(int timeout)

Description copied from class: Dialect

Get the string to append to SELECT statements to acquire WRITE locks for this dialect. Location of the returned string is treated the same as getForUpdateString.

Overrides:

getWriteLockString in class Dialect

Parameters:

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

Returns:

The appropriate LOCK clause string.

getWriteLockString

public String getWriteLockString(String aliases,
                                 int timeout)

Description copied from class: Dialect

Get the string to append to SELECT statements to acquire WRITE locks for this dialect given the aliases of the columns to be write locked. Location of the of the returned string is treated the same as getForUpdateString.

Overrides:

getWriteLockString in class Dialect

Parameters:

aliases - The columns to be read locked.

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

Returns:

The appropriate LOCK clause string.

getReadLockString

public String getReadLockString(int timeout)

Description copied from class: Dialect

Get the string to append to SELECT statements to acquire READ locks for this dialect. Location of the returned string is treated the same as getForUpdateString.

Overrides:

getReadLockString in class Dialect

Parameters:

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

Returns:

The appropriate LOCK clause string.

getReadLockString

public String getReadLockString(String aliases,
                                int timeout)

Description copied from class: Dialect

Get the string to append to SELECT statements to acquire READ locks for this dialect given the aliases of the columns to be read locked. Location of the returned string is treated the same as getForUpdateString.

Overrides:

getReadLockString in class Dialect

Parameters:

aliases - The columns to be read locked.

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

Returns:

The appropriate LOCK clause string.

translateDatetimeFormat

public String translateDatetimeFormat(String format)

Description copied from class: Dialect

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

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

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

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

Overrides:

translateDatetimeFormat in class Dialect

Returns:

a pattern accepted by the function that formats dates and times in this dialect

datetimeFormat

public static Replacer datetimeFormat(String format,
                                      boolean useFm,
                                      boolean resetFm)

formatBinaryLiteral

public String formatBinaryLiteral(byte[] bytes)

Overrides:

formatBinaryLiteral in class Dialect

getResultSet

public ResultSet getResultSet(CallableStatement statement,
                              int position)
                       throws SQLException

Description copied from class: Dialect

Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet.

Overrides:

getResultSet in class Dialect

Parameters:

statement - The callable statement.

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

Returns:

The extracted result set.

Throws:

SQLException - Indicates problems extracting the result set.

registerResultSetOutParameter

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

Description copied from class: Dialect

Registers a parameter (either OUT, or the new REF_CURSOR param type available in Java 8) capable of returning ResultSet *by name*. Pre-Java 8, registering such ResultSet-returning parameters varied greatly across database and drivers; hence its inclusion as part of the Dialect contract.

Overrides:

registerResultSetOutParameter in class Dialect

Parameters:

statement - The callable statement.

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

Returns:

The number of (contiguous) bind positions used.

Throws:

SQLException - Indicates problems registering the param.

getResultSet

public ResultSet getResultSet(CallableStatement statement,
                              String name)
                       throws SQLException

Description copied from class: Dialect

Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet from the OUT parameter.

Overrides:

getResultSet in class Dialect

Parameters:

statement - The callable statement.

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

Returns:

The extracted result set.

Throws:

SQLException - Indicates problems extracting the result set.