Package org.hibernate.dialect

Class OracleDialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.OracleDialect

All Implemented Interfaces:

FunctionContributor, TypeContributor, ConversionContext

Direct Known Subclasses:

OracleSpatial10gDialect, OracleSpatialSDO10gDialect

public class OracleDialect
extends Dialect

A SQL dialect for Oracle 11g Release 2 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	Description
protected final boolean	applicationContinuity
protected final boolean	autonomous
protected final int	driverMajorVersion
protected final int	driverMinorVersion
protected final boolean	extended
static final String	PREFER_LONG_RAW

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
OracleDialect()
OracleDialect(DatabaseVersion version)
OracleDialect(DialectResolutionInfo info)
OracleDialect(DialectResolutionInfo info, OracleServerConfiguration serverConfiguration)

Method Summary

Modifier and Type	Method	Description
void	appendBinaryLiteral(SqlAppender appender, byte[] bytes)	Append a binary literal to the given SqlAppender.
void	appendDatetimeFormat(SqlAppender appender, String format)	Translate the given datetime format string from the pattern language defined by Java's DateTimeFormatter to whatever pattern language is understood by the native datetime formatting function for this database (often the to_char() function).
void	appendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone)	Append a datetime literal representing the given java.time value to the given SqlAppender.
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.
boolean	canCreateSchema()	Does this dialect support creating and dropping schema?
boolean	canDisableConstraints()	Is there some way to disable foreign key constraint checking while truncating tables? (If there's no way to do it, and if we can't batch truncate, we must drop and recreate the constraints instead.)
String	castPattern(CastType from, CastType to)	type or Types.TIME type, and its default behavior for casting dates and timestamps to and from strings is just awful.
protected String	columnType(int sqlTypeCode)	The database column type name for a given JDBC type code defined in Types or SqlTypes.
void	contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)	A callback which allows the Dialect to contribute types.
MutationOperation	createOptionalTableUpdateOperation(EntityMutationTarget mutationTarget, OptionalTableUpdate optionalTableUpdate, SessionFactoryImplementor factory)	Create a MutationOperation for a updating an optional table
String	currentDate()	Translation of the HQL/JPQL current_date function, which maps to the Java type Date, and of the HQL local_date function which maps to the Java type LocalDate.
String	currentLocalTime()	Translation of the HQL local_time function, which maps to the Java type LocalTime which is a time with no time zone.
String	currentLocalTimestamp()	Translation of the HQL local_datetime function, which maps to the Java type 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 Time which is a time with no time zone.
String	currentTimestamp()	Translation of the HQL/JPQL current_timestamp function, which maps to the Java type Timestamp which is a datetime with no time zone.
String	currentTimestampWithTimeZone()	Translation of the HQL offset_datetime function, which maps to the Java type OffsetDateTime which is a datetime with a time zone.
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()	Must LOB values occur last in inserts and updates?
String	generatedAs(String generatedAs)	The generated as clause, or similar, for generated column declarations in DDL statements.
String	getAddColumnString()	The subcommand of the alter table command used to add a column to a table, usually add column or add.
AggregateSupport	getAggregateSupport()	How does this dialect support aggregate types like SqlTypes.STRUCT.
String	getAlterColumnTypeString(String columnName, String columnType, String columnDefinition)	The fragment of an alter table command which modifies a column type, or null if column types cannot be modified.
String	getArrayTypeName(String javaElementTypeName, String elementTypeName, Integer maxLength)	The SQL type name for the array type with elements of the given type name.
CallableStatementSupport	getCallableStatementSupport()	The CallableStatementSupport for this database.
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[]	getCreateEnumTypeCommand(String name, String[] values)
String	getCreateUserDefinedTypeKindString()	The kind of user-defined type to create, or the empty string if this does not need to be specified.
String	getCurrentSchemaCommand()	Get the SQL command used to retrieve the current schema name.
String	getCurrentTimestampSelectString()	The command used to retrieve the current timestamp from the database.
int	getDefaultStatementBatchSize()	The default value to use for the configuration property "hibernate.jdbc.batch_size".
boolean	getDefaultUseGetGeneratedKeys()	The default value to use for the configuration property "hibernate.jdbc.use_get_generated_keys".
String	getDisableConstraintStatement(String tableName, String name)	A SQL statement that temporarily disables checking of the given foreign key constraint.
DmlTargetColumnQualifierSupport	getDmlTargetColumnQualifierSupport()	Get the minimum DmlTargetColumnQualifierSupport required by this dialect.
int	getDriverMajorVersion()
int	getDriverMinorVersion()
String[]	getDropEnumTypeCommand(String name)
String	getEnableConstraintStatement(String tableName, String name)	A SQL statement that re-enables checking of the given foreign key constraint.
String	getEnumTypeDeclaration(String name, String[] values)	If this database has a special MySQL-style enum column type, return the type declaration for the given enumeration of values.
SqmMultiTableInsertStrategy	getFallbackSqmInsertStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)	The SqmMultiTableInsertStrategy to use when not specified by QueryEngineOptions.getCustomSqmMultiTableInsertStrategy().
SqmMultiTableMutationStrategy	getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)	The SqmMultiTableMutationStrategy to use when not specified by QueryEngineOptions.getCustomSqmMultiTableMutationStrategy().
String	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.
SelectItemReferenceStrategy	getGroupBySelectItemReferenceStrategy()	Determine how selected items are referenced in the group by clause.
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	getMaxAliasLength()	What is the maximum length Hibernate can use for generated aliases?
int	getMaxIdentifierLength()	What is the maximum identifier length supported by this dialect?
int	getMaxVarbinaryLength()	The biggest size value that can be supplied as argument to a Types.VARBINARY-like type.
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.
String	getNativeIdentifierGeneratorStrategy()	The name identifying the "native" id generation strategy for this dialect.
int	getPreferredSqlTypeCodeForArray()	The JDBC type code to use for mapping properties of basic Java array or Collection types.
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 given SQL 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 from the positional OUT parameter.
ResultSet	getResultSet(CallableStatement statement, String name)	Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet from the named OUT parameter.
String	getSelectGUIDString()	Get the command used to select a GUID from the database.
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.
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.
TimeZoneSupport	getTimeZoneSupport()	How the dialect supports time zone types like Types.TIMESTAMP_WITH_TIMEZONE.
UniqueDelegate	getUniqueDelegate()	Get the UniqueDelegate supported by this dialect
Exporter<UserDefinedType>	getUserDefinedTypeExporter()	Get an Exporter for UserDefinedTypes, usually StandardUserDefinedTypeExporter.
ViolatedConstraintNameExtractor	getViolatedConstraintNameExtractor()	A ViolatedConstraintNameExtractor for extracting the name of a violated constraint from a SQLException.
String	getWriteLockString(int timeout)	Get the string to append to SELECT statements to acquire pessimistic WRITE locks for this dialect.
String	getWriteLockString(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.
protected void	initDefaultProperties()	Set appropriate default values for configuration properties.
void	initializeFunctionRegistry(FunctionContributions functionContributions)	Initialize the given registry with any dialect-specific functions.
boolean	isApplicationContinuity()
boolean	isAutonomous()
protected static boolean	isAutonomous(DialectResolutionInfo info)	Deprecated.
boolean	isCurrentTimestampSelectStringCallable()	Is the command returned by Dialect.getCurrentTimestampSelectString() treated as callable?
boolean	isEmptyStringTreatedAsNull()	Return whether the dialect considers an empty string value to be null.
boolean	isExtended()
protected static boolean	isExtended(DialectResolutionInfo info)	Deprecated.
protected void	registerColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)	Register ANSI-standard column types using the length limits defined by Dialect.getMaxVarcharLength(), Dialect.getMaxNVarcharLength(), and Dialect.getMaxVarbinaryLength().
int	registerResultSetOutParameter(CallableStatement statement, int col)	Registers a parameter capable of returning a ResultSet by position, either an OUT parameter, or a REF_CURSOR parameter as defined in Java 8.
int	registerResultSetOutParameter(CallableStatement statement, String name)	Registers a parameter capable of returning a ResultSet by name, either an OUT parameter, or a REF_CURSOR parameter as defined in Java 8.
JdbcType	resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry)	Assigns an appropriate JdbcType to a column of a JDBC result set based on the column type name, JDBC type code, precision, and scale.
String	rowId(String rowId)	The name of a rowid-like pseudo-column which acts as a high-performance row locator, or null if this dialect has no such pseudo-column.
boolean	supportsAlterColumnType()	Does this dialect support modifying the type of an existing column?
boolean	supportsBitType()	Oracle has neither BIT nor BOOLEAN.
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	supportsFetchClause(FetchClauseType type)	Does this dialect support the given FETCH clause type.
boolean	supportsFromClauseInUpdate()	Does this dialect support the from clause for update statements?
boolean	supportsIfExistsAfterAlterTable()	For an alter table, can the phrase if exists be applied?
boolean	supportsIfExistsBeforeTableName()	For dropping a table, can the phrase if exists be applied before the table name?
boolean	supportsIfExistsBeforeTypeName()	For dropping a type, can the phrase if exists be applied before the type name?
boolean	supportsInsertReturningGeneratedKeys()	Does this dialect fully support returning arbitrary generated column values after execution of an insert statement, using the JDBC method Connection.prepareStatement(String, String[]).
boolean	supportsLateral()	Does this dialect support the SQL lateral keyword or a proprietary alternative?
boolean	supportsNoWait()	Does this dialect support NO_WAIT timeout.
boolean	supportsOffsetInSubquery()	Does this dialect support offset in subqueries?
boolean	supportsPartitionBy()	Does is dialect support partition by?
boolean	supportsRecursiveCTE()	Does this dialect/database support recursive CTEs?
boolean	supportsSkipLocked()	Does this dialect support SKIP_LOCKED timeout.
boolean	supportsTemporalLiteralOffset()	Does this dialect supports timezone offsets in temporal literals.
boolean	supportsTupleDistinctCounts()	Does this dialect support count(distinct a,b)?
boolean	supportsValuesList()	Does this dialect support values lists of form VALUES (1), (2), (3)?
boolean	supportsWindowFunctions()	Does this dialect support window functions like row_number() over (..)?
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.
boolean	useFollowOnLocking(String sql, QueryOptions queryOptions)	The FOR UPDATE clause cannot be applied when using ORDER BY, DISTINCT or views.
boolean	useInputStreamToInsertBlob()	Should LOBs (both BLOB and CLOB) be bound using stream operations, that is, using PreparedStatement.setBinaryStream(int, java.io.InputStream, int)).

