Class PostgreSQLDialect
- java.lang.Object
-
- org.hibernate.dialect.Dialect
-
- org.hibernate.dialect.PostgreSQLDialect
-
- All Implemented Interfaces:
FunctionContributor
,TypeContributor
,ConversionContext
- Direct Known Subclasses:
PostgisPG10Dialect
,PostgisPG93Dialect
,PostgisPG94Dialect
,PostgisPG95Dialect
,PostgresPlusDialect
,PostgreSQL10Dialect
public class PostgreSQLDialect extends Dialect
A SQL dialect for PostgreSQL 10 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 PostgreSQLDriverKind
driverKind
protected static DatabaseVersion
MINIMUM_VERSION
-
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 PostgreSQLDialect()
PostgreSQLDialect(DatabaseVersion version)
PostgreSQLDialect(DatabaseVersion version, PostgreSQLDriverKind driverKind)
PostgreSQLDialect(DialectResolutionInfo info)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
appendBinaryLiteral(SqlAppender appender, byte[] bytes)
Append a binary literal to the givenSqlAppender
.void
appendBooleanValueString(SqlAppender appender, boolean bool)
Append the SQL literal expression representing the given boolean value to the givenSqlAppender
.void
appendDatetimeFormat(SqlAppender appender, String format)
Translate the given datetime format string from the pattern language defined by Java'sDateTimeFormatter
to whatever pattern language is understood by the native datetime formatting function for this database (often theto_char()
function).void
appendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone)
Append a datetime literal representing the givenjava.time
value to the givenSqlAppender
.void
appendDateTimeLiteral(SqlAppender appender, Calendar calendar, TemporalType precision, TimeZone jdbcTimeZone)
Append a datetime literal representing the givenCalendar
value to the givenSqlAppender
.void
appendDateTimeLiteral(SqlAppender appender, Date date, TemporalType precision, TimeZone jdbcTimeZone)
Append a datetime literal representing the givenDate
value to the givenSqlAppender
.void
augmentRecognizedTableTypes(List<String> tableTypesList)
IdentifierHelper
buildIdentifierHelper(IdentifierHelperBuilder builder, DatabaseMetaData dbMetaData)
TheIdentifierHelper
indicated by this dialect for handling identifier conversions.SQLExceptionConversionDelegate
buildSQLExceptionConversionDelegate()
An instance ofSQLExceptionConversionDelegate
for interpreting dialect-specific error or SQLState codes.boolean
canBatchTruncate()
Does thetruncate table
statement accept multiple tables?protected String
castType(int sqlTypeCode)
The SQL type to use incast( ... as ... )
expressions when casting to the target type represented by the given JDBC type code.protected String
columnType(int sqlTypeCode)
protected void
contributePostgreSQLTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
Allow for extension points to override this onlyvoid
contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
A callback which allows theDialect
to contribute types.MutationOperation
createOptionalTableUpdateOperation(EntityMutationTarget mutationTarget, OptionalTableUpdate optionalTableUpdate, SessionFactoryImplementor factory)
Create aMutationOperation
for a updating an optional tableString
currentTime()
Translation of the HQL/JPQLcurrent_time
function, which maps to the Java typeTime
which is a time with no time zone.String
currentTimestamp()
Translation of the HQL/JPQLcurrent_timestamp
function, which maps to the Java typeTimestamp
which is a datetime with no time zone.String
currentTimestampWithTimeZone()
Translation of the HQLoffset_datetime
function, which maps to the Java typeOffsetDateTime
which is a datetime with a time zone.Replacer
datetimeFormat(String format)
protected void
extractField(StringBuilder pattern, TemporalUnit unit, TemporalType fromTimestamp, TemporalType toTimestamp, TemporalUnit toUnit)
Deprecated.String
extractPattern(TemporalUnit unit)
Theextract()
function returnsTemporalUnit.DAY_OF_WEEK
numbered from 0 to 6.AggregateSupport
getAggregateSupport()
How does this dialect support aggregate types likeSqlTypes.STRUCT
.String
getAlterColumnTypeString(String columnName, String columnType, String columnDefinition)
The fragment of analter table
command which modifies a column type, or null if column types cannot be modified.CallableStatementSupport
getCallableStatementSupport()
TheCallableStatementSupport
for this database.String
getCascadeConstraintsString()
The keyword that specifies that adrop 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
getCaseInsensitiveLike()
The name of the SQL operator that performs case-insensitiveLIKE
comparisons.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.boolean
getDefaultNonContextualLobCreation()
The default value to use for the configuration property "hibernate.jdbc.lob.non_contextual_creation".int
getDefaultStatementBatchSize()
The default value to use for the configuration property "hibernate.jdbc.batch_size".SqmMultiTableInsertStrategy
getFallbackSqmInsertStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)
TheSqmMultiTableInsertStrategy
to use when not specified byQueryEngineOptions.getCustomSqmMultiTableInsertStrategy()
.SqmMultiTableMutationStrategy
getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)
TheSqmMultiTableMutationStrategy
to use when not specified byQueryEngineOptions.getCustomSqmMultiTableMutationStrategy()
.String
getForUpdateNowaitString()
Retrieves theFOR UPDATE NOWAIT
syntax specific to this dialect.String
getForUpdateNowaitString(String aliases)
Get theFOR UPDATE OF column_list NOWAIT
fragment appropriate for this dialect, given the aliases of the columns to be write locked.String
getForUpdateSkipLockedString()
Retrieves theFOR UPDATE SKIP LOCKED
syntax specific to this dialect.String
getForUpdateSkipLockedString(String aliases)
Get theFOR 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 theFOR UPDATE OF column_list
fragment appropriate for this dialect, given the aliases of the columns to be write locked.String
getForUpdateString(String aliases, LockOptions lockOptions)
Get theFOR UPDATE OF
orFOR SHARE OF
fragment appropriate for this dialect, given the aliases of the columns to be locked.long
getFractionalSecondPrecisionInNanos()
microsecond
is the smallest unit for aninterval
, and the highest precision for atimestamp
, so we could use it as the "native" precision, but it's more convenient to use whole seconds (with the fractional part), since we want to useextract(epoch from ...)
in our emulation oftimestampdiff()
.SelectItemReferenceStrategy
getGroupBySelectItemReferenceStrategy()
Determine how selected items are referenced in thegroup by
clause.IdentityColumnSupport
getIdentityColumnSupport()
Get the appropriateIdentityColumnSupport
for this dialect.LimitHandler
getLimitHandler()
Obtain aLimitHandler
that implements pagination support forQuery.setMaxResults(int)
andQuery.setFirstResult(int)
.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 aTypes.VARBINARY
-like type.int
getMaxVarcharCapacity()
The longest possible length of aTypes.VARCHAR
-like column.int
getMaxVarcharLength()
The biggest size value that can be supplied as argument to aTypes.VARCHAR
-like type.protected DatabaseVersion
getMinimumSupportedVersion()
Get the version of the SQL dialect that is the minimum supported by this implementation.NameQualifierSupport
getNameQualifierSupport()
NationalizationSupport
getNationalizationSupport()
Determines whether this database requires the use of explicitly nationalized character (Unicode) data types.String
getNativeIdentifierGeneratorStrategy()
The name identifying the "native" id generation strategy for this dialect.ParameterMarkerStrategy
getNativeParameterMarkerStrategy()
Support for native parameter markers.String
getNoColumnsInsertString()
The fragment used to insert a row without specifying any column values, usually just()
, but sometimesdefault values
.String
getQuerySequencesString()
Get theselect
command used retrieve the names of all sequences.String
getReadLockString(int timeout)
Get the string to append toSELECT
statements to acquire READ locks for this dialect.String
getReadLockString(String aliases, int timeout)
Get the string to append toSELECT
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 byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int)
, extract theResultSet
from theOUT
parameter.ResultSet
getResultSet(CallableStatement statement, int position)
Given a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int)
, extract theResultSet
from the positionalOUT
parameter.ResultSet
getResultSet(CallableStatement statement, String name)
Given a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int)
, extract theResultSet
from the namedOUT
parameter.String
getSelectClauseNullString(int sqlType, TypeConfiguration typeConfiguration)
Given a JDBC type code, return the expression for a literal null value of that type, to use in aselect
clause.SequenceSupport
getSequenceSupport()
Get the appropriateSequenceSupport
for this dialect.SqlAstTranslatorFactory
getSqlAstTranslatorFactory()
TimeZoneSupport
getTimeZoneSupport()
How the dialect supports time zone types likeTypes.TIMESTAMP_WITH_TIMEZONE
.UniqueDelegate
getUniqueDelegate()
Get theUniqueDelegate
supported by this dialectViolatedConstraintNameExtractor
getViolatedConstraintNameExtractor()
AViolatedConstraintNameExtractor
for extracting the name of a violated constraint from aSQLException
.String
getWriteLockString(int timeout)
Get the string to append toSELECT
statements to acquire pessimistic WRITE locks for this dialect.String
getWriteLockString(String aliases, int timeout)
Get the string to append toSELECT
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(FunctionContributions functionContributions)
Initialize the given registry with any dialect-specific functions.boolean
isCurrentTimestampSelectStringCallable()
Is the command returned byDialect.getCurrentTimestampSelectString()
treated as callable?boolean
qualifyIndexName()
Do we need to qualify index names with the schema name?protected void
registerColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
Register ANSI-standard column types using the length limits defined byDialect.getMaxVarcharLength()
,Dialect.getMaxNVarcharLength()
, andDialect.getMaxVarbinaryLength()
.int
registerResultSetOutParameter(CallableStatement statement, int col)
Registers a parameter capable of returning aResultSet
by position, either anOUT
parameter, or aREF_CURSOR
parameter as defined in Java 8.boolean
requiresParensForTupleDistinctCounts()
IfDialect.supportsTupleDistinctCounts()
is true, does this dialect require the tuple to be delimited with parentheses?protected Integer
resolveSqlTypeCode(String columnTypeName, TypeConfiguration typeConfiguration)
Resolves theSqlTypes
type code for the given column type name as reported by the database, ornull
if it can't be resolved.JdbcType
resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry)
Assigns an appropriateJdbcType
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 arowid
-like pseudo-column which acts as a high-performance row locator, or null if this dialect has no such pseudo-column.int
rowIdSqlType()
The JDBC type code of therowid
-like pseudo-column which acts as a high-performance row locator.boolean
supportsAlterColumnType()
Does this dialect support modifying the type of an existing column?boolean
supportsCaseInsensitiveLike()
Does this dialect support case-insensitiveLIKE
comparisons?boolean
supportsCommentOn()
Does this dialect support commenting on tables and columns?boolean
supportsCurrentTimestampSelection()
Does this dialect support some way to retrieve the current timestamp value from the database?boolean
supportsDistinctFromPredicate()
Does this dialect support some kind ofdistinct from
predicate?boolean
supportsFetchClause(FetchClauseType type)
Does this dialect support the givenFETCH
clause type.boolean
supportsIfExistsAfterAlterTable()
For analter table
, can the phraseif exists
be applied?boolean
supportsIfExistsBeforeConstraintName()
For dropping a constraint with analter table
statement, can the phraseif exists
be applied before the constraint name?boolean
supportsIfExistsBeforeTableName()
For dropping a table, can the phraseif exists
be applied before the table name?boolean
supportsIfExistsBeforeTypeName()
For dropping a type, can the phraseif exists
be applied before the type name?boolean
supportsInsertReturning()
Does this dialect fully support returning arbitrary generated column values after execution of aninsert
statement, using native SQL syntax?boolean
supportsJdbcConnectionLobCreation(DatabaseMetaData databaseMetaData)
Check whether the JDBCConnection
supports creating LOBs viaConnection.createBlob()
,Connection.createNClob()
, orConnection.createClob()
.boolean
supportsLateral()
Does this dialect support the SQLlateral
keyword or a proprietary alternative?boolean
supportsLobValueChangePropagation()
Does the dialect support propagating changes to LOB values back to the database? Talking about mutating the internal value of the locator, as opposed to supplying a new locator instance.boolean
supportsMaterializedLobAccess()
Check whether the JDBC driver allows setting LOBs viaPreparedStatement.setBytes(int, byte[])
,PreparedStatement.setNString(int, String)
, orPreparedStatement.setString(int, String)
APIs.protected boolean
supportsMinMaxOnUuid()
Whether PostgreSQL supports `min(uuid)`/`max(uuid)` which it doesn't by default.boolean
supportsNonQueryWithCTE()
Does this dialect support insert, update, and delete statements with Common Table Expressions (CTEs)?boolean
supportsNoWait()
Does this dialect supportNO_WAIT
timeout.boolean
supportsOffsetInSubquery()
Does this dialect supportoffset
in subqueries?boolean
supportsOuterJoinForUpdate()
Does this dialect supportFOR UPDATE
in conjunction with outer-joined rows?boolean
supportsPartitionBy()
Does is dialect supportpartition by
?boolean
supportsRecursiveCTE()
Does this dialect/database support recursive CTEs?boolean
supportsSkipLocked()
Does this dialect supportSKIP_LOCKED
timeout.boolean
supportsStandardArrays()
Does this database have native support for ANSI SQL standard arrays which are expressed in terms of the element type name:integer array
.boolean
supportsTemporalLiteralOffset()
Does this dialect supports timezone offsets in temporal literals.boolean
supportsTupleCounts()
Does this dialect supportcount(a,b)
?boolean
supportsUnboundedLobLocatorMaterialization()
Is it supported to materialize a LOB locator outside the transaction in which it was created?boolean
supportsValuesList()
Does this dialect supportvalues
lists of formVALUES (1), (2), (3)
?boolean
supportsWait()
Does this dialect supportWAIT
timeout.boolean
supportsWindowFunctions()
Does this dialect support window functions likerow_number() over (..)
?String
timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType)
Obtain a pattern for the SQL equivalent to atimestampadd()
function call.String
timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalType, TemporalType toTemporalType)
Obtain a pattern for the SQL equivalent to atimestampdiff()
function call.String
translateExtractField(TemporalUnit unit)
Return the name used to identify the given field as an argument to theextract()
function, or of this dialect's equivalent function.boolean
useInputStreamToInsertBlob()
Should LOBs (both BLOB and CLOB) be bound using stream operations, that is, usingPreparedStatement.setBinaryStream(int, java.io.InputStream, int)
).-
Methods inherited from class org.hibernate.dialect.Dialect
addSqlHintOrComment, appendArrayLiteral, appendIntervalLiteral, appendLiteral, appendLockHint, appendUUIDLiteral, applyLocksToSql, augmentPhysicalTableTypes, canCreateCatalog, canCreateSchema, canDisableConstraints, castPattern, checkVersion, closeQuote, contribute, contributeFunctions, currentDate, currentLocalTime, currentLocalTimestamp, defaultScrollMode, doesReadCommittedCauseWritersToBlockReaders, doesRepeatableReadCauseReadersToBlockWriters, dropConstraints, equivalentTypes, escapeComment, forceLobAsLastValue, generatedAs, getAddColumnString, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAlterTableString, getArrayTypeName, getAuxiliaryDatabaseObjectExporter, getBatchLoadSizingStrategy, getCheckCondition, getCheckCondition, getColumnAliasExtractor, getColumnComment, getCreateCatalogCommand, getCreateIndexString, getCreateIndexTail, getCreateMultisetTableString, getCreateSchemaCommand, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getCreateUserDefinedTypeExtensionsString, getCreateUserDefinedTypeKindString, getDefaultDecimalPrecision, getDefaultLobLength, getDefaultProperties, getDefaultTimestampPrecision, getDefaultUseGetGeneratedKeys, getDisableConstraintsStatement, getDisableConstraintStatement, getDmlTargetColumnQualifierSupport, getDoublePrecision, getDropCatalogCommand, getDropForeignKeyString, getDropSchemaCommand, getDropTableString, getDropUniqueKeyString, getEnableConstraintsStatement, getEnableConstraintStatement, getEnumTypeDeclaration, getFallbackSchemaManagementTool, getFloatPrecision, getForeignKeyExporter, getForUpdateString, getForUpdateString, getForUpdateString, getHqlTranslator, getIndexExporter, getInExpressionCountLimit, getKeywords, getLobMergeStrategy, getLockingStrategy, getLockRowIdentifier, getLowercaseFunction, getMaxAliasLength, getMaxNVarcharCapacity, getMaxNVarcharLength, getMaxVarbinaryCapacity, getMultiKeyLoadSizingStrategy, getNativeIdentifierGenerationType, getNullColumnString, getNullColumnString, getNullOrdering, getParameterCountLimit, getPreferredSqlTypeCodeForArray, getPreferredSqlTypeCodeForBoolean, getQueryHintString, getQueryHintString, getReadRowLockStrategy, getRowIdColumnString, getSchemaNameResolver, getSelectGUIDString, getSequenceExporter, getSequenceInformationExtractor, getSizeStrategy, getSqmTranslatorFactory, getSupportedTemporaryTableKind, getTableCleaner, getTableComment, getTableExporter, getTableMigrator, getTableTypeString, getTemporaryTableAfterUseAction, getTemporaryTableBeforeUseAction, getTemporaryTableCreateCommand, getTemporaryTableCreateOptions, getTemporaryTableDdlTransactionHandling, getTemporaryTableDropCommand, getTemporaryTableExporter, getTemporaryTableTruncateCommand, getTimeoutInSeconds, getTruncateTableStatement, getTruncateTableStatements, getUniqueKeyExporter, getUserDefinedTypeComment, getUserDefinedTypeExporter, getVersion, hasAlterTable, hasDataTypeBeforeGeneratedAs, hasSelfReferentialForeignKeyBug, initDefaultProperties, inlineLiteral, isAnsiNullOn, isEmptyStringTreatedAsNull, isJdbcLogWarningsEnabledByDefault, isLob, isLockTimeoutParameterized, openQuote, ordinal, prependComment, quote, registerDefaultKeywords, registerKeyword, registerKeywords, registerResultSetOutParameter, requiresCastForConcatenatingNonStrings, requiresFloatCastingOfIntegerDivision, requiresParensForTupleCounts, resolveSqlTypeCode, resolveSqlTypeLength, supportsBindAsCallableArgument, supportsBitType, supportsCascadeDelete, supportsCircularCascadeDeleteConstraints, supportsColumnCheck, supportsExistsInSelect, supportsExpectedLobUsagePattern, supportsFractionalTimestampArithmetic, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsAfterTypeName, supportsInsertReturningGeneratedKeys, supportsLockTimeouts, supportsNamedParameters, supportsNoColumnsInsert, supportsNullPrecedence, supportsOrderByInSubquery, supportsOrdinalSelectItemReference, supportsParametersInInsertSelect, supportsPredicateAsExpression, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsStandardCurrentTimestampFunction, supportsSubqueryInSelect, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTemporaryTablePrimaryKey, supportsTemporaryTables, supportsTruncateWithCast, supportsTupleDistinctCounts, supportsUnionAll, supportsUnionInSubquery, supportsValuesListForInsert, toBooleanValueString, toQuotedIdentifier, toString, transformSelectString, translateDurationField, trimPattern, useArrayForMultiValuedParameters, useFollowOnLocking, useMaterializedLobWhenCapacityExceeded
-
-
-
-
Field Detail
-
MINIMUM_VERSION
protected static final DatabaseVersion MINIMUM_VERSION
-
driverKind
protected final PostgreSQLDriverKind driverKind
-
-
Constructor Detail
-
PostgreSQLDialect
public PostgreSQLDialect()
-
PostgreSQLDialect
public PostgreSQLDialect(DialectResolutionInfo info)
-
PostgreSQLDialect
public PostgreSQLDialect(DatabaseVersion version)
-
PostgreSQLDialect
public PostgreSQLDialect(DatabaseVersion version, PostgreSQLDriverKind driverKind)
-
-
Method Detail
-
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 classDialect
-
getDefaultNonContextualLobCreation
public boolean getDefaultNonContextualLobCreation()
Description copied from class:Dialect
The default value to use for the configuration property "hibernate.jdbc.lob.non_contextual_creation".- Overrides:
getDefaultNonContextualLobCreation
in classDialect
-
columnType
protected String columnType(int sqlTypeCode)
Description copied from class:Dialect
The database column type name for a given JDBC type code defined inTypes
orSqlTypes
. This default implementation returns the ANSI-standard type name.This method may be overridden by concrete
Dialect
s as an alternative toDialect.registerColumnTypes(TypeContributions, ServiceRegistry)
for simple registrations.Note that:
- Implementations of this method are expected to define a
sensible mapping for
Types.NCLOB
Types.NCHAR
, andTypes.NVARCHAR
. On some database, these types are simply remapped toCLOB
,CHAR
, andVARCHAR
. - Mappings for
Types.TIMESTAMP
andTypes.TIMESTAMP_WITH_TIMEZONE
should support explicit specification of precision if possible. - As specified by
DdlTypeRegistry.getDescriptor(int)
, this method never receivesTypes.LONGVARCHAR
,Types.LONGNVARCHAR
, norTypes.LONGVARBINARY
, which are considered synonyms for their non-LONG
counterparts. - On the other hand, the types
SqlTypes.LONG32VARCHAR
,SqlTypes.LONG32NVARCHAR
, andSqlTypes.LONG32VARBINARY
are not synonyms, and implementations of this method must define sensible mappings, for example to database-nativeTEXT
orCLOB
types.
- Overrides:
columnType
in classDialect
- Parameters:
sqlTypeCode
- a SQLtype code
- Returns:
- a column type name, with
$l
,$p
,$s
placeholders for length, precision, scale - See Also:
SqlTypes
- Implementations of this method are expected to define a
sensible mapping for
-
castType
protected String castType(int sqlTypeCode)
Description copied from class:Dialect
The SQL type to use incast( ... as ... )
expressions when casting to the target type represented by the given JDBC type code.
-
registerColumnTypes
protected void registerColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
Description copied from class:Dialect
Register ANSI-standard column types using the length limits defined byDialect.getMaxVarcharLength()
,Dialect.getMaxNVarcharLength()
, andDialect.getMaxVarbinaryLength()
.This method is always called when a
Dialect
is instantiated.- Overrides:
registerColumnTypes
in classDialect
-
getMaxVarcharLength
public int getMaxVarcharLength()
Description copied from class:Dialect
The biggest size value that can be supplied as argument to aTypes.VARCHAR
-like type.For longer column lengths, use some sort of
text
-like type for the column.- Overrides:
getMaxVarcharLength
in classDialect
-
getMaxVarcharCapacity
public int getMaxVarcharCapacity()
Description copied from class:Dialect
The longest possible length of aTypes.VARCHAR
-like column.For longer column lengths, use some sort of
clob
-like type for the column.- Overrides:
getMaxVarcharCapacity
in classDialect
-
getMaxVarbinaryLength
public int getMaxVarbinaryLength()
Description copied from class:Dialect
The biggest size value that can be supplied as argument to aTypes.VARBINARY
-like type.For longer column lengths, use some sort of
image
-like type for the column.- Overrides:
getMaxVarbinaryLength
in classDialect
-
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 classDialect
-
resolveSqlTypeDescriptor
public JdbcType resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry)
Description copied from class:Dialect
Assigns an appropriateJdbcType
to a column of a JDBC result set based on the column type name, JDBC type code, precision, and scale.- Overrides:
resolveSqlTypeDescriptor
in classDialect
- Parameters:
columnTypeName
- the column type namejdbcTypeCode
- thetype code
precision
- the precision or 0scale
- the scale or 0- Returns:
- an appropriate instance of
JdbcType
-
resolveSqlTypeCode
protected Integer resolveSqlTypeCode(String columnTypeName, TypeConfiguration typeConfiguration)
Description copied from class:Dialect
Resolves theSqlTypes
type code for the given column type name as reported by the database, ornull
if it can't be resolved.- Overrides:
resolveSqlTypeCode
in classDialect
-
currentTime
public String currentTime()
Description copied from class:Dialect
Translation of the HQL/JPQLcurrent_time
function, which maps to the Java typeTime
which is a time with no time zone. This contradicts ANSI SQL wherecurrent_time
has the typeTIME WITH TIME ZONE
.It is recommended to override this in dialects for databases which support
localtime
ortime at local
.- Overrides:
currentTime
in classDialect
-
currentTimestamp
public String currentTimestamp()
Description copied from class:Dialect
Translation of the HQL/JPQLcurrent_timestamp
function, which maps to the Java typeTimestamp
which is a datetime with no time zone. This contradicts ANSI SQL wherecurrent_timestamp
has the typeTIMESTAMP WITH TIME ZONE
.It is recommended to override this in dialects for databases which support
localtimestamp
ortimestamp at local
.- Overrides:
currentTimestamp
in classDialect
-
currentTimestampWithTimeZone
public String currentTimestampWithTimeZone()
Description copied from class:Dialect
Translation of the HQLoffset_datetime
function, which maps to the Java typeOffsetDateTime
which is a datetime with a time zone. This in principle correctly maps to the ANSI SQLcurrent_timestamp
which has the typeTIMESTAMP WITH TIME ZONE
.- Overrides:
currentTimestampWithTimeZone
in classDialect
-
extractPattern
public String extractPattern(TemporalUnit unit)
Theextract()
function returnsTemporalUnit.DAY_OF_WEEK
numbered from 0 to 6. This isn't consistent with what most other databases do, so here we adjust the result by generating(extract(dow,arg)+1))
.- Overrides:
extractPattern
in classDialect
- Parameters:
unit
- the first argument
-
getFractionalSecondPrecisionInNanos
public long getFractionalSecondPrecisionInNanos()
microsecond
is the smallest unit for aninterval
, and the highest precision for atimestamp
, so we could use it as the "native" precision, but it's more convenient to use whole seconds (with the fractional part), since we want to useextract(epoch from ...)
in our emulation oftimestampdiff()
.- Overrides:
getFractionalSecondPrecisionInNanos
in classDialect
- Returns:
- the precision, specified as a quantity of nanoseconds
- See Also:
TemporalUnit.NATIVE
-
timestampaddPattern
public String timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType)
Description copied from class:Dialect
Obtain a pattern for the SQL equivalent to atimestampadd()
function call. The resulting pattern must contain ?1, ?2, and ?3 placeholders for the arguments.- Overrides:
timestampaddPattern
in classDialect
- Parameters:
unit
- The unit to add to the temporaltemporalType
- The type of the temporalintervalType
- 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 atimestampdiff()
function call. The resulting pattern must contain ?1, ?2, and ?3 placeholders for the arguments.- Overrides:
timestampdiffPattern
in classDialect
- Parameters:
unit
- the first argumentfromTemporalType
- true if the first argument is a timestamp, false if a datetoTemporalType
- true if the second argument is
-
extractField
@Deprecated protected void extractField(StringBuilder pattern, TemporalUnit unit, TemporalType fromTimestamp, TemporalType toTimestamp, TemporalUnit toUnit)
Deprecated.
-
getTimeZoneSupport
public TimeZoneSupport getTimeZoneSupport()
Description copied from class:Dialect
How the dialect supports time zone types likeTypes.TIMESTAMP_WITH_TIMEZONE
.- Overrides:
getTimeZoneSupport
in classDialect
-
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
-
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])
java.time
types:-
local date
-
local time
-
local datetime
-
offset datetime
-
instant
-
left(string, length)
-
right(string, length)
-
replace(string, pattern, replacement)
-
pad(string with length spec[ character])
-
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)
-
format(datetime as pattern)
-
collate(string as collation)
-
str(arg)
- synonym ofcast(a as String)
-
ifnull(arg0, arg1)
- synonym ofcoalesce(a, b)
extract()
, and desugared by the parser:-
second(arg)
- synonym ofextract(second from a)
-
minute(arg)
- synonym ofextract(minute from a)
-
hour(arg)
- synonym ofextract(hour from a)
-
day(arg)
- synonym ofextract(day from a)
-
month(arg)
- synonym ofextract(month from a)
-
year(arg)
- synonym ofextract(year from a)
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 classDialect
-
-
supportsMinMaxOnUuid
protected boolean supportsMinMaxOnUuid()
Whether PostgreSQL supports `min(uuid)`/`max(uuid)` which it doesn't by default. Since the emulation is not very performant, this can be overridden by users which make sure that an aggregate function for uuid exists on their database. The following definitions can be used for this purpose:create or replace function min(uuid, uuid) returns uuid immutable parallel safe language plpgsql as $$ begin return least($1, $2); end $$; create aggregate min(uuid) ( sfunc = min, stype = uuid, combinefunc = min, parallel = safe, sortop = operator (<) ); create or replace function max(uuid, uuid) returns uuid immutable parallel safe language plpgsql as $$ begin return greatest($1, $2); end $$; create aggregate max(uuid) ( sfunc = max, stype = uuid, combinefunc = max, parallel = safe, sortop = operator (>) );
-
getNameQualifierSupport
public NameQualifierSupport getNameQualifierSupport()
Description copied from class:Dialect
The support for qualified identifiers.By default, decide based on
DatabaseMetaData
.- Overrides:
getNameQualifierSupport
in classDialect
- Returns:
- The
NameQualifierSupport
, or null to useDatabaseMetaData
.
-
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 resultingSchemaNameResolver
does not need this information. For example, a custom implementation might make use of the Java 1.7Connection.getSchema()
method.- Overrides:
getCurrentSchemaCommand
in classDialect
- Returns:
- The current schema retrieval SQL
-
supportsDistinctFromPredicate
public boolean supportsDistinctFromPredicate()
Description copied from class:Dialect
Does this dialect support some kind ofdistinct from
predicate?That is, does it support syntax like:
... where FIRST_NAME IS DISTINCT FROM LAST_NAME
- Overrides:
supportsDistinctFromPredicate
in classDialect
- Returns:
- True if this SQL dialect is known to support some kind of
distinct from
predicate; false otherwise
-
supportsIfExistsBeforeTableName
public boolean supportsIfExistsBeforeTableName()
Description copied from class:Dialect
For dropping a table, can the phraseif exists
be applied before the table name?- Overrides:
supportsIfExistsBeforeTableName
in classDialect
- Returns:
true
ifif exists
can be applied before the table name
-
supportsIfExistsBeforeTypeName
public boolean supportsIfExistsBeforeTypeName()
Description copied from class:Dialect
For dropping a type, can the phraseif exists
be applied before the type name?- Overrides:
supportsIfExistsBeforeTypeName
in classDialect
- Returns:
true
ifif exists
can be applied before the type name
-
supportsIfExistsBeforeConstraintName
public boolean supportsIfExistsBeforeConstraintName()
Description copied from class:Dialect
For dropping a constraint with analter table
statement, can the phraseif exists
be applied before the constraint name?- Overrides:
supportsIfExistsBeforeConstraintName
in classDialect
- Returns:
true
ifif exists
can be applied before the constraint name
-
supportsIfExistsAfterAlterTable
public boolean supportsIfExistsAfterAlterTable()
Description copied from class:Dialect
For analter table
, can the phraseif exists
be applied?- Overrides:
supportsIfExistsAfterAlterTable
in classDialect
- Returns:
true
ifif exists
can be applied afteralter table
-
getAlterColumnTypeString
public String getAlterColumnTypeString(String columnName, String columnType, String columnDefinition)
Description copied from class:Dialect
The fragment of analter table
command which modifies a column type, or null if column types cannot be modified. Oftenalter column col_name set data type col_type
.- Overrides:
getAlterColumnTypeString
in classDialect
- Parameters:
columnName
- the name of the columncolumnType
- the new type of the columncolumnDefinition
- 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 classDialect
-
supportsValuesList
public boolean supportsValuesList()
Description copied from class:Dialect
Does this dialect supportvalues
lists of formVALUES (1), (2), (3)
?- Overrides:
supportsValuesList
in classDialect
- Returns:
true
ifvalues
list are supported
-
supportsPartitionBy
public boolean supportsPartitionBy()
Description copied from class:Dialect
Does is dialect supportpartition by
?- Overrides:
supportsPartitionBy
in classDialect
-
supportsNonQueryWithCTE
public boolean supportsNonQueryWithCTE()
Description copied from class:Dialect
Does this dialect support insert, update, and delete statements with Common Table Expressions (CTEs)?- Overrides:
supportsNonQueryWithCTE
in classDialect
- Returns:
true
if non-query statements are supported with CTE
-
getSequenceSupport
public SequenceSupport getSequenceSupport()
Description copied from class:Dialect
Get the appropriateSequenceSupport
for this dialect.- Overrides:
getSequenceSupport
in classDialect
-
getCascadeConstraintsString
public String getCascadeConstraintsString()
Description copied from class:Dialect
The keyword that specifies that adrop 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 classDialect
- Returns:
- The cascade drop keyword, if any, with a leading space
-
getQuerySequencesString
public String getQuerySequencesString()
Description copied from class:Dialect
Get theselect
command used retrieve the names of all sequences.- Overrides:
getQuerySequencesString
in classDialect
- Returns:
- The select command; or null if sequences are not supported.
-
getLimitHandler
public LimitHandler getLimitHandler()
Description copied from class:Dialect
Obtain aLimitHandler
that implements pagination support forQuery.setMaxResults(int)
andQuery.setFirstResult(int)
.- Overrides:
getLimitHandler
in classDialect
-
getForUpdateString
public String getForUpdateString(String aliases)
Description copied from class:Dialect
Get theFOR UPDATE OF column_list
fragment appropriate for this dialect, given the aliases of the columns to be write locked.- Overrides:
getForUpdateString
in classDialect
- Parameters:
aliases
- The columns to be write locked.- Returns:
- The appropriate
FOR UPDATE OF column_list
clause string.
-
getForUpdateString
public String getForUpdateString(String aliases, LockOptions lockOptions)
Description copied from class:Dialect
Get theFOR UPDATE OF
orFOR SHARE OF
fragment appropriate for this dialect, given the aliases of the columns to be locked.- Overrides:
getForUpdateString
in classDialect
- Parameters:
aliases
- The columns to be locked.lockOptions
- the lock options to apply- Returns:
- The appropriate
FOR UPDATE OF column_list
clause string.
-
getNoColumnsInsertString
public String getNoColumnsInsertString()
Description copied from class:Dialect
The fragment used to insert a row without specifying any column values, usually just()
, but sometimesdefault values
.- Overrides:
getNoColumnsInsertString
in classDialect
- Returns:
- The appropriate empty values clause.
-
getCaseInsensitiveLike
public String getCaseInsensitiveLike()
Description copied from class:Dialect
The name of the SQL operator that performs case-insensitiveLIKE
comparisons.- Overrides:
getCaseInsensitiveLike
in classDialect
- Returns:
- The dialect-specific case-insensitive like operator.
-
supportsCaseInsensitiveLike
public boolean supportsCaseInsensitiveLike()
Description copied from class:Dialect
Does this dialect support case-insensitiveLIKE
comparisons?- Overrides:
supportsCaseInsensitiveLike
in classDialect
- Returns:
true
if the database supports case-insensitive like comparisons,false
otherwise. The default isfalse
.
-
getNativeIdentifierGeneratorStrategy
public String getNativeIdentifierGeneratorStrategy()
Description copied from class:Dialect
The name identifying the "native" id generation strategy for this dialect.This is the id generation strategy which should be used when
"native"
is specified inhbm.xml
, orGenerationType.AUTO
is specified by the@GeneratedValue
annotation.- Overrides:
getNativeIdentifierGeneratorStrategy
in classDialect
- Returns:
- The name identifying the native generator strategy.
-
supportsOuterJoinForUpdate
public boolean supportsOuterJoinForUpdate()
Description copied from class:Dialect
Does this dialect supportFOR UPDATE
in conjunction with outer-joined rows?- Overrides:
supportsOuterJoinForUpdate
in classDialect
- Returns:
- True if outer-joined rows can be locked via
FOR UPDATE
.
-
useInputStreamToInsertBlob
public boolean useInputStreamToInsertBlob()
Description copied from class:Dialect
Should LOBs (both BLOB and CLOB) be bound using stream operations, that is, usingPreparedStatement.setBinaryStream(int, java.io.InputStream, int)
).- Overrides:
useInputStreamToInsertBlob
in classDialect
- Returns:
- True if BLOBs and CLOBs should be bound using stream operations.
-
getSelectClauseNullString
public String getSelectClauseNullString(int sqlType, TypeConfiguration typeConfiguration)
Description copied from class:Dialect
Given a JDBC type code, return the expression for a literal null value of that type, to use in aselect
clause.The
select
query will be an element of aUNION
orUNION ALL
.- Overrides:
getSelectClauseNullString
in classDialect
- Parameters:
sqlType
- TheTypes
type code.typeConfiguration
- The type configuration- Returns:
- The appropriate select clause value fragment.
-
supportsCommentOn
public boolean supportsCommentOn()
Description copied from class:Dialect
Does this dialect support commenting on tables and columns?- Overrides:
supportsCommentOn
in classDialect
- 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 classDialect
- Returns:
- True if the current timestamp can be retrieved; false otherwise.
-
isCurrentTimestampSelectStringCallable
public boolean isCurrentTimestampSelectStringCallable()
Description copied from class:Dialect
Is the command returned byDialect.getCurrentTimestampSelectString()
treated as callable?Typically, this indicates the use of the JDBC escape syntax.
- Overrides:
isCurrentTimestampSelectStringCallable
in classDialect
- Returns:
- if the
Dialect.getCurrentTimestampSelectString()
is treated as callable; false otherwise.
-
getCurrentTimestampSelectString
public String getCurrentTimestampSelectString()
Description copied from class:Dialect
The command used to retrieve the current timestamp from the database.- Overrides:
getCurrentTimestampSelectString
in classDialect
-
supportsTupleCounts
public boolean supportsTupleCounts()
Description copied from class:Dialect
Does this dialect supportcount(a,b)
?- Overrides:
supportsTupleCounts
in classDialect
- Returns:
- True if the database supports counting tuples; false otherwise.
-
requiresParensForTupleDistinctCounts
public boolean requiresParensForTupleDistinctCounts()
Description copied from class:Dialect
IfDialect.supportsTupleDistinctCounts()
is true, does this dialect require the tuple to be delimited with parentheses?- Overrides:
requiresParensForTupleDistinctCounts
in classDialect
- Returns:
- boolean
-
appendBooleanValueString
public void appendBooleanValueString(SqlAppender appender, boolean bool)
Description copied from class:Dialect
Append the SQL literal expression representing the given boolean value to the givenSqlAppender
.- Overrides:
appendBooleanValueString
in classDialect
- Parameters:
appender
- TheSqlAppender
to append the literal expression tobool
- The boolean value
-
buildIdentifierHelper
public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuilder builder, DatabaseMetaData dbMetaData) throws SQLException
Description copied from class:Dialect
TheIdentifierHelper
indicated by this dialect for handling identifier conversions. Returningnull
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 UPPERIdentifierHelperBuilder.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 classDialect
- Parameters:
builder
- A partially-configuredIdentifierHelperBuilder
.dbMetaData
- Access to the metadata returned from the driver if needed and if available. WARNING: it may benull
.- Returns:
- The
IdentifierHelper
instance to use, ornull
to indicate Hibernate should use its fallback path - Throws:
SQLException
- Accessing theDatabaseMetaData
can throw it. Just rethrow and Hibernate will handle it.- See Also:
Dialect.getNameQualifierSupport()
-
getFallbackSqmMutationStrategy
public SqmMultiTableMutationStrategy getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)
Description copied from class:Dialect
TheSqmMultiTableMutationStrategy
to use when not specified byQueryEngineOptions.getCustomSqmMultiTableMutationStrategy()
.
-
getFallbackSqmInsertStrategy
public SqmMultiTableInsertStrategy getFallbackSqmInsertStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext)
Description copied from class:Dialect
TheSqmMultiTableInsertStrategy
to use when not specified byQueryEngineOptions.getCustomSqmMultiTableInsertStrategy()
.
-
getSqlAstTranslatorFactory
public SqlAstTranslatorFactory getSqlAstTranslatorFactory()
Description copied from class:Dialect
- Overrides:
getSqlAstTranslatorFactory
in classDialect
- See Also:
StandardSqlAstTranslatorFactory
,JdbcEnvironment.getSqlAstTranslatorFactory()
-
getViolatedConstraintNameExtractor
public ViolatedConstraintNameExtractor getViolatedConstraintNameExtractor()
Description copied from class:Dialect
AViolatedConstraintNameExtractor
for extracting the name of a violated constraint from aSQLException
.- Specified by:
getViolatedConstraintNameExtractor
in interfaceConversionContext
- Overrides:
getViolatedConstraintNameExtractor
in classDialect
-
buildSQLExceptionConversionDelegate
public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate()
Description copied from class:Dialect
An instance ofSQLExceptionConversionDelegate
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 returnedSQLExceptionConversionDelegate
in addition to the following standard delegates:- a "static" delegate based on the JDBC4-defined
SQLException
hierarchy, and - 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 classDialect
- Returns:
- The
SQLExceptionConversionDelegate
for this dialect
- a "static" delegate based on the JDBC4-defined
-
registerResultSetOutParameter
public int registerResultSetOutParameter(CallableStatement statement, int col) throws SQLException
Description copied from class:Dialect
Registers a parameter capable of returning aResultSet
by position, either anOUT
parameter, or aREF_CURSOR
parameter as defined in Java 8.- Overrides:
registerResultSetOutParameter
in classDialect
- 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 byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int)
, extract theResultSet
from theOUT
parameter.- Overrides:
getResultSet
in classDialect
- Parameters:
ps
- The callable statement.- Returns:
- The extracted result set.
- Throws:
SQLException
- Indicates problems extracting the result set.
-
supportsLobValueChangePropagation
public boolean supportsLobValueChangePropagation()
Description copied from class:Dialect
Does the dialect support propagating changes to LOB values back to the database? Talking about mutating the internal value of the locator, as opposed to supplying a new locator instance.- For BLOBs, the internal value might be changed by:
Blob.setBinaryStream(long)
,Blob.setBytes(long, byte[])
,Blob.setBytes(long, byte[], int, int)
, orBlob.truncate(long)
. - For CLOBs, the internal value might be changed by:
Clob.setAsciiStream(long)
,Clob.setCharacterStream(long)
,Clob.setString(long, String)
,Clob.setString(long, String, int, int)
, orClob.truncate(long)
.
- Overrides:
supportsLobValueChangePropagation
in classDialect
- Returns:
- True if the changes are propagated back to the database; false otherwise.
- For BLOBs, the internal value might be changed by:
-
supportsUnboundedLobLocatorMaterialization
public boolean supportsUnboundedLobLocatorMaterialization()
Description copied from class:Dialect
Is it supported to materialize a LOB locator outside the transaction in which it was created?- Overrides:
supportsUnboundedLobLocatorMaterialization
in classDialect
- Returns:
- True if unbounded materialization is supported; false otherwise.
-
getGroupBySelectItemReferenceStrategy
public SelectItemReferenceStrategy getGroupBySelectItemReferenceStrategy()
Description copied from class:Dialect
Determine how selected items are referenced in thegroup by
clause.- Overrides:
getGroupBySelectItemReferenceStrategy
in classDialect
-
getCallableStatementSupport
public CallableStatementSupport getCallableStatementSupport()
Description copied from class:Dialect
TheCallableStatementSupport
for this database. Does this database support returning cursors?- Overrides:
getCallableStatementSupport
in classDialect
-
getResultSet
public ResultSet getResultSet(CallableStatement statement, int position) throws SQLException
Description copied from class:Dialect
Given a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int)
, extract theResultSet
from the positionalOUT
parameter.- Overrides:
getResultSet
in classDialect
- Parameters:
statement
- The callable statement.position
- The bind position at which to register the output param.- Returns:
- The extracted result set.
- Throws:
SQLException
- Indicates problems extracting the result set.
-
getResultSet
public ResultSet getResultSet(CallableStatement statement, String name) throws SQLException
Description copied from class:Dialect
Given a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int)
, extract theResultSet
from the namedOUT
parameter.- Overrides:
getResultSet
in classDialect
- 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.
-
qualifyIndexName
public boolean qualifyIndexName()
Description copied from class:Dialect
Do we need to qualify index names with the schema name?- Overrides:
qualifyIndexName
in classDialect
- Returns:
true
if we do
-
getIdentityColumnSupport
public IdentityColumnSupport getIdentityColumnSupport()
Description copied from class:Dialect
Get the appropriateIdentityColumnSupport
for this dialect.- Overrides:
getIdentityColumnSupport
in classDialect
- Returns:
- the IdentityColumnSupport
-
getNationalizationSupport
public NationalizationSupport getNationalizationSupport()
Description copied from class:Dialect
Determines whether this database requires the use of explicitly nationalized character (Unicode) data types.That is, whether the use of
Types.NCHAR
,Types.NVARCHAR
, andTypes.NCLOB
is required for nationalized character data.- Overrides:
getNationalizationSupport
in classDialect
-
getMaxIdentifierLength
public int getMaxIdentifierLength()
Description copied from class:Dialect
What is the maximum identifier length supported by this dialect?- Overrides:
getMaxIdentifierLength
in classDialect
- Returns:
- The maximum length.
-
supportsStandardArrays
public boolean supportsStandardArrays()
Description copied from class:Dialect
Does this database have native support for ANSI SQL standard arrays which are expressed in terms of the element type name:integer array
.- Overrides:
supportsStandardArrays
in classDialect
- Returns:
- boolean
-
supportsJdbcConnectionLobCreation
public boolean supportsJdbcConnectionLobCreation(DatabaseMetaData databaseMetaData)
Description copied from class:Dialect
Check whether the JDBCConnection
supports creating LOBs viaConnection.createBlob()
,Connection.createNClob()
, orConnection.createClob()
.- Overrides:
supportsJdbcConnectionLobCreation
in classDialect
- Parameters:
databaseMetaData
- JDBCDatabaseMetaData
which can be used if LOB creation is supported only starting from a given driver version- Returns:
true
if LOBs can be created via the JDBC Connection.
-
supportsMaterializedLobAccess
public boolean supportsMaterializedLobAccess()
Description copied from class:Dialect
Check whether the JDBC driver allows setting LOBs viaPreparedStatement.setBytes(int, byte[])
,PreparedStatement.setNString(int, String)
, orPreparedStatement.setString(int, String)
APIs.- Overrides:
supportsMaterializedLobAccess
in classDialect
- Returns:
true
if LOBs can be set with the materialized APIs.
-
supportsTemporalLiteralOffset
public boolean supportsTemporalLiteralOffset()
Description copied from class:Dialect
Does this dialect supports timezone offsets in temporal literals.- Overrides:
supportsTemporalLiteralOffset
in classDialect
-
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'sDateTimeFormatter
to whatever pattern language is understood by the native datetime formatting function for this database (often theto_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 classDialect
-
translateExtractField
public String translateExtractField(TemporalUnit unit)
Description copied from class:Dialect
Return the name used to identify the given field as an argument to theextract()
function, or of this dialect's equivalent function.This method does not need to handle
TemporalUnit.NANOSECOND
,TemporalUnit.NATIVE
,TemporalUnit.OFFSET
,TemporalUnit.DATE
,TemporalUnit.TIME
,TemporalUnit.WEEK_OF_YEAR
, norTemporalUnit.WEEK_OF_MONTH
, which are already desugared byExtractFunction
.- Overrides:
translateExtractField
in classDialect
-
getAggregateSupport
public AggregateSupport getAggregateSupport()
Description copied from class:Dialect
How does this dialect support aggregate types likeSqlTypes.STRUCT
.- Overrides:
getAggregateSupport
in classDialect
-
appendBinaryLiteral
public void appendBinaryLiteral(SqlAppender appender, byte[] bytes)
Description copied from class:Dialect
Append a binary literal to the givenSqlAppender
.- Overrides:
appendBinaryLiteral
in classDialect
-
appendDateTimeLiteral
public void appendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone)
Description copied from class:Dialect
Append a datetime literal representing the givenjava.time
value to the givenSqlAppender
.- Overrides:
appendDateTimeLiteral
in classDialect
-
appendDateTimeLiteral
public void appendDateTimeLiteral(SqlAppender appender, Date date, TemporalType precision, TimeZone jdbcTimeZone)
Description copied from class:Dialect
Append a datetime literal representing the givenDate
value to the givenSqlAppender
.- Overrides:
appendDateTimeLiteral
in classDialect
-
appendDateTimeLiteral
public void appendDateTimeLiteral(SqlAppender appender, Calendar calendar, TemporalType precision, TimeZone jdbcTimeZone)
Description copied from class:Dialect
Append a datetime literal representing the givenCalendar
value to the givenSqlAppender
.- Overrides:
appendDateTimeLiteral
in classDialect
-
getWriteLockString
public String getWriteLockString(int timeout)
Description copied from class:Dialect
Get the string to append toSELECT
statements to acquire pessimistic WRITE locks for this dialect.Location of the returned string is treated the same as
Dialect.getForUpdateString()
.- Overrides:
getWriteLockString
in classDialect
- 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 toSELECT
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 classDialect
- 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 toSELECT
statements to acquire READ locks for this dialect.Location of the returned string is treated the same as
Dialect.getForUpdateString()
.- Overrides:
getReadLockString
in classDialect
- 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 toSELECT
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 classDialect
- 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.
-
getForUpdateNowaitString
public String getForUpdateNowaitString()
Description copied from class:Dialect
Retrieves theFOR UPDATE NOWAIT
syntax specific to this dialect.- Overrides:
getForUpdateNowaitString
in classDialect
- Returns:
- The appropriate
FOR UPDATE NOWAIT
clause string.
-
getForUpdateNowaitString
public String getForUpdateNowaitString(String aliases)
Description copied from class:Dialect
Get theFOR UPDATE OF column_list NOWAIT
fragment appropriate for this dialect, given the aliases of the columns to be write locked.- Overrides:
getForUpdateNowaitString
in classDialect
- 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 theFOR UPDATE SKIP LOCKED
syntax specific to this dialect.- Overrides:
getForUpdateSkipLockedString
in classDialect
- Returns:
- The appropriate
FOR UPDATE SKIP LOCKED
clause string.
-
getForUpdateSkipLockedString
public String getForUpdateSkipLockedString(String aliases)
Description copied from class:Dialect
Get theFOR UPDATE OF column_list SKIP LOCKED
fragment appropriate for this dialect, given the aliases of the columns to be write locked.- Overrides:
getForUpdateSkipLockedString
in classDialect
- Parameters:
aliases
- The columns to be write locked.- Returns:
- The appropriate
FOR UPDATE colunm_list SKIP LOCKED
clause string.
-
supportsNoWait
public boolean supportsNoWait()
Description copied from class:Dialect
Does this dialect supportNO_WAIT
timeout.- Overrides:
supportsNoWait
in classDialect
- Returns:
true
ifNO_WAIT
is supported
-
supportsWait
public boolean supportsWait()
Description copied from class:Dialect
Does this dialect supportWAIT
timeout.- Overrides:
supportsWait
in classDialect
- Returns:
true
ifWAIT
is supported
-
supportsSkipLocked
public boolean supportsSkipLocked()
Description copied from class:Dialect
Does this dialect supportSKIP_LOCKED
timeout.- Overrides:
supportsSkipLocked
in classDialect
- Returns:
true
if SKIP_LOCKED is supported
-
supportsInsertReturning
public boolean supportsInsertReturning()
Description copied from class:Dialect
Does this dialect fully support returning arbitrary generated column values after execution of aninsert
statement, using native SQL syntax?Support for identity columns is insufficient here, we require something like:
insert ... returning ...
select from final table (insert ... )
- Overrides:
supportsInsertReturning
in classDialect
- Returns:
true
ifInsertReturningDelegate
works for any sort of primary key column (not just identity columns), orfalse
ifInsertReturningDelegate
does not work, or only works for specialized identity/"autoincrement" columns- See Also:
OnExecutionGenerator.getGeneratedIdentifierDelegate(org.hibernate.id.PostInsertIdentityPersister)
,InsertReturningDelegate
-
supportsOffsetInSubquery
public boolean supportsOffsetInSubquery()
Description copied from class:Dialect
Does this dialect supportoffset
in subqueries?For example:
select * from Table1 where col1 in (select col1 from Table2 order by col2 limit 1 offset 1)
- Overrides:
supportsOffsetInSubquery
in classDialect
- Returns:
true
if it does
-
supportsWindowFunctions
public boolean supportsWindowFunctions()
Description copied from class:Dialect
Does this dialect support window functions likerow_number() over (..)
?- Overrides:
supportsWindowFunctions
in classDialect
- Returns:
true
if the underlying database supports window functions,false
otherwise. The default isfalse
.
-
supportsLateral
public boolean supportsLateral()
Description copied from class:Dialect
Does this dialect support the SQLlateral
keyword or a proprietary alternative?- Overrides:
supportsLateral
in classDialect
- Returns:
true
if the underlying database supports lateral,false
otherwise. The default isfalse
.
-
supportsRecursiveCTE
public boolean supportsRecursiveCTE()
Description copied from class:Dialect
Does this dialect/database support recursive CTEs?- Overrides:
supportsRecursiveCTE
in classDialect
- Returns:
true
if recursive CTEs are supported
-
supportsFetchClause
public boolean supportsFetchClause(FetchClauseType type)
Description copied from class:Dialect
Does this dialect support the givenFETCH
clause type.- Overrides:
supportsFetchClause
in classDialect
- Parameters:
type
- The fetch clause type- Returns:
true
if the underlying database supports the given fetch clause type,false
otherwise. The default isfalse
.
-
getWriteRowLockStrategy
public RowLockStrategy getWriteRowLockStrategy()
Description copied from class:Dialect
The row lock strategy to use for write locks.- Overrides:
getWriteRowLockStrategy
in classDialect
-
augmentRecognizedTableTypes
public void augmentRecognizedTableTypes(List<String> tableTypesList)
- Overrides:
augmentRecognizedTableTypes
in classDialect
-
contributeTypes
public void contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
Description copied from class:Dialect
A callback which allows theDialect
to contribute types.- Overrides:
contributeTypes
in classDialect
- Parameters:
typeContributions
- Callback to contribute the typesserviceRegistry
- The service registry
-
contributePostgreSQLTypes
protected void contributePostgreSQLTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
Allow for extension points to override this only- Parameters:
typeContributions
-serviceRegistry
-
-
getUniqueDelegate
public UniqueDelegate getUniqueDelegate()
Description copied from class:Dialect
Get theUniqueDelegate
supported by this dialect- Overrides:
getUniqueDelegate
in classDialect
- Returns:
- The UniqueDelegate
-
canBatchTruncate
public boolean canBatchTruncate()
Description copied from class:Dialect
Does thetruncate table
statement accept multiple tables?- Overrides:
canBatchTruncate
in classDialect
- Returns:
true
, but only because we can "batch" truncate
-
rowId
public String rowId(String rowId)
Description copied from class:Dialect
The name of arowid
-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 classDialect
- Parameters:
rowId
- the name specified byRowId.value()
, which is ignored ifDialect.getRowIdColumnString(java.lang.String)
is not overridden
-
rowIdSqlType
public int rowIdSqlType()
Description copied from class:Dialect
The JDBC type code of therowid
-like pseudo-column which acts as a high-performance row locator.- Overrides:
rowIdSqlType
in classDialect
- Returns:
Types.ROWID
by default
-
createOptionalTableUpdateOperation
public MutationOperation createOptionalTableUpdateOperation(EntityMutationTarget mutationTarget, OptionalTableUpdate optionalTableUpdate, SessionFactoryImplementor factory)
Description copied from class:Dialect
Create aMutationOperation
for a updating an optional table- Overrides:
createOptionalTableUpdateOperation
in classDialect
-
getNativeParameterMarkerStrategy
public ParameterMarkerStrategy getNativeParameterMarkerStrategy()
Description copied from class:Dialect
Support for native parameter markers. This is generally dependent on both the database and the driver.- Overrides:
getNativeParameterMarkerStrategy
in classDialect
- Returns:
- May return
null
to indicate that the JDBC standard strategy should be used
-
-