Class CockroachDialect
- java.lang.Object
-
- org.hibernate.dialect.Dialect
-
- org.hibernate.dialect.CockroachDialect
-
- All Implemented Interfaces:
ConversionContext
- Direct Known Subclasses:
CockroachDB202SpatialDialect
public class CockroachDialect extends Dialect
A SQL dialect for CockroachDB 21.1 and above.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.hibernate.dialect.Dialect
Dialect.SizeStrategy, Dialect.SizeStrategyImpl
-
-
Field Summary
-
Fields inherited from class org.hibernate.dialect.Dialect
CLOSED_QUOTE, LEGACY_LOB_MERGE_STRATEGY, LOG_BASE2OF10, NEW_LOCATOR_LOB_MERGE_STRATEGY, QUOTE, STANDARD_DEFAULT_BATCH_LOAD_SIZING_STRATEGY, STREAM_XFER_LOB_MERGE_STRATEGY
-
-
Constructor Summary
Constructors Constructor Description CockroachDialect()
CockroachDialect(DatabaseVersion version)
CockroachDialect(DatabaseVersion version, PostgreSQLDriverKind driverKind)
CockroachDialect(DialectResolutionInfo info)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
appendBooleanValueString(SqlAppender appender, boolean bool)
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, jakarta.persistence.TemporalType precision, TimeZone jdbcTimeZone)
void
appendDateTimeLiteral(SqlAppender appender, Calendar calendar, jakarta.persistence.TemporalType precision, TimeZone jdbcTimeZone)
void
appendDateTimeLiteral(SqlAppender appender, Date date, jakarta.persistence.TemporalType precision, TimeZone jdbcTimeZone)
IdentifierHelper
buildIdentifierHelper(IdentifierHelperBuilder builder, DatabaseMetaData dbMetaData)
Build the IdentifierHelper indicated by this Dialect for handling identifier conversions.SQLExceptionConversionDelegate
buildSQLExceptionConversionDelegate()
Build an instance of aSQLExceptionConversionDelegate
for interpreting dialect-specific error or SQLState codes.protected String
castType(int sqlTypeCode)
protected String
columnType(int sqlTypeCode)
void
contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
Allows the Dialect to contribute additional typesString
extractPattern(TemporalUnit unit)
Theextract()
function returnsTemporalUnit.DAY_OF_WEEK
numbered from 0 to 6.protected static DatabaseVersion
fetchDataBaseVersion(DialectResolutionInfo info)
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 function that can do case insensitive like comparison.String
getCurrentTimestampSelectString()
Retrieve the command used to retrieve the current timestamp from the database.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.String
getForUpdateString(LockOptions lockOptions)
Given LockOptions (lockMode, timeout), determine the appropriate for update fragment to use.long
getFractionalSecondPrecisionInNanos()
microsecond
is the smallest unit for aninterval
, and the highest precision for atimestamp
.IdentityColumnSupport
getIdentityColumnSupport()
Get the appropriateIdentityColumnSupport
LimitHandler
getLimitHandler()
Returns aLimitHandler
that implements support forQuery.setMaxResults(int)
andQuery.setFirstResult(int)
for this dialect.int
getMaxIdentifierLength()
What is the maximum identifier length supported by the dialect?protected DatabaseVersion
getMinimumSupportedVersion()
NameQualifierSupport
getNameQualifierSupport()
By default interpret this based on DatabaseMetaData.NationalizationSupport
getNationalizationSupport()
Determines whether this database requires the use of explicit nationalized character data types.String
getNativeIdentifierGeneratorStrategy()
Resolves the native generation strategy associated to this dialect.String
getNoColumnsInsertString()
The fragment used to insert a row without specifying any column values.NullOrdering
getNullOrdering()
Returns the ordering of null.String
getQuerySequencesString()
Get the select command used retrieve the names of all sequences.String
getReadLockString(int timeout)
Get the string to append to SELECT statements to acquire READ locks for this dialect.String
getReadLockString(String aliases, int timeout)
Get the string to append to SELECT statements to acquire READ locks for this dialect given the aliases of the columns to be read locked.SequenceSupport
getSequenceSupport()
SqlAstTranslatorFactory
getSqlAstTranslatorFactory()
Return aSqlAstTranslatorFactory
specific to this dialect.TimeZoneSupport
getTimeZoneSupport()
How the Dialect supports time zone types likeTypes.TIMESTAMP_WITH_TIMEZONE
.ViolatedConstraintNameExtractor
getViolatedConstraintNameExtractor()
String
getWriteLockString(int timeout)
Get the string to append to SELECT statements to acquire WRITE locks for this dialect.String
getWriteLockString(String aliases, int timeout)
Get the string to append to SELECT statements to acquire WRITE locks for this dialect given the aliases of the columns to be write locked.RowLockStrategy
getWriteRowLockStrategy()
The row lock strategy to use for write locks.void
initializeFunctionRegistry(QueryEngine queryEngine)
Initialize the given registry with any dialect-specific functions.boolean
isCurrentTimestampSelectStringCallable()
Should the value returned byDialect.getCurrentTimestampSelectString()
be treated as callable.protected static DatabaseVersion
parseVersion(String versionString)
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()
.boolean
requiresParensForTupleDistinctCounts()
IfDialect.supportsTupleDistinctCounts()
is true, does this dialect require the tuple to be delimited with parens?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.boolean
supportsCaseInsensitiveLike()
Does this dialect support case insensitive LIKE restrictions?boolean
supportsCurrentTimestampSelection()
Does this dialect support a way to retrieve the database's current timestamp value?boolean
supportsDistinctFromPredicate()
Does this dialect support some kind ofdistinct from
predicate?boolean
supportsIfExistsAfterAlterTable()
For analter table
, can the phrase "if 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 phrase "if exists
be applied before the table name?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
supportsNonQueryWithCTE()
Does this dialect support insert, update, and delete statements with Common Table Expressions?boolean
supportsNoWait()
Does this dialect supportNO_WAIT
timeout.boolean
supportsNullPrecedence()
boolean
supportsOffsetInSubquery()
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)
boolean
supportsOuterJoinForUpdate()
Does this dialect supportFOR UPDATE
in conjunction with outer joined rows?boolean
supportsPartitionBy()
Does the underlying database support partition by?boolean
supportsRecursiveCTE()
Does this dialect/database support recursive CTEs (Common Table Expressions)?boolean
supportsSkipLocked()
Does this dialect supportSKIP_LOCKED
timeout.boolean
supportsStandardArrays()
Database has native support for SQL standard arrays which can be referred to by its base type name.boolean
supportsTemporalLiteralOffset()
Whether the Dialect supports timezone offset in temporal literals.boolean
supportsTupleCounts()
Does this dialect supportcount(a,b)
?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, jakarta.persistence.TemporalType temporalType, IntervalType intervalType)
Obtain a pattern for the SQL equivalent to atimestampadd()
function call.String
timestampdiffPattern(TemporalUnit unit, jakarta.persistence.TemporalType fromTemporalType, jakarta.persistence.TemporalType toTemporalType)
Obtain a pattern for the SQL equivalent to atimestampdiff()
function call.String
translateDurationField(TemporalUnit unit)
Return the name used to identify the given unit of duration as an argument to#timestampadd()
or#timestampdiff()
, or of this dialect's equivalent functions.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, appendBinaryLiteral, appendIntervalLiteral, appendLiteral, appendLockHint, appendUUIDLiteral, applyLocksToSql, augmentPhysicalTableTypes, augmentRecognizedTableTypes, canBatchTruncate, canCreateCatalog, canCreateSchema, canDisableConstraints, castPattern, checkVersion, closeQuote, createUpsertOperation, currentDate, currentLocalTime, currentLocalTimestamp, currentTime, currentTimestamp, currentTimestampWithTimeZone, defaultScrollMode, doesReadCommittedCauseWritersToBlockReaders, doesRepeatableReadCauseReadersToBlockWriters, dropConstraints, equivalentTypes, escapeComment, forceLobAsLastValue, generatedAs, getAddColumnString, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAggregateSupport, getAlterColumnTypeString, getAlterTableString, getArrayTypeName, getAuxiliaryDatabaseObjectExporter, getCallableStatementSupport, getCheckCondition, getCheckCondition, getColumnAliasExtractor, getColumnComment, getCreateCatalogCommand, getCreateIndexString, getCreateIndexTail, getCreateMultisetTableString, getCreateSchemaCommand, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getCreateUserDefinedTypeExtensionsString, getCreateUserDefinedTypeKindString, getCurrentSchemaCommand, getDefaultBatchLoadSizingStrategy, getDefaultDecimalPrecision, getDefaultLobLength, getDefaultNonContextualLobCreation, getDefaultProperties, getDefaultStatementBatchSize, getDefaultTimestampPrecision, getDefaultUseGetGeneratedKeys, getDisableConstraintsStatement, getDisableConstraintStatement, getDoublePrecision, getDropCatalogCommand, getDropForeignKeyString, getDropSchemaCommand, getDropTableString, getDropUniqueKeyString, getEnableConstraintsStatement, getEnableConstraintStatement, getEnumTypeDeclaration, getFallbackSchemaManagementTool, getFallbackSqmInsertStrategy, getFallbackSqmMutationStrategy, getFloatPrecision, getForeignKeyExporter, getForUpdateString, getForUpdateString, getGroupBySelectItemReferenceStrategy, getHqlTranslator, getIndexExporter, getInExpressionCountLimit, getKeywords, getLobMergeStrategy, getLockingStrategy, getLockRowIdentifier, getLowercaseFunction, getMaxAliasLength, getMaxNVarcharCapacity, getMaxNVarcharLength, getMaxVarbinaryCapacity, getMaxVarbinaryLength, getMaxVarcharCapacity, getMaxVarcharLength, getNullColumnString, getNullColumnString, getPreferredSqlTypeCodeForArray, getPreferredSqlTypeCodeForBoolean, getQueryHintString, getQueryHintString, getReadRowLockStrategy, getResultSet, getResultSet, getResultSet, getSchemaNameResolver, getSelectClauseNullString, getSelectGUIDString, getSequenceExporter, getSequenceInformationExtractor, getSizeStrategy, getSqmTranslatorFactory, getSupportedTemporaryTableKind, getTableCleaner, getTableComment, getTableExporter, getTableMigrator, getTableTypeString, getTemporaryTableAfterUseAction, getTemporaryTableBeforeUseAction, getTemporaryTableCreateCommand, getTemporaryTableCreateOptions, getTemporaryTableDdlTransactionHandling, getTemporaryTableDropCommand, getTemporaryTableExporter, getTemporaryTableTruncateCommand, getTruncateTableStatement, getTruncateTableStatements, getUniqueDelegate, getUniqueKeyExporter, getUserDefinedTypeComment, getUserDefinedTypeExporter, getVersion, hasAlterTable, hasDataTypeBeforeGeneratedAs, hasSelfReferentialForeignKeyBug, initDefaultProperties, inlineLiteral, isAnsiNullOn, isEmptyStringTreatedAsNull, isJdbcLogWarningsEnabledByDefault, isLockTimeoutParameterized, openQuote, prependComment, quote, registerDefaultKeywords, registerKeyword, registerKeywords, registerResultSetOutParameter, registerResultSetOutParameter, requiresCastForConcatenatingNonStrings, requiresFloatCastingOfIntegerDivision, requiresParensForTupleCounts, resolveSqlTypeCode, resolveSqlTypeLength, supportsAlterColumnType, supportsBindAsCallableArgument, supportsBitType, supportsCascadeDelete, supportsCircularCascadeDeleteConstraints, supportsColumnCheck, supportsCommentOn, supportsExistsInSelect, supportsExpectedLobUsagePattern, supportsFetchClause, supportsFractionalTimestampArithmetic, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsAfterTypeName, supportsIfExistsBeforeTypeName, supportsInsertReturning, supportsInsertReturningGeneratedKeys, supportsJdbcConnectionLobCreation, supportsLockTimeouts, supportsMaterializedLobAccess, supportsNamedParameters, supportsNoColumnsInsert, supportsOrderByInSubquery, supportsOrdinalSelectItemReference, supportsParametersInInsertSelect, supportsPredicateAsExpression, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsStandardCurrentTimestampFunction, supportsSubqueryInSelect, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTemporaryTablePrimaryKey, supportsTemporaryTables, supportsTruncateWithCast, supportsTupleDistinctCounts, supportsUnboundedLobLocatorMaterialization, supportsUnionAll, supportsUnionInSubquery, supportsValuesListForInsert, toBooleanValueString, toQuotedIdentifier, toString, transformSelectString, trimPattern, useFollowOnLocking, useMaterializedLobWhenCapacityExceeded
-
-
-
-
Constructor Detail
-
CockroachDialect
public CockroachDialect()
-
CockroachDialect
public CockroachDialect(DialectResolutionInfo info)
-
CockroachDialect
public CockroachDialect(DatabaseVersion version)
-
CockroachDialect
public CockroachDialect(DatabaseVersion version, PostgreSQLDriverKind driverKind)
-
-
Method Detail
-
fetchDataBaseVersion
protected static DatabaseVersion fetchDataBaseVersion(DialectResolutionInfo info)
-
parseVersion
protected static DatabaseVersion parseVersion(String versionString)
-
getMinimumSupportedVersion
protected DatabaseVersion getMinimumSupportedVersion()
- Overrides:
getMinimumSupportedVersion
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
-
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
-
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
-
contributeTypes
public void contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
Description copied from class:Dialect
Allows the Dialect to contribute additional types- Overrides:
contributeTypes
in classDialect
- Parameters:
typeContributions
- Callback to contribute the typesserviceRegistry
- The service registry
-
initializeFunctionRegistry
public void initializeFunctionRegistry(QueryEngine queryEngine)
Description copied from class:Dialect
Initialize the given registry with any dialect-specific functions.Support for certain SQL functions is required, and if the database does not support a required function, then the dialect must define a way to emulate it.
These required functions include the functions defined by the JPA query language specification:
-
avg(arg)
- aggregate function -
count([distinct ]arg)
- aggregate function -
max(arg)
- aggregate function -
min(arg)
- aggregate function -
sum(arg)
- aggregate function
-
coalesce(arg0, arg1, ...)
-
nullif(arg0, arg1)
-
lower(arg)
-
upper(arg)
-
length(arg)
-
concat(arg0, arg1, ...)
-
locate(pattern, string[, start])
-
substring(string, start[, length])
-
trim([[spec ][character ]from] string)
-
abs(arg)
-
mod(arg0, arg1)
-
sqrt(arg)
-
current date
-
current time
-
current timestamp
-
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
-
-
getTimeZoneSupport
public TimeZoneSupport getTimeZoneSupport()
Description copied from class:Dialect
How the Dialect supports time zone types likeTypes.TIMESTAMP_WITH_TIMEZONE
.- Overrides:
getTimeZoneSupport
in classDialect
-
appendBooleanValueString
public void appendBooleanValueString(SqlAppender appender, boolean bool)
- Overrides:
appendBooleanValueString
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
-
supportsCurrentTimestampSelection
public boolean supportsCurrentTimestampSelection()
Description copied from class:Dialect
Does this dialect support a way to retrieve the database's current timestamp value?- Overrides:
supportsCurrentTimestampSelection
in classDialect
- Returns:
- True if the current timestamp can be retrieved; false otherwise.
-
isCurrentTimestampSelectStringCallable
public boolean isCurrentTimestampSelectStringCallable()
Description copied from class:Dialect
Should the value returned byDialect.getCurrentTimestampSelectString()
be treated as callable. Typically, this indicates that JDBC escape syntax is being used.- Overrides:
isCurrentTimestampSelectStringCallable
in classDialect
- Returns:
- True if the
Dialect.getCurrentTimestampSelectString()
return is callable; false otherwise.
-
getCurrentTimestampSelectString
public String getCurrentTimestampSelectString()
Description copied from class:Dialect
Retrieve the command used to retrieve the current timestamp from the database.- Overrides:
getCurrentTimestampSelectString
in classDialect
- Returns:
- The command.
-
supportsDistinctFromPredicate
public boolean supportsDistinctFromPredicate()
Description copied from class:Dialect
Does this dialect support some kind ofdistinct from
predicate?This 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 phrase "if exists
be applied before the table name?NOTE : Only one or the other (or neither) of this and
Dialect.supportsIfExistsAfterTableName()
should return true.- Overrides:
supportsIfExistsBeforeTableName
in classDialect
- Returns:
true
ifif exists
can be applied before the table 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?NOTE : Only one or the other (or neither) of this and
Dialect.supportsIfExistsAfterConstraintName()
should return true- 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 phrase "if exists
be applied?- Overrides:
supportsIfExistsAfterAlterTable
in classDialect
- Returns:
true
ifif exists
can be applied afteralter table
-
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:
- boolean
-
getIdentityColumnSupport
public IdentityColumnSupport getIdentityColumnSupport()
Description copied from class:Dialect
Get the appropriateIdentityColumnSupport
- Overrides:
getIdentityColumnSupport
in classDialect
- Returns:
- the IdentityColumnSupport
-
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 the underlying database support partition 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?- Overrides:
supportsNonQueryWithCTE
in classDialect
- Returns:
true
if non-query statements are supported with CTE
-
supportsRecursiveCTE
public boolean supportsRecursiveCTE()
Description copied from class:Dialect
Does this dialect/database support recursive CTEs (Common Table Expressions)?- Overrides:
supportsRecursiveCTE
in classDialect
- Returns:
true
if recursive CTEs are supported
-
getNoColumnsInsertString
public String getNoColumnsInsertString()
Description copied from class:Dialect
The fragment used to insert a row without specifying any column values. This is not possible on some databases.- Overrides:
getNoColumnsInsertString
in classDialect
- Returns:
- The appropriate empty values clause.
-
getCaseInsensitiveLike
public String getCaseInsensitiveLike()
Description copied from class:Dialect
The name of the SQL function that can do case insensitive like comparison.- Overrides:
getCaseInsensitiveLike
in classDialect
- Returns:
- The dialect-specific "case insensitive" like function.
-
supportsCaseInsensitiveLike
public boolean supportsCaseInsensitiveLike()
Description copied from class:Dialect
Does this dialect support case insensitive LIKE restrictions?- Overrides:
supportsCaseInsensitiveLike
in classDialect
- Returns:
true
if the underlying database supports case insensitive like comparison,false
otherwise. The default isfalse
.
-
supportsNullPrecedence
public boolean supportsNullPrecedence()
- Overrides:
supportsNullPrecedence
in classDialect
-
getNullOrdering
public NullOrdering getNullOrdering()
Description copied from class:Dialect
Returns the ordering of null.- Overrides:
getNullOrdering
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 parens?- Overrides:
requiresParensForTupleDistinctCounts
in classDialect
- Returns:
- boolean
-
getNativeIdentifierGeneratorStrategy
public String getNativeIdentifierGeneratorStrategy()
Description copied from class:Dialect
Resolves the native generation strategy associated to this dialect.Comes into play whenever the user specifies the native generator.
- Overrides:
getNativeIdentifierGeneratorStrategy
in classDialect
- Returns:
- The native generator strategy.
-
getSequenceSupport
public SequenceSupport getSequenceSupport()
- Overrides:
getSequenceSupport
in classDialect
-
getQuerySequencesString
public String getQuerySequencesString()
Description copied from class:Dialect
Get the select command used retrieve the names of all sequences.- Overrides:
getQuerySequencesString
in classDialect
- Returns:
- The select command; or null if sequences are not supported.
-
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)
.NOTE : I do not know the correct answer currently for databases which (1) are not part of the cruise control process or (2) do not
Dialect.supportsExpectedLobUsagePattern()
.- Overrides:
supportsLobValueChangePropagation
in classDialect
- Returns:
- True if the changes are propagated back to the database; false otherwise.
-
getSqlAstTranslatorFactory
public SqlAstTranslatorFactory getSqlAstTranslatorFactory()
Description copied from class:Dialect
Return aSqlAstTranslatorFactory
specific to this dialect. Returnnull
to use Hibernate's standard translator.- Overrides:
getSqlAstTranslatorFactory
in classDialect
- See Also:
StandardSqlAstTranslatorFactory
,JdbcEnvironment.getSqlAstTranslatorFactory()
-
getNationalizationSupport
public NationalizationSupport getNationalizationSupport()
Description copied from class:Dialect
Determines whether this database requires the use of explicit nationalized character data types.That is, whether the use of
Types.NCHAR
,Types.NVARCHAR
, andTypes.NCLOB
is required for nationalized character data (Unicode).- Overrides:
getNationalizationSupport
in classDialect
-
getMaxIdentifierLength
public int getMaxIdentifierLength()
Description copied from class:Dialect
What is the maximum identifier length supported by the dialect?- Overrides:
getMaxIdentifierLength
in classDialect
- Returns:
- The maximum length.
-
supportsStandardArrays
public boolean supportsStandardArrays()
Description copied from class:Dialect
Database has native support for SQL standard arrays which can be referred to by its base type name.Oracle doesn't allow this, but instead has support for named arrays.
- Overrides:
supportsStandardArrays
in classDialect
- Returns:
- boolean
-
supportsTemporalLiteralOffset
public boolean supportsTemporalLiteralOffset()
Description copied from class:Dialect
Whether the Dialect supports timezone offset in temporal literals.- Overrides:
supportsTemporalLiteralOffset
in classDialect
-
appendDateTimeLiteral
public void appendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, jakarta.persistence.TemporalType precision, TimeZone jdbcTimeZone)
- Overrides:
appendDateTimeLiteral
in classDialect
-
appendDateTimeLiteral
public void appendDateTimeLiteral(SqlAppender appender, Date date, jakarta.persistence.TemporalType precision, TimeZone jdbcTimeZone)
- Overrides:
appendDateTimeLiteral
in classDialect
-
appendDateTimeLiteral
public void appendDateTimeLiteral(SqlAppender appender, Calendar calendar, jakarta.persistence.TemporalType precision, TimeZone jdbcTimeZone)
- Overrides:
appendDateTimeLiteral
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(dayofweek,arg)+1))
.- Overrides:
extractPattern
in classDialect
- Parameters:
unit
- the first argument
-
translateExtractField
public String translateExtractField(TemporalUnit unit)
Description copied from class:Dialect
Return the name used to identify the given field as an argument to 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
-
getFractionalSecondPrecisionInNanos
public long getFractionalSecondPrecisionInNanos()
microsecond
is the smallest unit for aninterval
, and the highest precision for atimestamp
.- Overrides:
getFractionalSecondPrecisionInNanos
in classDialect
- Returns:
- the precision, specified as a quantity of nanoseconds
- See Also:
TemporalUnit.NATIVE
-
timestampaddPattern
public String timestampaddPattern(TemporalUnit unit, jakarta.persistence.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, jakarta.persistence.TemporalType fromTemporalType, jakarta.persistence.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
-
translateDurationField
public String translateDurationField(TemporalUnit unit)
Description copied from class:Dialect
Return the name used to identify the given unit of duration as an argument to#timestampadd()
or#timestampdiff()
, or of this dialect's equivalent functions.This method does not need to handle
TemporalUnit.NANOSECOND
,TemporalUnit.NATIVE
,TemporalUnit.OFFSET
,TemporalUnit.DAY_OF_WEEK
,TemporalUnit.DAY_OF_MONTH
,TemporalUnit.DAY_OF_YEAR
,TemporalUnit.DATE
,TemporalUnit.TIME
,TemporalUnit.TIMEZONE_HOUR
,TemporalUnit.TIMEZONE_MINUTE
,TemporalUnit.WEEK_OF_YEAR
, norTemporalUnit.WEEK_OF_MONTH
, which are not units of duration.- Overrides:
translateDurationField
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
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
-
getLimitHandler
public LimitHandler getLimitHandler()
Description copied from class:Dialect
Returns aLimitHandler
that implements support forQuery.setMaxResults(int)
andQuery.setFirstResult(int)
for this dialect.- 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(LockOptions lockOptions)
Description copied from class:Dialect
Given LockOptions (lockMode, timeout), determine the appropriate for update fragment to use.- Overrides:
getForUpdateString
in classDialect
- Parameters:
lockOptions
- contains the lock mode to apply.- Returns:
- The appropriate for update fragment.
-
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.
-
getWriteLockString
public String getWriteLockString(int timeout)
Description copied from class:Dialect
Get the string to append to SELECT statements to acquire WRITE locks for this dialect. Location of the returned string is treated the same as getForUpdateString.- Overrides:
getWriteLockString
in 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 to SELECT statements to acquire WRITE locks for this dialect given the aliases of the columns to be write locked. Location of the of the returned string is treated the same as getForUpdateString.- Overrides:
getWriteLockString
in 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 to SELECT statements to acquire READ locks for this dialect. Location of the returned string is treated the same as 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 to SELECT statements to acquire READ locks for this dialect given the aliases of the columns to be read locked. Location of the returned string is treated the same as getForUpdateString.- Overrides:
getReadLockString
in 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.
-
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.
-
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
.
-
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
-
getWriteRowLockStrategy
public RowLockStrategy getWriteRowLockStrategy()
Description copied from class:Dialect
The row lock strategy to use for write locks.- Overrides:
getWriteRowLockStrategy
in classDialect
-
getNameQualifierSupport
public NameQualifierSupport getNameQualifierSupport()
Description copied from class:Dialect
By default interpret this based on DatabaseMetaData.- Overrides:
getNameQualifierSupport
in classDialect
- Returns:
- The NameQualifierSupport.
-
buildIdentifierHelper
public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuilder builder, DatabaseMetaData dbMetaData) throws SQLException
Description copied from class:Dialect
Build the IdentifierHelper indicated by this Dialect for handling identifier conversions. Returningnull
is allowed and indicates that Hibernate should fallback 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 semi-configured IdentifierHelper builder.dbMetaData
- Access to the metadata returned from the driver if needed and if available. WARNING: may benull
- Returns:
- The IdentifierHelper instance to use, or
null
to indicate Hibernate should use its fallback path - Throws:
SQLException
- Accessing the DatabaseMetaData can throw it. Just re-throw and Hibernate will handle.- See Also:
Dialect.getNameQualifierSupport()
-
getViolatedConstraintNameExtractor
public ViolatedConstraintNameExtractor getViolatedConstraintNameExtractor()
- Specified by:
getViolatedConstraintNameExtractor
in interfaceConversionContext
- Overrides:
getViolatedConstraintNameExtractor
in classDialect
-
buildSQLExceptionConversionDelegate
public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate()
Description copied from class:Dialect
Build an instance of aSQLExceptionConversionDelegate
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 JDBC 4 defined SQLException hierarchy;
- a delegate that interprets SQLState codes for either X/Open or SQL-2003 codes, depending on java.sql.DatabaseMetaData#getSQLStateType
It is strongly recommended that specific Dialect implementations override this method, since interpretation of a SQL error is much more accurate when based on the vendor-specific ErrorCode rather than the SQLState.
Specific Dialects may override to return whatever is most appropriate for that vendor.
- Overrides:
buildSQLExceptionConversionDelegate
in classDialect
- Returns:
- The SQLExceptionConversionDelegate for this dialect
-
-