Methods inherited from class org.hibernate.dialect.Dialect

addSqlHintOrComment, appendArrayLiteral, appendBooleanValueString, appendDateTimeLiteral, appendDateTimeLiteral, appendIntervalLiteral, appendLiteral, appendLockHint, appendUUIDLiteral, applyLocksToSql, augmentPhysicalTableTypes, augmentRecognizedTableTypes, canBatchTruncate, canCreateCatalog, castType, checkVersion, closeQuote, contribute, contributeFunctions, defaultScrollMode, doesReadCommittedCauseWritersToBlockReaders, doesRepeatableReadCauseReadersToBlockWriters, doesRoundTemporalOnOverflow, equivalentTypes, escapeComment, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAlterTableString, getAuxiliaryDatabaseObjectExporter, getBatchLoadSizingStrategy, getBeforeDropStatement, getCaseInsensitiveLike, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getColumnAliasExtractor, getColumnComment, getCreateCatalogCommand, getCreateEnumTypeCommand, getCreateIndexString, getCreateIndexTail, getCreateMultisetTableString, getCreateSchemaCommand, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getCreateUserDefinedTypeExtensionsString, getCrossReferenceParentTableFilter, getDefaultDecimalPrecision, getDefaultIntervalSecondScale, getDefaultLobLength, getDefaultNonContextualLobCreation, getDefaultProperties, getDefaultTimestampPrecision, getDisableConstraintsStatement, getDoublePrecision, getDropCatalogCommand, getDropEnumTypeCommand, getDropForeignKeyString, getDropSchemaCommand, getDropTableString, getDropUniqueKeyString, getEnableConstraintsStatement, getEnumTypeDeclaration, getFallbackSchemaManagementTool, getFloatPrecision, getForeignKeyExporter, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getFunctionalDependencyAnalysisSupport, getHqlTranslator, getIndexExporter, getKeywords, getLobMergeStrategy, getLockingStrategy, getLockRowIdentifier, getLowercaseFunction, getMaxNVarcharCapacity, getMaxNVarcharLength, getMaxVarbinaryCapacity, getMaxVarcharCapacity, getMultiKeyLoadSizingStrategy, getNameQualifierSupport, getNationalizationSupport, getNativeParameterMarkerStrategy, getNoColumnsInsertString, getNullColumnString, getNullColumnString, getNullOrdering, getParameterCountLimit, getQueryHintString, getReadRowLockStrategy, getRowIdColumnString, getSchemaNameResolver, getSelectClauseNullString, getSequenceExporter, getSizeStrategy, getSqmTranslatorFactory, getTableCleaner, getTableComment, getTableExporter, getTableMigrator, getTableTypeString, getTemporaryTableAfterUseAction, getTemporaryTableBeforeUseAction, getTemporaryTableCreateCommand, getTemporaryTableDdlTransactionHandling, getTemporaryTableDropCommand, getTemporaryTableExporter, getTemporaryTableTruncateCommand, getTimeoutInSeconds, getTruncateTableStatement, getTruncateTableStatements, getUniqueKeyExporter, getUserDefinedTypeComment, getVersion, hasAlterTable, hasDataTypeBeforeGeneratedAs, hasSelfReferentialForeignKeyBug, inlineLiteral, isAnsiNullOn, isJdbcLogWarningsEnabledByDefault, isLob, isLockTimeoutParameterized, openQuote, ordinal, prependComment, qualifyIndexName, quote, quoteCollation, registerDefaultKeywords, registerKeyword, registerKeywords, requiresCastForConcatenatingNonStrings, requiresFloatCastingOfIntegerDivision, requiresParensForTupleCounts, requiresParensForTupleDistinctCounts, resolveSqlTypeCode, resolveSqlTypeCode, resolveSqlTypeLength, rowIdSqlType, supportsBatchUpdates, supportsBindAsCallableArgument, supportsCascadeDelete, supportsCaseInsensitiveLike, supportsCircularCascadeDeleteConstraints, supportsColumnCheck, supportsConflictClauseForInsertCTE, supportsDistinctFromPredicate, supportsExpectedLobUsagePattern, supportsFractionalTimestampArithmetic, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsAfterTypeName, supportsIfExistsBeforeConstraintName, supportsInsertReturning, supportsInsertReturningRowId, supportsIsTrue, supportsJdbcConnectionLobCreation, supportsLobValueChangePropagation, supportsLockTimeouts, supportsMaterializedLobAccess, supportsNamedParameters, supportsNationalizedMethods, supportsNoColumnsInsert, supportsNonQueryWithCTE, supportsNullPrecedence, supportsOrderByInSubquery, supportsOrdinalSelectItemReference, supportsOuterJoinForUpdate, supportsParametersInInsertSelect, supportsPredicateAsExpression, supportsRefCursors, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsStandardArrays, supportsStandardCurrentTimestampFunction, supportsSubqueryInSelect, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTemporaryTablePrimaryKey, supportsTemporaryTables, supportsTruncateWithCast, supportsTupleCounts, supportsUnboundedLobLocatorMaterialization, supportsUnionAll, supportsUnionInSubquery, supportsUpdateReturning, supportsValuesListForInsert, supportsWait, toBooleanValueString, toQuotedIdentifier, toString, transformSelectString, translateDurationField, translateExtractField, trimPattern, trimPattern, unquoteGetGeneratedKeys, useArrayForMultiValuedParameters, useConnectionToCreateLob, useCrossReferenceForeignKeys, useMaterializedLobWhenCapacityExceeded

