Class PostgreSQLDialect
- All Implemented Interfaces:
FunctionContributor,TypeContributor,ConversionContext
- Direct Known Subclasses:
PostgresPlusDialect
-
Nested Class Summary
Nested classes/interfaces inherited from class org.hibernate.dialect.Dialect
Dialect.SizeStrategy, Dialect.SizeStrategyImpl -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final PostgreSQLDriverKindprotected static final DatabaseVersionFields 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
ConstructorsConstructorDescriptionPostgreSQLDialect(DatabaseVersion version) PostgreSQLDialect(DatabaseVersion version, PostgreSQLDriverKind driverKind) -
Method Summary
Modifier and TypeMethodDescriptionaddSqlHintOrComment(String sql, QueryOptions queryOptions, boolean commentsEnabled) Modify the SQL, adding hints or comments, if necessaryvoidappendBinaryLiteral(SqlAppender appender, byte[] bytes) Append a binary literal to the givenSqlAppender.voidappendBooleanValueString(SqlAppender appender, boolean bool) Append the SQL literal expression representing the given boolean value to the givenSqlAppender.voidappendDatetimeFormat(SqlAppender appender, String format) Translate the given datetime format string from the pattern language defined by Java'sDateTimeFormatterto whatever pattern language is understood by the native datetime formatting function for this database (often theto_char()function).voidappendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone) Append a datetime literal representing the givenjava.timevalue to the givenSqlAppender.voidappendDateTimeLiteral(SqlAppender appender, Calendar calendar, TemporalType precision, TimeZone jdbcTimeZone) Append a datetime literal representing the givenCalendarvalue to the givenSqlAppender.voidappendDateTimeLiteral(SqlAppender appender, Date date, TemporalType precision, TimeZone jdbcTimeZone) Append a datetime literal representing the givenDatevalue to the givenSqlAppender.voidaugmentRecognizedTableTypes(List<String> tableTypesList) buildIdentifierHelper(IdentifierHelperBuilder builder, DatabaseMetaData dbMetaData) TheIdentifierHelperindicated by this dialect for handling identifier conversions.An instance ofSQLExceptionConversionDelegatefor interpreting dialect-specific error or SQLState codes.booleanDoes thetruncate tablestatement accept multiple tables?protected StringcastType(int sqlTypeCode) The SQL type to use incast( ... as ... )expressions when casting to the target type represented by the given JDBC type code.protected StringcolumnType(int sqlTypeCode) protected voidcontributePostgreSQLTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry) Allow for extension points to override this onlyvoidcontributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry) A callback which allows theDialectto contribute types.createOptionalTableUpdateOperation(EntityMutationTarget mutationTarget, OptionalTableUpdate optionalTableUpdate, SessionFactoryImplementor factory) Create aMutationOperationfor a updating an optional tableTranslation of the HQL/JPQLcurrent_timefunction, which maps to the Java typeTimewhich is a time with no time zone.Translation of the HQL/JPQLcurrent_timestampfunction, which maps to the Java typeTimestampwhich is a datetime with no time zone.Translation of the HQLoffset_datetimefunction, which maps to the Java typeOffsetDateTimewhich is a datetime with a time zone.datetimeFormat(String format) extractPattern(TemporalUnit unit) Theextract()function returnsTemporalUnit.DAY_OF_WEEKnumbered from 0 to 6.How does this dialect support aggregate types likeSqlTypes.STRUCT.getAlterColumnTypeString(String columnName, String columnType, String columnDefinition) The fragment of analter tablecommand which modifies a column type, or null if column types cannot be modified.A command to execute before dropping tables.TheCallableStatementSupportfor this database.The keyword that specifies that adrop tableoperation 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.The name of the SQL operator that performs case-insensitiveLIKEcomparisons.String[]getCreateEnumTypeCommand(String name, String[] values) Get the SQL command used to retrieve the current schema name.The command used to retrieve the current timestamp from the database.intThis is the default scale for a generated column of typeINTERVAL SECONDmapped to aDuration.booleanThe default value to use for the configuration property "hibernate.jdbc.lob.non_contextual_creation".intThe default value to use for the configuration property "hibernate.jdbc.batch_size".Get the minimumDmlTargetColumnQualifierSupportrequired by this dialect.String[]getDropEnumTypeCommand(String name) getEnumTypeDeclaration(String name, String[] values) If this database has a special MySQL-styleenumcolumn type, return the type declaration for the given enumeration of values.getFallbackSqmInsertStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext) TheSqmMultiTableInsertStrategyto use when not specified byQueryEngineOptions.getCustomSqmMultiTableInsertStrategy().getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext) TheSqmMultiTableMutationStrategyto use when not specified byQueryEngineOptions.getCustomSqmMultiTableMutationStrategy().Retrieves theFOR UPDATE NOWAITsyntax specific to this dialect.getForUpdateNowaitString(String aliases) Get theFOR UPDATE OF column_list NOWAITfragment appropriate for this dialect, given the aliases of the columns to be write locked.Retrieves theFOR UPDATE SKIP LOCKEDsyntax specific to this dialect.getForUpdateSkipLockedString(String aliases) Get theFOR UPDATE OF column_list SKIP LOCKEDfragment appropriate for this dialect, given the aliases of the columns to be write locked.getForUpdateString(String aliases) Get theFOR UPDATE OF column_listfragment appropriate for this dialect, given the aliases of the columns to be write locked.getForUpdateString(String aliases, LockOptions lockOptions) Get theFOR UPDATE OForFOR SHARE OFfragment appropriate for this dialect, given the aliases of the columns to be locked.longmicrosecondis 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().Get this dialect's level of support for primary key functional dependency analysis withinGROUP BYandORDER BYclauses.Determine how selected items are referenced in thegroup byclause.Get the appropriateIdentityColumnSupportfor this dialect.Obtain aLimitHandlerthat implements pagination support forQuery.setMaxResults(int)andQuery.setFirstResult(int).intWhat is the maximum identifier length supported by this dialect?intThe biggest size value that can be supplied as argument to aTypes.VARBINARY-like type.intThe longest possible length of aTypes.VARCHAR-like column.intThe biggest size value that can be supplied as argument to aTypes.VARCHAR-like type.protected DatabaseVersionGet the version of the SQL dialect that is the minimum supported by this implementation.Determines whether this database requires the use of explicitly nationalized character (Unicode) data types.The name identifying the "native" id generation strategy for this dialect.Support for native parameter markers.The fragment used to insert a row without specifying any column values, usually just(), but sometimesdefault values.getQueryHintString(String sql, String hints) Apply a hint to the given SQL query.Get theselectcommand used retrieve the names of all sequences.getReadLockString(int timeout) Get the string to append toSELECTstatements to acquire READ locks for this dialect.getReadLockString(String aliases, int timeout) Get the string to append toSELECTstatements to acquire READ locks for this dialect, given the aliases of the columns to be read locked.Given a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract theResultSetfrom theOUTparameter.getResultSet(CallableStatement statement, int position) Given a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract theResultSetfrom the positionalOUTparameter.getResultSet(CallableStatement statement, String name) Given a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract theResultSetfrom the namedOUTparameter.getSelectClauseNullString(int sqlType, TypeConfiguration typeConfiguration) Given a JDBC type code, return the expression for a literal null value of that type, to use in aselectclause.Get the appropriateSequenceSupportfor this dialect.How the dialect supports time zone types likeTypes.TIMESTAMP_WITH_TIMEZONE.Get theUniqueDelegatesupported by this dialectAViolatedConstraintNameExtractorfor extracting the name of a violated constraint from aSQLException.getWriteLockString(int timeout) Get the string to append toSELECTstatements to acquire pessimistic WRITE locks for this dialect.getWriteLockString(String aliases, int timeout) Get the string to append toSELECTstatements to acquire WRITE locks for this dialect, given the aliases of the columns to be write locked.The row lock strategy to use for write locks.voidinitializeFunctionRegistry(FunctionContributions functionContributions) Initialize the given registry with any dialect-specific functions.booleanIs the command returned byDialect.getCurrentTimestampSelectString()treated as callable?booleanDo we need to qualify index names with the schema name?quoteCollation(String collation) Quote the given collation name if necessary.protected voidregisterColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry) Register ANSI-standard column types using the length limits defined byDialect.getMaxVarcharLength(),Dialect.getMaxNVarcharLength(), andDialect.getMaxVarbinaryLength().intregisterResultSetOutParameter(CallableStatement statement, int col) Registers a parameter capable of returning aResultSetby position, either anOUTparameter, or aREF_CURSORparameter as defined in Java 8.booleanIfDialect.supportsTupleDistinctCounts()is true, does this dialect require the tuple to be delimited with parentheses?protected IntegerresolveSqlTypeCode(String columnTypeName, TypeConfiguration typeConfiguration) Resolves theSqlTypestype code for the given column type name as reported by the database, ornullif it can't be resolved.resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry) Assigns an appropriateJdbcTypeto a column of a JDBC result set based on the column type name, JDBC type code, precision, and scale.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.intThe JDBC type code of therowid-like pseudo-column which acts as a high-performance row locator.booleanDoes this dialect support modifying the type of an existing column?booleanDoes this dialect support case-insensitiveLIKEcomparisons?booleanDoes this dialect support commenting on tables and columns?booleanDoes this dialect support theconflictclause for insert statements that appear in a CTE?booleanDoes this dialect support some way to retrieve the current timestamp value from the database?booleanDoes this dialect support some kind ofdistinct frompredicate?booleanDoes this dialect support the givenFETCHclause type.booleanDoes this dialect support thefromclause for update statements?booleanFor analter table, can the phraseif existsbe applied?booleanFor dropping a constraint with analter tablestatement, can the phraseif existsbe applied before the constraint name?booleanFor dropping a table, can the phraseif existsbe applied before the table name?booleanFor dropping a type, can the phraseif existsbe applied before the type name?booleanDoes this dialect fully support returning arbitrary generated column values after execution of aninsertstatement, using native SQL syntax?booleanDoes this dialect support theis trueandis falseoperators?booleansupportsJdbcConnectionLobCreation(DatabaseMetaData databaseMetaData) Check whether the JDBCConnectionsupports creating LOBs viaConnection.createBlob(),Connection.createNClob(), orConnection.createClob().booleanDoes this dialect support the SQLlateralkeyword or a proprietary alternative?booleanDoes 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.booleanCheck whether the JDBC driver allows setting LOBs viaPreparedStatement.setBytes(int, byte[]),PreparedStatement.setNString(int, String), orPreparedStatement.setString(int, String)APIs.protected booleanWhether PostgreSQL supportsmin(uuid)/max(uuid), which it doesn't by default.booleanDoes this dialect support insert, update, and delete statements with Common Table Expressions (CTEs)?booleanDoes this dialect supportNO_WAITtimeout.booleanDoes this dialect supportoffsetin subqueries?booleanDoes this dialect supportFOR UPDATEin conjunction with outer-joined rows?booleanDoes is dialect supportpartition by?booleanDoes this dialect/database support recursive CTEs?booleanDoes this dialect supportSKIP_LOCKEDtimeout.booleanDoes this database have native support for ANSI SQL standard arrays which are expressed in terms of the element type name:integer array.booleanDoes this dialect supports timezone offsets in temporal literals.booleanDoes this dialect supportcount(a,b)?booleanIs it supported to materialize a LOB locator outside the transaction in which it was created?booleanDoes this dialect supportvalueslists of formVALUES (1), (2), (3)?booleanDoes this dialect supportWAITtimeout.booleanDoes this dialect support window functions likerow_number() over (..)?timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType) Obtain a pattern for the SQL equivalent to atimestampadd()function call.timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalType, TemporalType toTemporalType) Obtain a pattern for the SQL equivalent to atimestampdiff()function call.Return the name used to identify the given field as an argument to theextract()function, or of this dialect's equivalent function.booleanShould BLOB, CLOB, and NCLOB be created solely using respectivelyConnection.createBlob(),Connection.createClob(), andConnection.createNClob().booleanShould 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
appendArrayLiteral, appendCheckConstraintOptions, appendIntervalLiteral, appendLiteral, appendLockHint, appendUUIDLiteral, applyLocksToSql, augmentPhysicalTableTypes, canCreateCatalog, canCreateSchema, canDisableConstraints, castPattern, checkVersion, closeQuote, contribute, contributeFunctions, currentDate, currentLocalTime, currentLocalTimestamp, defaultScrollMode, doesReadCommittedCauseWritersToBlockReaders, doesRepeatableReadCauseReadersToBlockWriters, doesRoundTemporalOnOverflow, dropConstraints, equivalentTypes, escapeComment, forceLobAsLastValue, generatedAs, getAddColumnString, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAlterTableString, getArrayTypeName, getAuxiliaryDatabaseObjectExporter, getBatchLoadSizingStrategy, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckConstraintString, getColumnAliasExtractor, getColumnComment, getCreateCatalogCommand, getCreateEnumTypeCommand, getCreateIndexString, getCreateIndexTail, getCreateMultisetTableString, getCreateSchemaCommand, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getCreateUserDefinedTypeExtensionsString, getCreateUserDefinedTypeKindString, getCrossReferenceParentTableFilter, getDefaultDecimalPrecision, getDefaultLobLength, getDefaultProperties, getDefaultTimestampPrecision, getDefaultUseGetGeneratedKeys, getDisableConstraintsStatement, getDisableConstraintStatement, getDoublePrecision, getDropCatalogCommand, getDropEnumTypeCommand, 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, getNullColumnString, getNullColumnString, getNullOrdering, getParameterCountLimit, getPreferredSqlTypeCodeForArray, getPreferredSqlTypeCodeForBoolean, 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, isAnsiNullOn, isEmptyStringTreatedAsNull, isJdbcLogWarningsEnabledByDefault, isLob, openQuote, ordinal, prependComment, quote, registerDefaultKeywords, registerKeyword, registerKeywords, registerResultSetOutParameter, requiresCastForConcatenatingNonStrings, requiresFloatCastingOfIntegerDivision, requiresParensForTupleCounts, resolveSqlTypeCode, resolveSqlTypeLength, supportsBatchUpdates, supportsBindAsCallableArgument, supportsBitType, supportsCascadeDelete, supportsCircularCascadeDeleteConstraints, supportsColumnCheck, supportsExistsInSelect, supportsExpectedLobUsagePattern, supportsFractionalTimestampArithmetic, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsAfterTypeName, supportsInsertReturningGeneratedKeys, supportsInsertReturningRowId, supportsLockTimeouts, supportsNamedParameters, supportsNationalizedMethods, supportsNoColumnsInsert, supportsNullPrecedence, supportsOrderByInSubquery, supportsOrdinalSelectItemReference, supportsPredicateAsExpression, supportsRefCursors, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsStandardCurrentTimestampFunction, supportsSubqueryInSelect, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTableOptions, supportsTemporaryTablePrimaryKey, supportsTemporaryTables, supportsTruncateWithCast, supportsTupleDistinctCounts, supportsUnionAll, supportsUnionInSubquery, supportsUpdateReturning, supportsValuesListForInsert, toBooleanValueString, toQuotedIdentifier, toString, transformSelectString, translateDurationField, trimPattern, unquoteGetGeneratedKeys, useArrayForMultiValuedParameters, useCrossReferenceForeignKeys, useFollowOnLocking, useMaterializedLobWhenCapacityExceeded
-
Field Details
-
MINIMUM_VERSION
-
driverKind
-
-
Constructor Details
-
PostgreSQLDialect
public PostgreSQLDialect() -
PostgreSQLDialect
-
PostgreSQLDialect
-
PostgreSQLDialect
-
-
Method Details
-
getMinimumSupportedVersion
Description copied from class:DialectGet the version of the SQL dialect that is the minimum supported by this implementation.- Overrides:
getMinimumSupportedVersionin classDialect
-
getDefaultNonContextualLobCreation
public boolean getDefaultNonContextualLobCreation()Description copied from class:DialectThe default value to use for the configuration property "hibernate.jdbc.lob.non_contextual_creation".- Overrides:
getDefaultNonContextualLobCreationin classDialect
-
columnType
Description copied from class:DialectThe database column type name for a given JDBC type code defined inTypesorSqlTypes. This default implementation returns the ANSI-standard type name.This method may be overridden by concrete
Dialects 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.NCLOBTypes.NCHAR, andTypes.NVARCHAR. On some database, these types are simply remapped toCLOB,CHAR, andVARCHAR. - Mappings for
Types.TIMESTAMPandTypes.TIMESTAMP_WITH_TIMEZONEshould 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-LONGcounterparts. - On the other hand, the types
SqlTypes.LONG32VARCHAR,SqlTypes.LONG32NVARCHAR, andSqlTypes.LONG32VARBINARYare not synonyms, and implementations of this method must define sensible mappings, for example to database-nativeTEXTorCLOBtypes.
- Overrides:
columnTypein classDialect- Parameters:
sqlTypeCode- a SQLtype code- Returns:
- a column type name, with
$l,$p,$splaceholders for length, precision, scale - See Also:
- Implementations of this method are expected to define a
sensible mapping for
-
castType
Description copied from class:DialectThe 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:DialectRegister ANSI-standard column types using the length limits defined byDialect.getMaxVarcharLength(),Dialect.getMaxNVarcharLength(), andDialect.getMaxVarbinaryLength().This method is always called when a
Dialectis instantiated.- Overrides:
registerColumnTypesin classDialect
-
getMaxVarcharLength
public int getMaxVarcharLength()Description copied from class:DialectThe 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:
getMaxVarcharLengthin classDialect
-
getMaxVarcharCapacity
public int getMaxVarcharCapacity()Description copied from class:DialectThe longest possible length of aTypes.VARCHAR-like column.For longer column lengths, use some sort of
clob-like type for the column.- Overrides:
getMaxVarcharCapacityin classDialect
-
getMaxVarbinaryLength
public int getMaxVarbinaryLength()Description copied from class:DialectThe 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:
getMaxVarbinaryLengthin classDialect
-
getDefaultStatementBatchSize
public int getDefaultStatementBatchSize()Description copied from class:DialectThe default value to use for the configuration property "hibernate.jdbc.batch_size".- Overrides:
getDefaultStatementBatchSizein classDialect
-
resolveSqlTypeDescriptor
public JdbcType resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry) Description copied from class:DialectAssigns an appropriateJdbcTypeto a column of a JDBC result set based on the column type name, JDBC type code, precision, and scale.- Overrides:
resolveSqlTypeDescriptorin classDialect- Parameters:
columnTypeName- the column type namejdbcTypeCode- thetype codeprecision- the precision or 0scale- the scale or 0- Returns:
- an appropriate instance of
JdbcType
-
resolveSqlTypeCode
Description copied from class:DialectResolves theSqlTypestype code for the given column type name as reported by the database, ornullif it can't be resolved.- Overrides:
resolveSqlTypeCodein classDialect
-
getEnumTypeDeclaration
Description copied from class:DialectIf this database has a special MySQL-styleenumcolumn type, return the type declaration for the given enumeration of values.If the database has no such type, return
null.- Overrides:
getEnumTypeDeclarationin classDialectvalues- the enumerated values of the type- Returns:
- the DDL column type declaration
-
getCreateEnumTypeCommand
- Overrides:
getCreateEnumTypeCommandin classDialect
-
getDropEnumTypeCommand
- Overrides:
getDropEnumTypeCommandin classDialect
-
currentTime
Description copied from class:DialectTranslation of the HQL/JPQLcurrent_timefunction, which maps to the Java typeTimewhich is a time with no time zone. This contradicts ANSI SQL wherecurrent_timehas the typeTIME WITH TIME ZONE.It is recommended to override this in dialects for databases which support
localtimeortime at local.- Overrides:
currentTimein classDialect
-
currentTimestamp
Description copied from class:DialectTranslation of the HQL/JPQLcurrent_timestampfunction, which maps to the Java typeTimestampwhich is a datetime with no time zone. This contradicts ANSI SQL wherecurrent_timestamphas the typeTIMESTAMP WITH TIME ZONE.It is recommended to override this in dialects for databases which support
localtimestamportimestamp at local.- Overrides:
currentTimestampin classDialect
-
currentTimestampWithTimeZone
Description copied from class:DialectTranslation of the HQLoffset_datetimefunction, which maps to the Java typeOffsetDateTimewhich is a datetime with a time zone. This in principle correctly maps to the ANSI SQLcurrent_timestampwhich has the typeTIMESTAMP WITH TIME ZONE.- Overrides:
currentTimestampWithTimeZonein classDialect
-
extractPattern
Theextract()function returnsTemporalUnit.DAY_OF_WEEKnumbered 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:
extractPatternin classDialect- Parameters:
unit- the first argument
-
getFractionalSecondPrecisionInNanos
public long getFractionalSecondPrecisionInNanos()microsecondis 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:
getFractionalSecondPrecisionInNanosin classDialect- Returns:
- the precision, specified as a quantity of nanoseconds
- See Also:
-
timestampaddPattern
public String timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType) Description copied from class:DialectObtain a pattern for the SQL equivalent to atimestampadd()function call. The resulting pattern must contain ?1, ?2, and ?3 placeholders for the arguments.- Overrides:
timestampaddPatternin 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:DialectObtain a pattern for the SQL equivalent to atimestampdiff()function call. The resulting pattern must contain ?1, ?2, and ?3 placeholders for the arguments.- Overrides:
timestampdiffPatternin classDialect- Parameters:
unit- the first argumentfromTemporalType- true if the first argument is a timestamp, false if a datetoTemporalType- true if the second argument is
-
getTimeZoneSupport
Description copied from class:DialectHow the dialect supports time zone types likeTypes.TIMESTAMP_WITH_TIMEZONE.- Overrides:
getTimeZoneSupportin classDialect
-
initializeFunctionRegistry
Description copied from class:DialectInitialize 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.timetypes:-
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]) -
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 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:
initializeFunctionRegistryin classDialect
-
-
supportsMinMaxOnUuid
protected boolean supportsMinMaxOnUuid()Whether PostgreSQL supportsmin(uuid)/max(uuid), which it doesn't by default. Since the emulation does not perform well, this method may be overridden by any user who ensures that aggregate functions for handling uuids exist in the 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
Description copied from class:DialectThe support for qualified identifiers.By default, decide based on
DatabaseMetaData.- Overrides:
getNameQualifierSupportin classDialect- Returns:
- The
NameQualifierSupport, or null to useDatabaseMetaData.
-
getCurrentSchemaCommand
Description copied from class:DialectGet the SQL command used to retrieve the current schema name.Works in conjunction with
Dialect.getSchemaNameResolver(), unless the resultingSchemaNameResolverdoes not need this information. For example, a custom implementation might make use of the Java 1.7Connection.getSchema()method.- Overrides:
getCurrentSchemaCommandin classDialect- Returns:
- The current schema retrieval SQL
-
supportsDistinctFromPredicate
public boolean supportsDistinctFromPredicate()Description copied from class:DialectDoes this dialect support some kind ofdistinct frompredicate?That is, does it support syntax like:
... where FIRST_NAME IS DISTINCT FROM LAST_NAME
- Overrides:
supportsDistinctFromPredicatein classDialect- Returns:
- True if this SQL dialect is known to support some kind of
distinct frompredicate; false otherwise
-
supportsIfExistsBeforeTableName
public boolean supportsIfExistsBeforeTableName()Description copied from class:DialectFor dropping a table, can the phraseif existsbe applied before the table name?- Overrides:
supportsIfExistsBeforeTableNamein classDialect- Returns:
trueifif existscan be applied before the table name
-
supportsIfExistsBeforeTypeName
public boolean supportsIfExistsBeforeTypeName()Description copied from class:DialectFor dropping a type, can the phraseif existsbe applied before the type name?- Overrides:
supportsIfExistsBeforeTypeNamein classDialect- Returns:
trueifif existscan be applied before the type name
-
supportsIfExistsBeforeConstraintName
public boolean supportsIfExistsBeforeConstraintName()Description copied from class:DialectFor dropping a constraint with analter tablestatement, can the phraseif existsbe applied before the constraint name?- Overrides:
supportsIfExistsBeforeConstraintNamein classDialect- Returns:
trueifif existscan be applied before the constraint name
-
supportsIfExistsAfterAlterTable
public boolean supportsIfExistsAfterAlterTable()Description copied from class:DialectFor analter table, can the phraseif existsbe applied?- Overrides:
supportsIfExistsAfterAlterTablein classDialect- Returns:
trueifif existscan be applied afteralter table
-
getBeforeDropStatement
Description copied from class:DialectA command to execute before dropping tables.- Overrides:
getBeforeDropStatementin classDialect- Returns:
- A SQL statement, or
null
-
getAlterColumnTypeString
public String getAlterColumnTypeString(String columnName, String columnType, String columnDefinition) Description copied from class:DialectThe fragment of analter tablecommand which modifies a column type, or null if column types cannot be modified. Oftenalter column col_name set data type col_type.- Overrides:
getAlterColumnTypeStringin 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:DialectDoes this dialect support modifying the type of an existing column?- Overrides:
supportsAlterColumnTypein classDialect
-
supportsValuesList
public boolean supportsValuesList()Description copied from class:DialectDoes this dialect supportvalueslists of formVALUES (1), (2), (3)?- Overrides:
supportsValuesListin classDialect- Returns:
trueifvalueslist are supported
-
supportsPartitionBy
public boolean supportsPartitionBy()Description copied from class:DialectDoes is dialect supportpartition by?- Overrides:
supportsPartitionByin classDialect
-
supportsNonQueryWithCTE
public boolean supportsNonQueryWithCTE()Description copied from class:DialectDoes this dialect support insert, update, and delete statements with Common Table Expressions (CTEs)?- Overrides:
supportsNonQueryWithCTEin classDialect- Returns:
trueif non-query statements are supported with CTE
-
supportsConflictClauseForInsertCTE
public boolean supportsConflictClauseForInsertCTE()Description copied from class:DialectDoes this dialect support theconflictclause for insert statements that appear in a CTE?- Overrides:
supportsConflictClauseForInsertCTEin classDialect- Returns:
trueifconflictclause is supported
-
getSequenceSupport
Description copied from class:DialectGet the appropriateSequenceSupportfor this dialect.- Overrides:
getSequenceSupportin classDialect
-
getCascadeConstraintsString
Description copied from class:DialectThe keyword that specifies that adrop tableoperation 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:
getCascadeConstraintsStringin classDialect- Returns:
- The cascade drop keyword, if any, with a leading space
-
getQuerySequencesString
Description copied from class:DialectGet theselectcommand used retrieve the names of all sequences.- Overrides:
getQuerySequencesStringin classDialect- Returns:
- The select command; or null if sequences are not supported.
-
getLimitHandler
Description copied from class:DialectObtain aLimitHandlerthat implements pagination support forQuery.setMaxResults(int)andQuery.setFirstResult(int).- Overrides:
getLimitHandlerin classDialect
-
getForUpdateString
Description copied from class:DialectGet theFOR UPDATE OF column_listfragment appropriate for this dialect, given the aliases of the columns to be write locked.- Overrides:
getForUpdateStringin classDialect- Parameters:
aliases- The columns to be write locked.- Returns:
- The appropriate
FOR UPDATE OF column_listclause string.
-
getForUpdateString
Description copied from class:DialectGet theFOR UPDATE OForFOR SHARE OFfragment appropriate for this dialect, given the aliases of the columns to be locked.- Overrides:
getForUpdateStringin classDialect- Parameters:
aliases- The columns to be locked.lockOptions- the lock options to apply- Returns:
- The appropriate
FOR UPDATE OF column_listclause string.
-
getNoColumnsInsertString
Description copied from class:DialectThe fragment used to insert a row without specifying any column values, usually just(), but sometimesdefault values.- Overrides:
getNoColumnsInsertStringin classDialect- Returns:
- The appropriate empty values clause.
-
getCaseInsensitiveLike
Description copied from class:DialectThe name of the SQL operator that performs case-insensitiveLIKEcomparisons.- Overrides:
getCaseInsensitiveLikein classDialect- Returns:
- The dialect-specific case-insensitive like operator.
-
supportsCaseInsensitiveLike
public boolean supportsCaseInsensitiveLike()Description copied from class:DialectDoes this dialect support case-insensitiveLIKEcomparisons?- Overrides:
supportsCaseInsensitiveLikein classDialect- Returns:
trueif the database supports case-insensitive like comparisons,falseotherwise. The default isfalse.
-
getNativeIdentifierGeneratorStrategy
Description copied from class:DialectThe 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 inhbm.xml.- Overrides:
getNativeIdentifierGeneratorStrategyin classDialect- Returns:
- The name identifying the native generator strategy.
-
supportsOuterJoinForUpdate
public boolean supportsOuterJoinForUpdate()Description copied from class:DialectDoes this dialect supportFOR UPDATEin conjunction with outer-joined rows?- Overrides:
supportsOuterJoinForUpdatein classDialect- Returns:
- True if outer-joined rows can be locked via
FOR UPDATE.
-
useInputStreamToInsertBlob
public boolean useInputStreamToInsertBlob()Description copied from class:DialectShould LOBs (both BLOB and CLOB) be bound using stream operations, that is, usingPreparedStatement.setBinaryStream(int, java.io.InputStream, int)).- Overrides:
useInputStreamToInsertBlobin classDialect- Returns:
- True if BLOBs and CLOBs should be bound using stream operations.
-
useConnectionToCreateLob
public boolean useConnectionToCreateLob()Description copied from class:DialectShould BLOB, CLOB, and NCLOB be created solely using respectivelyConnection.createBlob(),Connection.createClob(), andConnection.createNClob().- Overrides:
useConnectionToCreateLobin classDialect- Returns:
- True if BLOB, CLOB, and NCLOB should be created using JDBC
Connection.
-
getSelectClauseNullString
Description copied from class:DialectGiven a JDBC type code, return the expression for a literal null value of that type, to use in aselectclause.The
selectquery will be an element of aUNIONorUNION ALL.- Overrides:
getSelectClauseNullStringin classDialect- Parameters:
sqlType- TheTypestype code.typeConfiguration- The type configuration- Returns:
- The appropriate select clause value fragment.
-
quoteCollation
Description copied from class:DialectQuote the given collation name if necessary.- Overrides:
quoteCollationin classDialect
-
supportsCommentOn
public boolean supportsCommentOn()Description copied from class:DialectDoes this dialect support commenting on tables and columns?- Overrides:
supportsCommentOnin classDialect- Returns:
trueif commenting is supported
-
supportsCurrentTimestampSelection
public boolean supportsCurrentTimestampSelection()Description copied from class:DialectDoes this dialect support some way to retrieve the current timestamp value from the database?- Overrides:
supportsCurrentTimestampSelectionin classDialect- Returns:
- True if the current timestamp can be retrieved; false otherwise.
-
isCurrentTimestampSelectStringCallable
public boolean isCurrentTimestampSelectStringCallable()Description copied from class:DialectIs the command returned byDialect.getCurrentTimestampSelectString()treated as callable?Typically, this indicates the use of the JDBC escape syntax.
- Overrides:
isCurrentTimestampSelectStringCallablein classDialect- Returns:
- if the
Dialect.getCurrentTimestampSelectString()is treated as callable; false otherwise.
-
getCurrentTimestampSelectString
Description copied from class:DialectThe command used to retrieve the current timestamp from the database.- Overrides:
getCurrentTimestampSelectStringin classDialect
-
supportsTupleCounts
public boolean supportsTupleCounts()Description copied from class:DialectDoes this dialect supportcount(a,b)?- Overrides:
supportsTupleCountsin classDialect- Returns:
- True if the database supports counting tuples; false otherwise.
-
supportsIsTrue
public boolean supportsIsTrue()Description copied from class:DialectDoes this dialect support theis trueandis falseoperators?- Overrides:
supportsIsTruein classDialect- Returns:
trueif the database supportsis trueandis false, orfalseif it does not. The default isis false.
-
requiresParensForTupleDistinctCounts
public boolean requiresParensForTupleDistinctCounts()Description copied from class:DialectIfDialect.supportsTupleDistinctCounts()is true, does this dialect require the tuple to be delimited with parentheses?- Overrides:
requiresParensForTupleDistinctCountsin classDialect- Returns:
- boolean
-
appendBooleanValueString
Description copied from class:DialectAppend the SQL literal expression representing the given boolean value to the givenSqlAppender.- Overrides:
appendBooleanValueStringin classDialect- Parameters:
appender- TheSqlAppenderto append the literal expression tobool- The boolean value
-
buildIdentifierHelper
public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuilder builder, DatabaseMetaData dbMetaData) throws SQLException Description copied from class:DialectTheIdentifierHelperindicated by this dialect for handling identifier conversions. Returningnullis 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:
buildIdentifierHelperin 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
IdentifierHelperinstance to use, ornullto indicate Hibernate should use its fallback path - Throws:
SQLException- Accessing theDatabaseMetaDatacan throw it. Just rethrow and Hibernate will handle it.- See Also:
-
getFallbackSqmMutationStrategy
public SqmMultiTableMutationStrategy getFallbackSqmMutationStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext) Description copied from class:DialectTheSqmMultiTableMutationStrategyto use when not specified byQueryEngineOptions.getCustomSqmMultiTableMutationStrategy(). -
getFallbackSqmInsertStrategy
public SqmMultiTableInsertStrategy getFallbackSqmInsertStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext) Description copied from class:DialectTheSqmMultiTableInsertStrategyto use when not specified byQueryEngineOptions.getCustomSqmMultiTableInsertStrategy(). -
getSqlAstTranslatorFactory
Description copied from class:Dialect- Overrides:
getSqlAstTranslatorFactoryin classDialect- See Also:
-
getViolatedConstraintNameExtractor
Description copied from class:DialectAViolatedConstraintNameExtractorfor extracting the name of a violated constraint from aSQLException.- Specified by:
getViolatedConstraintNameExtractorin interfaceConversionContext- Overrides:
getViolatedConstraintNameExtractorin classDialect
-
buildSQLExceptionConversionDelegate
Description copied from class:DialectAn instance ofSQLExceptionConversionDelegatefor interpreting dialect-specific error or SQLState codes.If this method is overridden to return a non-null value, the default
SQLExceptionConverterwill use the returnedSQLExceptionConversionDelegatein addition to the following standard delegates:- a "static" delegate based on the JDBC4-defined
SQLExceptionhierarchy, 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
Dialectimplementation 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:
buildSQLExceptionConversionDelegatein classDialect- Returns:
- The
SQLExceptionConversionDelegatefor this dialect
- a "static" delegate based on the JDBC4-defined
-
registerResultSetOutParameter
Description copied from class:DialectRegisters a parameter capable of returning aResultSetby position, either anOUTparameter, or aREF_CURSORparameter as defined in Java 8.- Overrides:
registerResultSetOutParameterin 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
Description copied from class:DialectGiven a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract theResultSetfrom theOUTparameter.- Overrides:
getResultSetin 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:DialectDoes 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:
supportsLobValueChangePropagationin 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:DialectIs it supported to materialize a LOB locator outside the transaction in which it was created?- Overrides:
supportsUnboundedLobLocatorMaterializationin classDialect- Returns:
- True if unbounded materialization is supported; false otherwise.
-
getGroupBySelectItemReferenceStrategy
Description copied from class:DialectDetermine how selected items are referenced in thegroup byclause.- Overrides:
getGroupBySelectItemReferenceStrategyin classDialect
-
getCallableStatementSupport
Description copied from class:DialectTheCallableStatementSupportfor this database. Does this database support returning cursors?- Overrides:
getCallableStatementSupportin classDialect
-
getResultSet
Description copied from class:DialectGiven a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract theResultSetfrom the positionalOUTparameter.- Overrides:
getResultSetin 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
Description copied from class:DialectGiven a callable statement previously processed byDialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract theResultSetfrom the namedOUTparameter.- Overrides:
getResultSetin 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:DialectDo we need to qualify index names with the schema name?- Overrides:
qualifyIndexNamein classDialect- Returns:
trueif we do
-
getIdentityColumnSupport
Description copied from class:DialectGet the appropriateIdentityColumnSupportfor this dialect.- Overrides:
getIdentityColumnSupportin classDialect- Returns:
- the IdentityColumnSupport
-
getNationalizationSupport
Description copied from class:DialectDetermines whether this database requires the use of explicitly nationalized character (Unicode) data types.That is, whether the use of
Types.NCHAR,Types.NVARCHAR, andTypes.NCLOBis required for nationalized character data.- Overrides:
getNationalizationSupportin classDialect
-
getMaxIdentifierLength
public int getMaxIdentifierLength()Description copied from class:DialectWhat is the maximum identifier length supported by this dialect?- Overrides:
getMaxIdentifierLengthin classDialect- Returns:
- The maximum length.
-
supportsStandardArrays
public boolean supportsStandardArrays()Description copied from class:DialectDoes this database have native support for ANSI SQL standard arrays which are expressed in terms of the element type name:integer array.- Overrides:
supportsStandardArraysin classDialect- Returns:
- boolean
-
supportsJdbcConnectionLobCreation
Description copied from class:DialectCheck whether the JDBCConnectionsupports creating LOBs viaConnection.createBlob(),Connection.createNClob(), orConnection.createClob().- Overrides:
supportsJdbcConnectionLobCreationin classDialect- Parameters:
databaseMetaData- JDBCDatabaseMetaDatawhich can be used if LOB creation is supported only starting from a given driver version- Returns:
trueif LOBs can be created via the JDBC Connection.
-
supportsMaterializedLobAccess
public boolean supportsMaterializedLobAccess()Description copied from class:DialectCheck whether the JDBC driver allows setting LOBs viaPreparedStatement.setBytes(int, byte[]),PreparedStatement.setNString(int, String), orPreparedStatement.setString(int, String)APIs.- Overrides:
supportsMaterializedLobAccessin classDialect- Returns:
trueif LOBs can be set with the materialized APIs.
-
supportsTemporalLiteralOffset
public boolean supportsTemporalLiteralOffset()Description copied from class:DialectDoes this dialect supports timezone offsets in temporal literals.- Overrides:
supportsTemporalLiteralOffsetin classDialect
-
appendDatetimeFormat
Description copied from class:DialectTranslate the given datetime format string from the pattern language defined by Java'sDateTimeFormatterto 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:
appendDatetimeFormatin classDialect
-
datetimeFormat
-
translateExtractField
Description copied from class:DialectReturn 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:
translateExtractFieldin classDialect
-
getAggregateSupport
Description copied from class:DialectHow does this dialect support aggregate types likeSqlTypes.STRUCT.- Overrides:
getAggregateSupportin classDialect
-
appendBinaryLiteral
Description copied from class:DialectAppend a binary literal to the givenSqlAppender.- Overrides:
appendBinaryLiteralin classDialect
-
appendDateTimeLiteral
public void appendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone) Description copied from class:DialectAppend a datetime literal representing the givenjava.timevalue to the givenSqlAppender.- Overrides:
appendDateTimeLiteralin classDialect
-
appendDateTimeLiteral
public void appendDateTimeLiteral(SqlAppender appender, Date date, TemporalType precision, TimeZone jdbcTimeZone) Description copied from class:DialectAppend a datetime literal representing the givenDatevalue to the givenSqlAppender.- Overrides:
appendDateTimeLiteralin classDialect
-
appendDateTimeLiteral
public void appendDateTimeLiteral(SqlAppender appender, Calendar calendar, TemporalType precision, TimeZone jdbcTimeZone) Description copied from class:DialectAppend a datetime literal representing the givenCalendarvalue to the givenSqlAppender.- Overrides:
appendDateTimeLiteralin classDialect
-
getWriteLockString
Description copied from class:DialectGet the string to append toSELECTstatements to acquire pessimistic WRITE locks for this dialect.Location of the returned string is treated the same as
Dialect.getForUpdateString().- Overrides:
getWriteLockStringin classDialect- Parameters:
timeout- in milliseconds, -1 for indefinite wait and 0 for no wait.- Returns:
- The appropriate
LOCKclause string.
-
getWriteLockString
Description copied from class:DialectGet the string to append toSELECTstatements 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:
getWriteLockStringin classDialect- Parameters:
aliases- The columns to be read locked.timeout- in milliseconds, -1 for indefinite wait and 0 for no wait.- Returns:
- The appropriate
LOCKclause string.
-
getReadLockString
Description copied from class:DialectGet the string to append toSELECTstatements to acquire READ locks for this dialect.Location of the returned string is treated the same as
Dialect.getForUpdateString().- Overrides:
getReadLockStringin classDialect- Parameters:
timeout- in milliseconds, -1 for indefinite wait and 0 for no wait.- Returns:
- The appropriate
LOCKclause string.
-
getReadLockString
Description copied from class:DialectGet the string to append toSELECTstatements 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:
getReadLockStringin classDialect- Parameters:
aliases- The columns to be read locked.timeout- in milliseconds, -1 for indefinite wait and 0 for no wait.- Returns:
- The appropriate
LOCKclause string.
-
getForUpdateNowaitString
Description copied from class:DialectRetrieves theFOR UPDATE NOWAITsyntax specific to this dialect.- Overrides:
getForUpdateNowaitStringin classDialect- Returns:
- The appropriate
FOR UPDATE NOWAITclause string.
-
getForUpdateNowaitString
Description copied from class:DialectGet theFOR UPDATE OF column_list NOWAITfragment appropriate for this dialect, given the aliases of the columns to be write locked.- Overrides:
getForUpdateNowaitStringin classDialect- Parameters:
aliases- The columns to be write locked.- Returns:
- The appropriate
FOR UPDATE OF colunm_list NOWAITclause string.
-
getForUpdateSkipLockedString
Description copied from class:DialectRetrieves theFOR UPDATE SKIP LOCKEDsyntax specific to this dialect.- Overrides:
getForUpdateSkipLockedStringin classDialect- Returns:
- The appropriate
FOR UPDATE SKIP LOCKEDclause string.
-
getForUpdateSkipLockedString
Description copied from class:DialectGet theFOR UPDATE OF column_list SKIP LOCKEDfragment appropriate for this dialect, given the aliases of the columns to be write locked.- Overrides:
getForUpdateSkipLockedStringin classDialect- Parameters:
aliases- The columns to be write locked.- Returns:
- The appropriate
FOR UPDATE colunm_list SKIP LOCKEDclause string.
-
supportsNoWait
public boolean supportsNoWait()Description copied from class:DialectDoes this dialect supportNO_WAITtimeout.- Overrides:
supportsNoWaitin classDialect- Returns:
trueifNO_WAITis supported
-
supportsWait
public boolean supportsWait()Description copied from class:DialectDoes this dialect supportWAITtimeout.- Overrides:
supportsWaitin classDialect- Returns:
trueifWAITis supported
-
supportsSkipLocked
public boolean supportsSkipLocked()Description copied from class:DialectDoes this dialect supportSKIP_LOCKEDtimeout.- Overrides:
supportsSkipLockedin classDialect- Returns:
trueif SKIP_LOCKED is supported
-
supportsInsertReturning
public boolean supportsInsertReturning()Description copied from class:DialectDoes this dialect fully support returning arbitrary generated column values after execution of aninsertstatement, using native SQL syntax?Support for identity columns is insufficient here, we require something like:
insert ... returning ...select from final table (insert ... )
- Overrides:
supportsInsertReturningin classDialect- Returns:
trueifInsertReturningDelegateworks for any sort of primary key column (not just identity columns), orfalseifInsertReturningDelegatedoes not work, or only works for specialized identity/"autoincrement" columns- See Also:
-
supportsOffsetInSubquery
public boolean supportsOffsetInSubquery()Description copied from class:DialectDoes this dialect supportoffsetin subqueries?For example:
select * from Table1 where col1 in (select col1 from Table2 order by col2 limit 1 offset 1)
- Overrides:
supportsOffsetInSubqueryin classDialect- Returns:
trueif it does
-
supportsWindowFunctions
public boolean supportsWindowFunctions()Description copied from class:DialectDoes this dialect support window functions likerow_number() over (..)?- Overrides:
supportsWindowFunctionsin classDialect- Returns:
trueif the underlying database supports window functions,falseotherwise. The default isfalse.
-
supportsLateral
public boolean supportsLateral()Description copied from class:DialectDoes this dialect support the SQLlateralkeyword or a proprietary alternative?- Overrides:
supportsLateralin classDialect- Returns:
trueif the underlying database supports lateral,falseotherwise. The default isfalse.
-
supportsRecursiveCTE
public boolean supportsRecursiveCTE()Description copied from class:DialectDoes this dialect/database support recursive CTEs?- Overrides:
supportsRecursiveCTEin classDialect- Returns:
trueif recursive CTEs are supported
-
supportsFetchClause
Description copied from class:DialectDoes this dialect support the givenFETCHclause type.- Overrides:
supportsFetchClausein classDialect- Parameters:
type- The fetch clause type- Returns:
trueif the underlying database supports the given fetch clause type,falseotherwise. The default isfalse.
-
getFunctionalDependencyAnalysisSupport
Description copied from class:DialectGet this dialect's level of support for primary key functional dependency analysis withinGROUP BYandORDER BYclauses.- Overrides:
getFunctionalDependencyAnalysisSupportin classDialect
-
getWriteRowLockStrategy
Description copied from class:DialectThe row lock strategy to use for write locks.- Overrides:
getWriteRowLockStrategyin classDialect
-
augmentRecognizedTableTypes
- Overrides:
augmentRecognizedTableTypesin classDialect
-
contributeTypes
Description copied from class:DialectA callback which allows theDialectto contribute types.- Overrides:
contributeTypesin 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 -
getUniqueDelegate
Description copied from class:DialectGet theUniqueDelegatesupported by this dialect- Overrides:
getUniqueDelegatein classDialect- Returns:
- The UniqueDelegate
-
canBatchTruncate
public boolean canBatchTruncate()Description copied from class:DialectDoes thetruncate tablestatement accept multiple tables?- Overrides:
canBatchTruncatein classDialect- Returns:
true, but only because we can "batch" truncate
-
rowId
Description copied from class:DialectThe 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:
rowIdin 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:DialectThe JDBC type code of therowid-like pseudo-column which acts as a high-performance row locator.- Overrides:
rowIdSqlTypein classDialect- Returns:
Types.ROWIDby default
-
getQueryHintString
Description copied from class:DialectApply 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:
getQueryHintStringin classDialect- Parameters:
sql- The query to which to apply the hint.hints- The hints to apply- Returns:
- The modified SQL
-
addSqlHintOrComment
Description copied from class:DialectModify the SQL, adding hints or comments, if necessary- Overrides:
addSqlHintOrCommentin classDialect
-
createOptionalTableUpdateOperation
public MutationOperation createOptionalTableUpdateOperation(EntityMutationTarget mutationTarget, OptionalTableUpdate optionalTableUpdate, SessionFactoryImplementor factory) Description copied from class:DialectCreate aMutationOperationfor a updating an optional table- Overrides:
createOptionalTableUpdateOperationin classDialect
-
getNativeParameterMarkerStrategy
Description copied from class:DialectSupport for native parameter markers. This is generally dependent on both the database and the driver.- Overrides:
getNativeParameterMarkerStrategyin classDialect- Returns:
- May return
nullto indicate that the JDBC standard strategy should be used
-
getDefaultIntervalSecondScale
public int getDefaultIntervalSecondScale()Description copied from class:DialectThis is the default scale for a generated column of typeINTERVAL SECONDmapped to aDuration.Usually 9 (nanoseconds) or 6 (microseconds).
- Overrides:
getDefaultIntervalSecondScalein classDialect- Returns:
- the default scale, in decimal digits, of the fractional seconds field
- See Also:
-
getDmlTargetColumnQualifierSupport
Description copied from class:DialectGet the minimumDmlTargetColumnQualifierSupportrequired by this dialect.- Overrides:
getDmlTargetColumnQualifierSupportin classDialect- Returns:
- the column qualifier support required by this dialect
-
supportsFromClauseInUpdate
public boolean supportsFromClauseInUpdate()Description copied from class:DialectDoes this dialect support thefromclause for update statements?- Overrides:
supportsFromClauseInUpdatein classDialect- Returns:
trueiffromclause is supported
-