Methods inherited from class java.lang.Object

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

Field Details

PREFER_LONG_RAW

public static final String PREFER_LONG_RAW

See Also:

• Constant Field Values

autonomous

protected final boolean autonomous

extended

protected final boolean extended

applicationContinuity

protected final boolean applicationContinuity

driverMajorVersion

protected final int driverMajorVersion

driverMinorVersion

protected final int driverMinorVersion

Constructor Details

OracleDialect

public OracleDialect()

OracleDialect

public OracleDialect(DatabaseVersion version)

OracleDialect

public OracleDialect(DialectResolutionInfo info)

OracleDialect

public OracleDialect(DialectResolutionInfo info,
 OracleServerConfiguration serverConfiguration)

Method Details

isExtended

@Deprecated(since="6.4")
protected static boolean isExtended(DialectResolutionInfo info)

Deprecated.

isAutonomous

@Deprecated(since="6.4")
protected static boolean isAutonomous(DialectResolutionInfo info)

Deprecated.

isAutonomous

public boolean isAutonomous()

isExtended

public boolean isExtended()

isApplicationContinuity

public boolean isApplicationContinuity()

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

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

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

getMaxVarbinaryLength

public int getMaxVarbinaryLength()

Description copied from class: Dialect

The biggest size value that can be supplied as argument to a Types.VARBINARY-like type.

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

Overrides:

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

currentDate

public String currentDate()

Description copied from class: Dialect

Translation of the HQL/JPQL current_date function, which maps to the Java type Date, and of the HQL local_date function which maps to the Java type 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 Time which is a time with no time zone. This contradicts ANSI SQL where current_time has the type TIME WITH TIME ZONE.

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

Overrides:

currentTime in class Dialect

currentTimestamp

public String currentTimestamp()

Description copied from class: Dialect

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

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

Overrides:

currentTimestamp in class Dialect

currentLocalTime

public String currentLocalTime()

Description copied from class: Dialect

Translation of the HQL local_time function, which maps to the Java type 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 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 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

supportsInsertReturningGeneratedKeys

public boolean supportsInsertReturningGeneratedKeys()

Description copied from class: Dialect

Does this dialect fully support returning arbitrary generated column values after execution of an insert statement, using the JDBC method Connection.prepareStatement(String, String[]).

Support for returning the generated value of an identity column via the JDBC method Connection.prepareStatement(String, int) is insufficient here.

Overrides:

supportsInsertReturningGeneratedKeys in class Dialect

Returns:

true if GetGeneratedKeysDelegate works for any sort of primary key column (not just identity columns), or false if GetGeneratedKeysDelegate does not work, or only works for specialized identity/"autoincrement" columns

See Also:

• OnExecutionGenerator.getGeneratedIdentifierDelegate(org.hibernate.id.PostInsertIdentityPersister)
• GetGeneratedKeysDelegate

castPattern

public String castPattern(CastType from,
 CastType to)

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

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

getTimeZoneSupport

public TimeZoneSupport getTimeZoneSupport()

Description copied from class: Dialect

How the dialect supports time zone types like Types.TIMESTAMP_WITH_TIMEZONE.

Overrides:

getTimeZoneSupport in class Dialect

initDefaultProperties

protected void initDefaultProperties()

Description copied from class: Dialect

Set appropriate default values for configuration properties.

This default implementation sets "hibernate.jdbc.batch_size", "hibernate.jdbc.lob.non_contextual_creation", and "hibernate.jdbc.use_get_generated_keys" to defaults determined by calling Dialect.getDefaultStatementBatchSize(), Dialect.getDefaultNonContextualLobCreation(), and Dialect.getDefaultUseGetGeneratedKeys().

An implementation may set additional configuration properties, but this is discouraged.

Overrides:

initDefaultProperties 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

getDefaultUseGetGeneratedKeys

public boolean getDefaultUseGetGeneratedKeys()

Description copied from class: Dialect

The default value to use for the configuration property "hibernate.jdbc.use_get_generated_keys".

Overrides:

getDefaultUseGetGeneratedKeys in class Dialect

resolveSqlTypeDescriptor

public JdbcType resolveSqlTypeDescriptor(String columnTypeName,
 int jdbcTypeCode,
 int precision,
 int scale,
 JdbcTypeRegistry jdbcTypeRegistry)

Description copied from class: Dialect

Assigns an appropriate JdbcType to a column of a JDBC result set based on the column type name, JDBC type code, precision, and scale.

Overrides:

resolveSqlTypeDescriptor in class Dialect

Parameters:

columnTypeName - the column type name

jdbcTypeCode - the type code

precision - the precision or 0

scale - the scale or 0

Returns:

an appropriate instance of JdbcType

supportsBitType

public boolean supportsBitType()

Oracle has neither BIT nor BOOLEAN.

Overrides:

supportsBitType in class Dialect

Returns:

false

getArrayTypeName

public String getArrayTypeName(String javaElementTypeName,
 String elementTypeName,
 Integer maxLength)

Description copied from class: Dialect

The SQL type name for the array type with elements of the given type name.

The ANSI-standard syntax is integer array.

Overrides:

getArrayTypeName in class Dialect

getPreferredSqlTypeCodeForArray

public int getPreferredSqlTypeCodeForArray()

Description copied from class: Dialect

The JDBC type code to use for mapping properties of basic Java array or Collection types.

Usually SqlTypes.ARRAY or SqlTypes.VARBINARY.

Overrides:

getPreferredSqlTypeCodeForArray in class Dialect

Returns:

one of the type codes defined by SqlTypes.

getUserDefinedTypeExporter

public Exporter<UserDefinedType> getUserDefinedTypeExporter()

Description copied from class: Dialect

Get an Exporter for UserDefinedTypes, usually StandardUserDefinedTypeExporter.

Overrides:

getUserDefinedTypeExporter in class Dialect

contributeTypes

public void contributeTypes(TypeContributions typeContributions,
 ServiceRegistry serviceRegistry)

Description copied from class: Dialect

A callback which allows the Dialect to contribute types.

Overrides:

contributeTypes in class Dialect

Parameters:

typeContributions - Callback to contribute the types

serviceRegistry - The service registry

getAggregateSupport

public AggregateSupport getAggregateSupport()

Description copied from class: Dialect

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

Overrides:

getAggregateSupport in class Dialect

getNativeIdentifierGeneratorStrategy

public String getNativeIdentifierGeneratorStrategy()

Description copied from class: Dialect

The name identifying the "native" id generation strategy for this dialect.

This is the name of the id generation strategy which should be used when "native" is specified in hbm.xml.

Overrides:

getNativeIdentifierGeneratorStrategy in class Dialect

Returns:

The name identifying the native generator strategy.

getIdentityColumnSupport

public IdentityColumnSupport getIdentityColumnSupport()

Description copied from class: Dialect

Get the appropriate IdentityColumnSupport for this dialect.

Overrides:

getIdentityColumnSupport in class Dialect

Returns:

the IdentityColumnSupport

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

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

getGroupBySelectItemReferenceStrategy

public SelectItemReferenceStrategy getGroupBySelectItemReferenceStrategy()

Description copied from class: Dialect

Determine how selected items are referenced in the group by clause.

Overrides:

getGroupBySelectItemReferenceStrategy in class Dialect

supportsValuesList

public boolean supportsValuesList()

Description copied from class: Dialect

Does this dialect support values lists of form VALUES (1), (2), (3)?

Overrides:

supportsValuesList in class Dialect

Returns:

true if values list are supported

getAddColumnString

public String getAddColumnString()

Description copied from class: Dialect

The subcommand of the alter table command used to add a column to a table, usually add column or add.

Overrides:

getAddColumnString in class Dialect

Returns:

The add column fragment.

supportsIfExistsBeforeTableName

public boolean supportsIfExistsBeforeTableName()

Description copied from class: Dialect

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

Overrides:

supportsIfExistsBeforeTableName in class Dialect

Returns:

true if if exists can be applied before the table name

supportsIfExistsAfterAlterTable

public boolean supportsIfExistsAfterAlterTable()

Description copied from class: Dialect

For an alter table, can the phrase if exists be applied?

Overrides:

supportsIfExistsAfterAlterTable in class Dialect

Returns:

true if if exists can be applied after alter table

supportsIfExistsBeforeTypeName

public boolean supportsIfExistsBeforeTypeName()

Description copied from class: Dialect

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

Overrides:

supportsIfExistsBeforeTypeName in class Dialect

Returns:

true if if exists can be applied before the type name

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.

getAlterColumnTypeString

public String getAlterColumnTypeString(String columnName,
 String columnType,
 String columnDefinition)

Description copied from class: Dialect

The fragment of an alter table command which modifies a column type, or null if column types cannot be modified. Often alter column col_name set data type col_type.

Overrides:

getAlterColumnTypeString in class Dialect

Parameters:

columnName - the name of the column

columnType - the new type of the column

columnDefinition - the full column definition

Returns:

a fragment to be appended to alter table

supportsAlterColumnType

public boolean supportsAlterColumnType()

Description copied from class: Dialect

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

Overrides:

supportsAlterColumnType in class Dialect

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

getSelectGUIDString

public String getSelectGUIDString()

Description copied from class: Dialect

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

Optional operation.

Overrides:

getSelectGUIDString in class Dialect

Returns:

The appropriate command.

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

registerResultSetOutParameter

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

Description copied from class: Dialect

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

Overrides:

registerResultSetOutParameter in class Dialect

Parameters:

statement - The callable statement.

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

Returns:

The number of (contiguous) bind positions used.

Throws:

SQLException - Indicates problems registering the param.

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 support commenting on tables and columns?

Overrides:

supportsCommentOn in class Dialect

Returns:

true if commenting is supported

supportsCurrentTimestampSelection

public boolean supportsCurrentTimestampSelection()

Description copied from class: Dialect

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

Overrides:

supportsCurrentTimestampSelection in class Dialect

Returns:

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

isCurrentTimestampSelectStringCallable

public boolean isCurrentTimestampSelectStringCallable()

Description copied from class: Dialect

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

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

Overrides:

isCurrentTimestampSelectStringCallable in class Dialect

Returns:

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

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.

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.

forceLobAsLastValue

public boolean forceLobAsLastValue()

Description copied from class: Dialect

Must LOB values occur 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 to be null.

Overrides:

isEmptyStringTreatedAsNull in class Dialect

Returns:

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

getFallbackSqmMutationStrategy

public SqmMultiTableMutationStrategy getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor,
 RuntimeModelCreationContext runtimeModelCreationContext)

Description copied from class: Dialect

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

Overrides:

getFallbackSqmMutationStrategy in class Dialect

See Also:

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

getFallbackSqmInsertStrategy

public SqmMultiTableInsertStrategy getFallbackSqmInsertStrategy(EntityMappingType rootEntityDescriptor,
 RuntimeModelCreationContext runtimeModelCreationContext)

Description copied from class: Dialect

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

Overrides:

getFallbackSqmInsertStrategy in class Dialect

See Also:

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

getSupportedTemporaryTableKind

public TemporaryTableKind getSupportedTemporaryTableKind()

Description copied from class: Dialect

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

Overrides:

getSupportedTemporaryTableKind in class Dialect

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

useFollowOnLocking

public boolean useFollowOnLocking(String sql,
 QueryOptions queryOptions)

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

getQueryHintString

public String getQueryHintString(String sql,
 String hints)

Description copied from class: Dialect

Apply a hint to the given SQL query.

The entire query is provided, allowing 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?

Overrides:

getMaxAliasLength in class Dialect

Returns:

The maximum length.

getMaxIdentifierLength

public int getMaxIdentifierLength()

Description copied from class: Dialect

What is the maximum identifier length supported by this dialect?

Overrides:

getMaxIdentifierLength in class Dialect

Returns:

The maximum length.

getCallableStatementSupport

public CallableStatementSupport getCallableStatementSupport()

Description copied from class: Dialect

The CallableStatementSupport for this database. Does this database support returning cursors?

Overrides:

getCallableStatementSupport in class Dialect

canCreateSchema

public boolean canCreateSchema()

Description copied from class: Dialect

Does this dialect support creating and dropping schema?

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 resulting SchemaNameResolver does not need this information. For example, a custom implementation might make use of the Java 1.7 Connection.getSchema() method.

Overrides:

getCurrentSchemaCommand in class Dialect

Returns:

The current schema retrieval SQL

supportsPartitionBy

public boolean supportsPartitionBy()

Description copied from class: Dialect

Does is dialect support partition by?

Overrides:

supportsPartitionBy 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?

For example:

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

Overrides:

supportsOffsetInSubquery in class Dialect

Returns:

true if it does

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.

supportsRecursiveCTE

public boolean supportsRecursiveCTE()

Description copied from class: Dialect

Does this dialect/database support recursive CTEs?

Overrides:

supportsRecursiveCTE in class Dialect

Returns:

true if recursive CTEs are supported

supportsLateral

public boolean supportsLateral()

Description copied from class: Dialect

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

Overrides:

supportsLateral in class Dialect

Returns:

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

supportsNoWait

public boolean supportsNoWait()

Description copied from class: Dialect

Does this dialect 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 support SKIP_LOCKED timeout.

Overrides:

supportsSkipLocked in class Dialect

Returns:

true if SKIP_LOCKED is supported

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

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 returned string is treated the same as Dialect.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 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.

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

supportsTemporalLiteralOffset

public boolean supportsTemporalLiteralOffset()

Description copied from class: Dialect

Does this dialect supports timezone offsets in temporal literals.

Overrides:

supportsTemporalLiteralOffset in class Dialect

appendDateTimeLiteral

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

Description copied from class: Dialect

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

Overrides:

appendDateTimeLiteral in class Dialect

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

datetimeFormat

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

appendBinaryLiteral

public void appendBinaryLiteral(SqlAppender appender,
 byte[] bytes)

Description copied from class: Dialect

Append a binary literal to the given SqlAppender.

Overrides:

appendBinaryLiteral in class Dialect

getResultSet

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

Description copied from class: Dialect

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

Overrides:

getResultSet in class Dialect

Parameters:

statement - The callable statement.

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

Returns:

The extracted result set.

Throws:

SQLException - Indicates problems extracting the result set.

registerResultSetOutParameter

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

Description copied from class: Dialect

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

Overrides:

registerResultSetOutParameter in class Dialect

Parameters:

statement - The callable statement.

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

Returns:

The number of (contiguous) bind positions used.

Throws:

SQLException - Indicates problems registering the param.

getResultSet

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

Description copied from class: Dialect

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

Overrides:

getResultSet in class Dialect

Parameters:

statement - The callable statement.

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

Returns:

The extracted result set.

Throws:

SQLException - Indicates problems extracting the result set.

generatedAs

public String generatedAs(String generatedAs)

Description copied from class: Dialect

The generated as clause, or similar, for generated column declarations in DDL statements.

Overrides:

generatedAs in class Dialect

Parameters:

generatedAs - a SQL expression used to generate the column value

Returns:

The generated as clause containing the given expression

buildIdentifierHelper

public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuilder builder,
 DatabaseMetaData 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()

canDisableConstraints

public boolean canDisableConstraints()

Description copied from class: Dialect

Is there some way to disable foreign key constraint checking while truncating tables? (If there's no way to do it, and if we can't batch truncate, we must drop and recreate the constraints instead.)

Overrides:

canDisableConstraints in class Dialect

Returns:

true if there is some way to do it

See Also:

• Dialect.getDisableConstraintsStatement()
• Dialect.getDisableConstraintStatement(String, String)

getDisableConstraintStatement

public String getDisableConstraintStatement(String tableName,
 String name)

Description copied from class: Dialect

A SQL statement that temporarily disables checking of the given foreign key constraint.

Overrides:

getDisableConstraintStatement in class Dialect

Parameters:

tableName - the name of the table

name - the name of the constraint

getEnableConstraintStatement

public String getEnableConstraintStatement(String tableName,
 String name)

Description copied from class: Dialect

A SQL statement that re-enables checking of the given foreign key constraint.

Overrides:

getEnableConstraintStatement in class Dialect

Parameters:

tableName - the name of the table

name - the name of the constraint

getUniqueDelegate

public UniqueDelegate getUniqueDelegate()

Description copied from class: Dialect

Get the UniqueDelegate supported by this dialect

Overrides:

getUniqueDelegate in class Dialect

Returns:

The UniqueDelegate

getCreateUserDefinedTypeKindString

public String getCreateUserDefinedTypeKindString()

Description copied from class: Dialect

The kind of user-defined type to create, or the empty string if this does not need to be specified. Included after create type type_name as, but before the list of members.

Overrides:

getCreateUserDefinedTypeKindString in class Dialect

rowId

public String rowId(String rowId)

Description copied from class: Dialect

The name of a rowid-like pseudo-column which acts as a high-performance row locator, or null if this dialect has no such pseudo-column.

If the rowid-like value is an explicitly-declared named column instead of an implicit pseudo-column, and if the given name is nonempty, return the given name.

Overrides:

rowId in class Dialect

Parameters:

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

createOptionalTableUpdateOperation

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

Description copied from class: Dialect

Create a MutationOperation for a updating an optional table

Overrides:

createOptionalTableUpdateOperation in class Dialect

getDmlTargetColumnQualifierSupport

public DmlTargetColumnQualifierSupport getDmlTargetColumnQualifierSupport()

Description copied from class: Dialect

Get the minimum DmlTargetColumnQualifierSupport required by this dialect.

Overrides:

getDmlTargetColumnQualifierSupport in class Dialect

Returns:

the column qualifier support required by this dialect

supportsFromClauseInUpdate

public boolean supportsFromClauseInUpdate()

Description copied from class: Dialect

Does this dialect support the from clause for update statements?

Overrides:

supportsFromClauseInUpdate in class Dialect

Returns:

true if from clause is supported

getDriverMajorVersion

public int getDriverMajorVersion()

getDriverMinorVersion

public int getDriverMinorVersion()

getEnumTypeDeclaration

public String getEnumTypeDeclaration(String name,
 String[] values)

Description copied from class: Dialect

If this database has a special MySQL-style enum column type, return the type declaration for the given enumeration of values.

If the database has no such type, return null.

Overrides:

getEnumTypeDeclaration in class Dialect

values - the enumerated values of the type

Returns:

the DDL column type declaration

getCreateEnumTypeCommand

public String[] getCreateEnumTypeCommand(String name,
 String[] values)

Overrides:

getCreateEnumTypeCommand in class Dialect

getDropEnumTypeCommand

public String[] getDropEnumTypeCommand(String name)

Overrides:

getDropEnumTypeCommand in class Dialect

useInputStreamToInsertBlob

public boolean useInputStreamToInsertBlob()

Description copied from class: Dialect

Should LOBs (both BLOB and CLOB) be bound using stream operations, that is, using PreparedStatement.setBinaryStream(int, java.io.InputStream, int)).

Overrides:

useInputStreamToInsertBlob in class Dialect

Returns:

True if BLOBs and CLOBs should be bound using stream operations.