Class SpannerDialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.SpannerDialect

All Implemented Interfaces:

CheckConstraintSupport, ForeignKeySupport, IdentifierSupport, KeywordSupport, LiteralSupport, AlterTableSupport, ColumnDefinitionSupport, ConstraintControlSupport, IndexDdlSupport, TableCreationSupport, TruncateSupport, CurrentTemporalSupport, TemporalFormatSupport, TemporalOperationSupport, ConversionContext

public class SpannerDialect
extends Dialect
implements CurrentTemporalSupport, TemporalFormatSupport, TemporalOperationSupport

A SQL dialect for Cloud Spanner.

Field Summary

Fields inherited from class Dialect

LEGACY_LOB_MERGE_STRATEGY, NEW_LOCATOR_LOB_MERGE_STRATEGY, STANDARD_MULTI_KEY_LOAD_SIZING_STRATEGY, STREAM_XFER_LOB_MERGE_STRATEGY

Fields inherited from interface ConstraintControlSupport

NONE

Fields inherited from interface TruncateSupport

STANDARD

Constructor Summary

Constructors

Constructor	Description
SpannerDialect()
SpannerDialect(DialectResolutionInfo info)

Method Summary

Modifier and Type	Method	Description
void	appendBinaryLiteral(SqlAppender appender, byte[] bytes)	Append a SQL binary literal.
void	appendBooleanValueString(SqlAppender appender, boolean bool)	Append a SQL Boolean literal expression.
void	appendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone)	Append a datetime literal for a java.time value.
void	appendDateTimeLiteral(SqlAppender appender, Calendar calendar, TemporalType precision, TimeZone jdbcTimeZone)	Append a datetime literal for a Calendar value.
void	appendDateTimeLiteral(SqlAppender appender, Date date, TemporalType precision, TimeZone jdbcTimeZone)	Append a datetime literal for a legacy Date value.
void	appendDefinition(SqlAppender appender, ColumnDefinitionRequest request)
void	appendFormat(SqlAppender appender, String format)	Append the database translation of the supplied Hibernate format pattern.
void	appendLiteral(SqlAppender appender, String literal)	Append a SQL string literal.
IdentifierHelper	buildIdentifierHelper(IdentifierHelperBuildRequest request)	Build and supply the configured identifier helper from the stable JDBC metadata snapshot and selected keyword strategy.
SQLExceptionConversionDelegate	buildSQLExceptionConversionDelegate()	Supplies vendor-specific SQL-exception conversion for this Dialect.
String	castPattern(CastType from, CastType to)	Obtain a pattern for the SQL equivalent to a cast() function call.
protected String	castType(int sqlTypeCode)	Return the complete cast-target type pattern for sqlTypeCode.
boolean	causesRollback(SQLException sqlException)	Determine whether this database marks the current transaction for rollback after the given statement failure.
char	closeQuote()	Return the character which closes a quoted identifier.
protected String	columnType(int sqlTypeCode)	Return the complete database column declaration pattern for a JDBC Types or Hibernate SqlTypes code used during type registration.
protected void	contributeDefaultProperties(Properties properties)	Contribute provider configuration defaults after Dialect construction.
void	contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)	Contribute database-specific Java, JDBC, DDL, and basic type descriptors.
String	createCommand(IndexDdlRequest request)
MutationOperation	createOptionalTableUpdateOperation(OptionalTableUpdateOperationRequest request)	Creates the JDBC mutation operation for an optional-table update.
String	currentTime()	Render the current SQL time expression used for java.sql.Time.
static Replacer	datetimeFormat(String format)
ScrollMode	defaultScrollMode()	A default ScrollMode to be used by Query.scroll().
ArraySupport	getArraySupport()	The independent array syntax and multi-valued parameter-binding behavior of this Dialect.
String	getArrayTypeName(String javaElementTypeName, String elementTypeName, Integer maxLength)	Render an array type name from the independent Java element name, rendered SQL element name, and optional maximum length.
CteSupport	getCteSupport()	The common-table-expression capabilities of this Dialect.
CurrentTemporalSupport	getCurrentTemporalSupport()	Supply current temporal expressions and database-side timestamp retrieval.
CurrentTimestampSelection	getCurrentTimestampSelection()	Select the JDBC command used for database-side current timestamp retrieval, or return null when the database offers no supported command.
DirectJavaTimeJdbcSupport	getDirectJavaTimeJdbcSupport()	Supply direct JDBC access capabilities for Java Time classes.
DmlTargetColumnQualifierSupport	getDmlTargetColumnQualifierSupport()	The qualifier form accepted for target-column references in update and delete statements.
IdentityColumnSupport	getIdentityColumnSupport()	Supply the stable identity-column DDL, insert syntax, and identity-specific retrieval behavior for this Dialect.
IfExistsSupport	getIfExistsSupport()	Supply existence-check placement for schema DDL targets.
LimitHandler	getLimitHandler()	Supplies execution-time pagination for already-rendered SQL requested by Query.setMaxResults(int) or Query.setFirstResult(int).
LockingClauseStrategy	getLockingClauseStrategy(QuerySpec querySpec, LockOptions lockOptions)	Supplies the per-translation strategy for a statement-level [PessimisticLockStyle#CLAUSE locking clause].
LockingSupport	getLockingSupport()	Supplies the cohesive pessimistic-locking profile for this Dialect.
MutationSyntaxSupport	getMutationSyntaxSupport()	The native SQL mutation-syntax capabilities of this Dialect.
NamespaceSupport	getNamespaceSupport()	Supply catalog and schema lifecycle behavior to schema tooling.
GenerationType	getNativeValueGenerationStrategy()	Supply the semantic identifier-generation type used for native generation.
NullOrderingSupport	getNullOrderingSupport()	Supply the database's default null ordering and explicit null-precedence syntax capabilities.
RowValueSupport	getRowValueSupport()	The native row-value syntax of this Dialect.
SchemaNameResolver	getSchemaNameResolver()	Supply the strategy which resolves the current schema for a JDBC connection.
SequenceInformationExtractor	getSequenceInformationExtractor()	Supply the strategy Hibernate uses to discover existing database sequences and their metadata.
SequenceSupport	getSequenceSupport()	Supplies the complete sequence value-expression and lifecycle-DDL strategy for this Dialect.
String	getSetOperatorSqlString(SetOperator operator)	Get the SQL string representation for a specific set operator (UNION, INTERSECT, EXCEPT).
SingleRowTableSupport	getSingleRowTableSupport()	Supply the SQL renderings used for a reusable single-row table and for an otherwise table-less select.
SqlAstTranslatorFactory	getSqlAstTranslatorFactory()	Supply the factory for this Dialect's single-use SQL AST translators.
SubquerySupport	getSubquerySupport()	Supplies the database's supported subquery placements.
Exporter<Table>	getTableExporter()	Supply the exporter used to create and drop relational tables.
TemporalFormatSupport	getTemporalFormatSupport()	Supply datetime-format translation.
TemporalOperationSupport	getTemporalOperationSupport()	Supply extraction and timestamp-arithmetic syntax.
TemporalValueSemantics	getTemporalValueSemantics()	Supply temporal precision-adjustment and literal-offset semantics.
TupleCountSupport	getTupleCountSupport()	Supplies the database syntax for ordinary and distinct tuple counts.
TypeSizingProfile	getTypeSizingProfile()	Supplies this Dialect's resolved type-sizing limits and defaults.
UniqueDelegate	getUniqueDelegate()	Supply the stable strategy used for unique-key representation and DDL.
void	initializeFunctionRegistry(FunctionContributions functionContributions)	Contribute the database-specific function descriptors after independent function contributors have run.
IndexNameQualification	nameQualification()
char	openQuote()	Return the character which opens a quoted identifier.
protected void	registerColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)	Register the inherited ANSI-oriented DDL type descriptors during Dialect type contribution.
String	renderAddConstraint(ForeignKeyConstraintRequest request)
List<String>	renderCommands(TruncateRequest request)
JdbcType	resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry)	Resolve the non-null JDBC descriptor for result-set metadata.
boolean	supports(CheckConstraintPlacement placement)
String	timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType)	Return a timestamp-add pattern containing ?1, ?2, and ?3.
String	timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalType, TemporalType toTemporalType)	Return a timestamp-difference pattern containing ?1, ?2, and ?3.
String	translateExtractField(TemporalUnit unit)	Translate an extraction field name.
String	trimPattern(TrimSpec specification, boolean isWhitespace)	Obtain a pattern for the SQL equivalent to a trim() function call.
boolean	useIntegerForPrimaryKey()

Methods inherited from class Dialect

addPartitionKeyToPrimaryKey, appendArrayLiteral, augmentPhysicalTableTypes, augmentRecognizedTableTypes, buildLockingClauseStrategy, buildStringToBooleanCast, buildStringToBooleanCastDecode, constraintControlMode, contributeKeywords, determineDatabaseVersion, equivalentTypes, getAggregateSupport, getAlterTableSupport, getBatchLoadSizingStrategy, getCallableStatementSupport, getCatalogSeparator, getCheckConstraintSupport, getColumnAliasExtractor, getColumnDefinitionSupport, getConstraintControlSupport, getDefaultOrdinalityColumnName, getDefaultProperties, getEntityLockingStrategyFactory, getEnumSupport, getExpressionCoercionSupport, getFetchClauseSupport, getForeignKeyExporter, getForeignKeySupport, getFunctionalDependencyAnalysisSupport, getGeneratedValuesSupport, getGlobalTemporaryTableStrategy, getIdentifierSupport, getIndexDdlSupport, getIndexExporter, getInformationExtractor, getJdbcMetadataOverrides, getKeywords, getKeywordSupport, getLiteralSupport, getLobMergeStrategy, getLobSupport, getLocalTemporaryTableStrategy, getLowercaseFunction, getMinimumSupportedVersion, getMultiKeyLoadSizingStrategy, getMultiTableMutationSupport, getNameQualifierSupport, getNationalizationSupport, getNativeParameterMarkerStrategy, getObjectNullBindingStrategy, getParameterLimits, getPersistentTemporaryTableStrategy, getPredicateSupport, getPreferredSqlTypeCodeForArray, getPreferredSqlTypeCodeForBoolean, getQueryHintPlacement, getQueryHintString, getQueryHintString, getRefCursorSupportFactory, getRowIdSupport, getRowLevelSecurity, getSchemaCommentSupport, getSchemaDropSupport, getSelectClauseNullString, getSequenceExporter, getSetOperationSupport, getSizeStrategy, getStringValueSemantics, getSyntheticTableGroupSupport, getTableCleaner, getTableCreationSupport, getTableMigrator, getTemporalTableSupport, getTemporaryTableExporter, getTimeZoneSupport, getTruncateSupport, getUserDefinedTypeExporter, getValuesListSupport, getVersion, getViolatedConstraintNameExtractor, getWindowFunctionSupport, isJdbcLogWarningsEnabledByDefault, narrowCastType, resolveSqlTypeCode, resolveSqlTypeCode, resolveSqlTypeLength, supportsCrossJoin, supportsFilterClause, supportsNationalizedMethods, supportsOrdinalSelectItemReference, supportsUserDefinedTypes, throttleDdl, toString, truncateMode

Methods inherited from class Object

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

Methods inherited from interface AlterTableSupport

addColumnPrefix, addColumnSuffix, alterColumnType, alterTableCommand

Methods inherited from interface CheckConstraintSupport

render

Methods inherited from interface ConstraintControlSupport

disableCommands, disableConstraintCommands, enableCommands, enableConstraintCommands

Methods inherited from interface CurrentTemporalSupport

currentDate, currentLocalTime, currentLocalTimestamp, currentTimestamp, currentTimestampWithTimeZone, isCurrentTimestampStable, usesStandardCurrentTimestampFunction

Methods inherited from interface ForeignKeySupport

renderDropConstraint, requiresSelfReferentialForeignKeyNullification, supportsAlterTableConstraints, supportsOnDeleteAction

Methods inherited from interface IdentifierSupport

getMaxAliasLength, getMaxIdentifierLength, quote, quoteCollation, toQuotedIdentifier

Methods inherited from interface IndexDdlSupport

createTail

Methods inherited from interface KeywordSupport

acceptsJdbcKeyword

Methods inherited from interface LiteralSupport

appendIntervalLiteral, appendIntervalLiteral, appendUUIDLiteral, toBooleanValueString

Methods inherited from interface TableCreationSupport

createTableCommand, requiresViewColumnList, tableCreationOptions

Methods inherited from interface TemporalOperationSupport

extractPattern, fractionalSecondPrecisionInNanos, translateDurationField

Constructor Details

SpannerDialect

public SpannerDialect()

SpannerDialect

public SpannerDialect(DialectResolutionInfo info)

Method Details

getTemporalOperationSupport

@SPI({IMPLEMENT,SUPPLY})
public TemporalOperationSupport getTemporalOperationSupport()

Description copied from class: Dialect

Supply extraction and timestamp-arithmetic syntax. Return one stable, non-null, thread-safe implementation. Providers may implement TemporalOperationSupport directly and return this.

Overrides:

getTemporalOperationSupport in class Dialect

See Also:

• TemporalOperationSupport

getTemporalFormatSupport

@SPI({IMPLEMENT,SUPPLY})
public TemporalFormatSupport getTemporalFormatSupport()

Description copied from class: Dialect

Supply datetime-format translation. Return one stable, non-null, thread-safe implementation.

Overrides:

getTemporalFormatSupport in class Dialect

See Also:

• TemporalFormatSupport

getCurrentTemporalSupport

@SPI({IMPLEMENT,SUPPLY})
public CurrentTemporalSupport getCurrentTemporalSupport()

Description copied from class: Dialect

Supply current temporal expressions and database-side timestamp retrieval. Return one stable, non-null, thread-safe implementation. Providers may implement CurrentTemporalSupport directly and return this.

Overrides:

getCurrentTemporalSupport in class Dialect

See Also:

• CurrentTemporalSupport

getTypeSizingProfile

public TypeSizingProfile getTypeSizingProfile()

Description copied from class: Dialect

Supplies this Dialect's resolved type-sizing limits and defaults.

Return TypeSizingProfile.STANDARD when no dimension differs. Construct one stable immutable profile after version and server configuration are known. A family Dialect may copy its superclass profile, but must set every effective dimension which formerly changed through scalar-method delegation because profile builder setters do not cascade.

Overrides:

getTypeSizingProfile in class Dialect

useIntegerForPrimaryKey

public boolean useIntegerForPrimaryKey()

getDirectJavaTimeJdbcSupport

public DirectJavaTimeJdbcSupport getDirectJavaTimeJdbcSupport()

Description copied from class: Dialect

Supply direct JDBC access capabilities for Java Time classes. Return one stable, non-null, thread-safe implementation.

Overrides:

getDirectJavaTimeJdbcSupport in class Dialect

Returns:

the direct Java Time JDBC support for this Dialect and driver

See Also:

• DirectJavaTimeJdbcSupport

contributeTypes

@SPI({IMPLEMENT,SUPPLY})
public void contributeTypes(TypeContributions typeContributions,
 ServiceRegistry serviceRegistry)

Description copied from class: Dialect

Contribute database-specific Java, JDBC, DDL, and basic type descriptors.

Override this method when the database or JDBC driver requires descriptors beyond the inherited registrations. Invoke super first unless the Dialect intentionally replaces the complete inherited contribution protocol. Obtain reusable dialect-specific JDBC descriptors from the family facades in org.hibernate.dialect.type.spi, and preserve whether a descriptor replaces an existing registration or is added only when absent.

Overrides:

contributeTypes in class Dialect

Parameters:

typeContributions - the Hibernate-supplied contribution registry

serviceRegistry -

the Hibernate-supplied services, including class loading used by driver-backed descriptor factories

Mutate the supplied boot-scoped registries only during this callback and do not retain the contribution context or a mutable registry afterward. Implement an independent TypeContributor instead when the contribution is not owned by a Dialect.

createOptionalTableUpdateOperation

@SPI({USE,IMPLEMENT,SUPPLY})
public MutationOperation createOptionalTableUpdateOperation(OptionalTableUpdateOperationRequest request)

Description copied from class: Dialect

Creates the JDBC mutation operation for an optional-table update.

Override this factory when the database needs an operation other than the standard update-then-insert behavior. The request contains the semantic update and bootstrap services; implementations must return an operation for the same OptionalTableUpdateOperationRequest.mutationTarget() and must not retain the request.

Overrides:

createOptionalTableUpdateOperation in class Dialect

Returns:

a non-null operation for the supplied optional-table update

See Also:

• OptionalTableUpdateOperationRequest
• MutationOperation

contributeDefaultProperties

@SPI({IMPLEMENT,SUPPLY})
protected void contributeDefaultProperties(Properties properties)

Description copied from class: Dialect

Contribute provider configuration defaults after Dialect construction.

Invoke super first to extend the inherited defaults. Omitting super deliberately replaces them. Mutate the supplied isolated property bag only during this callback; do not retain it or call Dialect.getDefaultProperties() from a Dialect constructor.

Overrides:

contributeDefaultProperties in class Dialect

Parameters:

properties - the isolated contribution target

resolveSqlTypeDescriptor

@SPI({USE,IMPLEMENT})
public JdbcType resolveSqlTypeDescriptor(String columnTypeName,
 int jdbcTypeCode,
 int precision,
 int scale,
 JdbcTypeRegistry jdbcTypeRegistry)

Description copied from class: Dialect

Resolve the non-null JDBC descriptor for result-set metadata.

Preserve vendor replacement and array-component resolution, and delegate unmatched codes to jdbcTypeRegistry.

Overrides:

resolveSqlTypeDescriptor in class Dialect

registerColumnTypes

@SPI({IMPLEMENT,SUPPLY})
protected void registerColumnTypes(TypeContributions typeContributions,
 ServiceRegistry serviceRegistry)

Description copied from class: Dialect

Register the inherited ANSI-oriented DDL type descriptors during Dialect type contribution.

Override this focused sub-hook to extend or replace column type registrations. Invoke super first to retain the inherited descriptor set; omitting it deliberately replaces that set. Mutate the supplied boot-scoped registry only during this callback, and do not retain the contribution context or registry afterward. Implement an independent TypeContributor instead when the contribution is not owned by a Dialect.

Overrides:

registerColumnTypes in class Dialect

Parameters:

typeContributions - the Hibernate-supplied contribution target

serviceRegistry - the Hibernate-supplied bootstrap services

See Also:

• Dialect.contributeTypes(TypeContributions, ServiceRegistry)
• Dialect.getTypeSizingProfile()

columnType

@SPI({USE,IMPLEMENT})
protected String columnType(int sqlTypeCode)

Description copied from class: Dialect

Return the complete database column declaration pattern for a JDBC Types or Hibernate SqlTypes code used during type registration.

Use only $l, $p, and $s for length, precision, and scale. Define distinct mappings for the LONG32 codes; the JDBC LONG synonyms are normalized before this hook. Delegate unknown inherited codes to the superclass so its standard exception remains authoritative.

Overrides:

columnType in class Dialect

castPattern

@SPI({USE,IMPLEMENT})
public String castPattern(CastType from,
 CastType to)

Description copied from class: Dialect

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

Overrides:

castPattern in class Dialect

Parameters:

from - a CastType indicating the type of the value argument

to - a CastType indicating the type the value argument is cast to

castType

@SPI({USE,IMPLEMENT})
protected String castType(int sqlTypeCode)

Description copied from class: Dialect

Return the complete cast-target type pattern for sqlTypeCode.

Override this hook when cast syntax differs from column declaration syntax; otherwise delegate to Dialect.columnType(int).

Overrides:

castType in class Dialect

getArraySupport

public ArraySupport getArraySupport()

Description copied from class: Dialect

The independent array syntax and multi-valued parameter-binding behavior of this Dialect.

Override this method to supply standard element-type array support, SQL array-constructor support, and the multi-valued parameter-binding strategy. Treat these as independent dimensions: do not infer syntax support from array binding, and do not infer array binding from either syntax capability. Return one immutable, non-null profile whose values remain stable for the lifetime of this Dialect.

Overrides:

getArraySupport in class Dialect

Returns:

this Dialect's stable array-support profile

getArrayTypeName

@SPI({USE,IMPLEMENT})
public String getArrayTypeName(String javaElementTypeName,
 String elementTypeName,
 Integer maxLength)

Description copied from class: Dialect

Render an array type name from the independent Java element name, rendered SQL element name, and optional maximum length.

Return null when array types are unsupported. The standard forms are element array and element array[length].

Overrides:

getArrayTypeName in class Dialect

initializeFunctionRegistry

@SPI({IMPLEMENT,SUPPLY})
public void initializeFunctionRegistry(FunctionContributions functionContributions)

Description copied from class: Dialect

Contribute the database-specific function descriptors after independent function contributors have run.

Override this callback to extend or replace the inherited function set. Invoke super first to retain Hibernate's standard and emulated registrations; omitting it deliberately replaces that set. Mutate the supplied boot-scoped function registry only during this callback, and do not retain the contribution context or registry afterward. Implement an independent FunctionContributor instead when the contribution is not owned by a Dialect.

Overrides:

initializeFunctionRegistry in class Dialect

Parameters:

functionContributions - the Hibernate-supplied function contribution target

See Also:

• FunctionContributions
• FunctionContributor
• SqmFunctionRegistry
• SqmFunctionDescriptor
• CommonFunctionFactory

getSqlAstTranslatorFactory

@SPI({IMPLEMENT,SUPPLY})
public SqlAstTranslatorFactory getSqlAstTranslatorFactory()

Description copied from class: Dialect

Supply the factory for this Dialect's single-use SQL AST translators.

Return null to use StandardSqlAstTranslatorFactory. A custom Dialect should normally return a reusable factory derived from that class and create translators derived from AbstractSqlAstTranslator or an appropriate supported family base. The factory must not retain translation requests, and every translator it returns is used for one translation.

Overrides:

getSqlAstTranslatorFactory in class Dialect

See Also:

• SqlAstTranslatorFactory
• JdbcEnvironment.getSqlAstTranslatorFactory()

getIfExistsSupport

@SPI({IMPLEMENT,SUPPLY})
public IfExistsSupport getIfExistsSupport()

Description copied from class: Dialect

Supply existence-check placement for schema DDL targets.

Return one immutable profile for this Dialect's lifetime.

Overrides:

getIfExistsSupport in class Dialect

See Also:

• IfExistsSupport

getCurrentTimestampSelection

@SPI({USE,IMPLEMENT})
public CurrentTimestampSelection getCurrentTimestampSelection()

Description copied from interface: CurrentTemporalSupport

Select the JDBC command used for database-side current timestamp retrieval, or return null when the database offers no supported command.

Specified by:

getCurrentTimestampSelection in interface CurrentTemporalSupport

See Also:

• CurrentTimestampSelection

appendBooleanValueString

@SPI({USE,IMPLEMENT})
public void appendBooleanValueString(SqlAppender appender,
 boolean bool)

Description copied from interface: LiteralSupport

Append a SQL Boolean literal expression.

Specified by:

appendBooleanValueString in interface LiteralSupport

appendBinaryLiteral

@SPI({USE,IMPLEMENT})
public void appendBinaryLiteral(SqlAppender appender,
 byte[] bytes)

Description copied from interface: LiteralSupport

Append a SQL binary literal.

Specified by:

appendBinaryLiteral in interface LiteralSupport

appendLiteral

@SPI({USE,IMPLEMENT})
public void appendLiteral(SqlAppender appender,
 String literal)

Description copied from interface: LiteralSupport

Append a SQL string literal.

Specified by:

appendLiteral in interface LiteralSupport

currentTime

@SPI({USE,IMPLEMENT})
public String currentTime()

Description copied from interface: CurrentTemporalSupport

Render the current SQL time expression used for java.sql.Time.

Specified by:

currentTime in interface CurrentTemporalSupport

getTemporalValueSemantics

@SPI({IMPLEMENT,SUPPLY})
public TemporalValueSemantics getTemporalValueSemantics()

Description copied from class: Dialect

Supply temporal precision-adjustment and literal-offset semantics. Return one stable, non-null immutable profile.

Overrides:

getTemporalValueSemantics in class Dialect

See Also:

• TemporalValueSemantics

appendDateTimeLiteral

@SPI({USE,IMPLEMENT})
public void appendDateTimeLiteral(SqlAppender appender,
 TemporalAccessor temporalAccessor,
 TemporalType precision,
 TimeZone jdbcTimeZone)

Description copied from class: Dialect

Append a datetime literal for a java.time value.

Preserve the value's offset only when the Dialect's temporal-value semantics permit it. Append immediately and retain no invocation state.

Specified by:

appendDateTimeLiteral in interface LiteralSupport

Overrides:

appendDateTimeLiteral in class Dialect

appendDateTimeLiteral

@SPI({USE,IMPLEMENT})
public void appendDateTimeLiteral(SqlAppender appender,
 Date date,
 TemporalType precision,
 TimeZone jdbcTimeZone)

Description copied from class: Dialect

Append a datetime literal for a legacy Date value.

Apply the supplied JDBC time zone where required, append immediately, and retain no invocation state.

Specified by:

appendDateTimeLiteral in interface LiteralSupport

Overrides:

appendDateTimeLiteral in class Dialect

appendDateTimeLiteral

@SPI({USE,IMPLEMENT})
public void appendDateTimeLiteral(SqlAppender appender,
 Calendar calendar,
 TemporalType precision,
 TimeZone jdbcTimeZone)

Description copied from class: Dialect

Append a datetime literal for a Calendar value.

Preserve Calendar-specific time-zone and millisecond semantics, append immediately, and retain no invocation state.

Specified by:

appendDateTimeLiteral in interface LiteralSupport

Overrides:

appendDateTimeLiteral in class Dialect

translateExtractField

@SPI({USE,IMPLEMENT})
public String translateExtractField(TemporalUnit unit)

Description copied from interface: TemporalOperationSupport

Translate an extraction field name.

Specified by:

translateExtractField in interface TemporalOperationSupport

timestampaddPattern

@SPI({USE,IMPLEMENT})
public String timestampaddPattern(TemporalUnit unit,
 TemporalType temporalType,
 IntervalType intervalType)

Description copied from interface: TemporalOperationSupport

Return a timestamp-add pattern containing ?1, ?2, and ?3.

Specified by:

timestampaddPattern in interface TemporalOperationSupport

timestampdiffPattern

@SPI({USE,IMPLEMENT})
public String timestampdiffPattern(TemporalUnit unit,
 TemporalType fromTemporalType,
 TemporalType toTemporalType)

Description copied from interface: TemporalOperationSupport

Return a timestamp-difference pattern containing ?1, ?2, and ?3.

Specified by:

timestampdiffPattern in interface TemporalOperationSupport

appendFormat

@SPI({USE,IMPLEMENT})
public void appendFormat(SqlAppender appender,
 String format)

Description copied from interface: TemporalFormatSupport

Append the database translation of the supplied Hibernate format pattern.

Specified by:

appendFormat in interface TemporalFormatSupport

datetimeFormat

public static Replacer datetimeFormat(String format)

trimPattern

@SPI({USE,IMPLEMENT})
public String trimPattern(TrimSpec specification,
 boolean isWhitespace)

Description copied from class: Dialect

Obtain a pattern for the SQL equivalent to a trim() function call. The resulting pattern must contain a ?1 placeholder for the argument of type String and a ?2 placeholder for the trim character if isWhitespace was false.

Overrides:

trimPattern in class Dialect

Parameters:

specification - leading, trailing, or both

isWhitespace - true if trimming whitespace, and the ?2 placeholder for the trim character should be omitted, false if the trim character is explicit and the ?2 placeholder must be included in the pattern

getTableExporter

public Exporter<Table> getTableExporter()

Description copied from class: Dialect

Supply the exporter used to create and drop relational tables.

Return one stable exporter owned by this Dialect. Prefer StandardTableExporter when only its focused table-DDL template hooks are needed.

Overrides:

getTableExporter in class Dialect

supports

@SPI({USE,IMPLEMENT})
public boolean supports(CheckConstraintPlacement placement)

Specified by:

supports in interface CheckConstraintSupport

createCommand

@SPI({USE,IMPLEMENT})
public String createCommand(IndexDdlRequest request)

Specified by:

createCommand in interface IndexDdlSupport

getUniqueDelegate

@SPI({IMPLEMENT,SUPPLY})
public UniqueDelegate getUniqueDelegate()

Description copied from class: Dialect

Supply the stable strategy used for unique-key representation and DDL.

Return a stock profile from UniqueDelegates, or a stable provider-owned implementation or decorator. Do not import a Hibernate .internal leaf.

Overrides:

getUniqueDelegate in class Dialect

See Also:

• UniqueDelegate

renderAddConstraint

@SPI({USE,IMPLEMENT})
public String renderAddConstraint(ForeignKeyConstraintRequest request)

Specified by:

renderAddConstraint in interface ForeignKeySupport

appendDefinition

@SPI({USE,IMPLEMENT})
public void appendDefinition(SqlAppender appender,
 ColumnDefinitionRequest request)

Specified by:

appendDefinition in interface ColumnDefinitionSupport

getIdentityColumnSupport

public IdentityColumnSupport getIdentityColumnSupport()

Description copied from class: Dialect

Supply the stable identity-column DDL, insert syntax, and identity-specific retrieval behavior for this Dialect.

Override this method to supply a provider implementation of IdentityColumnSupport. Prefer extending IdentityColumnSupportBase and return the same immutable or otherwise stable support instance on every invocation. Do not construct Hibernate mutation delegates in this supply point.

Overrides:

getIdentityColumnSupport in class Dialect

getSequenceSupport

@SPI({IMPLEMENT,SUPPLY})
public SequenceSupport getSequenceSupport()

Description copied from class: Dialect

Supplies the complete sequence value-expression and lifecycle-DDL strategy for this Dialect.

Return the same stable, thread-safe strategy for the Dialect's lifetime. Use SequenceSupports.none() when sequences are unsupported, select one of the other stock strategies only when its complete grammar matches the database, or supply a provider implementation of SequenceSupport.

Overrides:

getSequenceSupport in class Dialect

Returns:

the non-null sequence-support strategy

See Also:

• SequenceSupport

getSequenceInformationExtractor

public SequenceInformationExtractor getSequenceInformationExtractor()

Description copied from class: Dialect

Supply the strategy Hibernate uses to discover existing database sequences and their metadata.

Return SequenceInformationExtractors.none() when the database version does not expose sequence metadata. Configure ordinary single-query extraction with SequenceInformationExtractors.builder(String), and implement SequenceInformationExtractor directly only for a genuinely multi-stage algorithm.

Overrides:

getSequenceInformationExtractor in class Dialect

See Also:

• SequenceInformationExtractor
• SequenceInformationExtractors

getNativeValueGenerationStrategy

public GenerationType getNativeValueGenerationStrategy()

Description copied from class: Dialect

Supply the semantic identifier-generation type used for native generation.

Return a non-null typed value instead of a legacy generator name or implementation class. The inherited implementation selects GenerationType.IDENTITY when this Dialect's IdentityColumnSupport supports identity columns and GenerationType.SEQUENCE otherwise. Override it when the database's native choice differs from that rule.

Legacy "native" mappings and NativeGenerator consume this same provider decision.

Overrides:

getNativeValueGenerationStrategy in class Dialect

Returns:

the non-null semantic native identifier-generation type

See Also:

• NativeGenerator

getNamespaceSupport

@SPI({IMPLEMENT,SUPPLY})
public NamespaceSupport getNamespaceSupport()

Description copied from class: Dialect

Supply catalog and schema lifecycle behavior to schema tooling.

Return one stable, non-null strategy. Prefer a complete immutable profile from NamespaceSupports, and implement NamespaceSupport directly only for custom or multi-command namespace SQL.

Overrides:

getNamespaceSupport in class Dialect

See Also:

• NamespaceSupport

getSchemaNameResolver

@SPI({IMPLEMENT,SUPPLY})
public SchemaNameResolver getSchemaNameResolver()

Description copied from class: Dialect

Supply the strategy which resolves the current schema for a JDBC connection.

Return a stable, non-null resolver. Use the default resolver unless the driver cannot implement Connection.getSchema() correctly.

Overrides:

getSchemaNameResolver in class Dialect

See Also:

• SchemaNameResolver

nameQualification

@SPI({USE,IMPLEMENT})
public IndexNameQualification nameQualification()

Specified by:

nameQualification in interface IndexDdlSupport

getLockingSupport

public LockingSupport getLockingSupport()

Description copied from class: Dialect

Supplies the cohesive pessimistic-locking profile for this Dialect.

The profile coordinates capability metadata, statement-clause rendering, table hints, already-rendered SQL rewriting, connection timeout handling, and follow-on locking. A custom Dialect should supply one internally consistent profile instead of overriding those behaviors independently. The returned support must be non-null and stable for the Dialect lifetime; its components may be reused concurrently and must not retain per-query requests.

Overrides:

getLockingSupport in class Dialect

See Also:

• LockingSupport

getLockingClauseStrategy

public LockingClauseStrategy getLockingClauseStrategy(QuerySpec querySpec,
 LockOptions lockOptions)

Description copied from class: Dialect

Supplies the per-translation strategy for a statement-level [PessimisticLockStyle#CLAUSE locking clause].

Overrides:

getLockingClauseStrategy in class Dialect

See Also:

• LockingClauseStrategy

getSubquerySupport

public SubquerySupport getSubquerySupport()

Description copied from class: Dialect

Supplies the database's supported subquery placements.

Return one non-null, immutable profile whose values remain stable for this Dialect's lifetime. Declare every placement independently. In particular, scalar subqueries in the select list and exists predicates in the select list are separate capabilities. Lateral spelling and fallback rendering remain translator responsibilities. When refining a family Dialect, start from SubquerySupport.builder(super.getSubquerySupport()) and change only the differing placements.

Overrides:

getSubquerySupport in class Dialect

Returns:

this Dialect's stable subquery-support profile

openQuote

@SPI({USE,IMPLEMENT})
public char openQuote()

Description copied from interface: IdentifierSupport

Return the character which opens a quoted identifier.

Specified by:

openQuote in interface IdentifierSupport

closeQuote

@SPI({USE,IMPLEMENT})
public char closeQuote()

Description copied from interface: IdentifierSupport

Return the character which closes a quoted identifier.

Specified by:

closeQuote in interface IdentifierSupport

getLimitHandler

public LimitHandler getLimitHandler()

Description copied from class: Dialect

Supplies execution-time pagination for already-rendered SQL requested by Query.setMaxResults(int) or Query.setFirstResult(int).

This is distinct from SQL AST PaginationRenderingSupport, which handles offset and fetch clauses represented in the semantic tree. A custom Dialect should normally return a stock LimitHandler or extend a supported handler family. The returned handler may be reused concurrently and must not retain per-query state.

Overrides:

getLimitHandler in class Dialect

Returns:

a non-null handler

getRowValueSupport

public RowValueSupport getRowValueSupport()

Description copied from class: Dialect

The native row-value syntax of this Dialect.

Override this method to supply explicit row(a, b) construction, row equality, ordering, and distinctness comparisons, row-valued IN lists, row-valued IN subqueries, and quantified row comparisons. Treat each feature as an exact native-syntax declaration: do not infer IN-subquery support from IN-list support or explicit row construction from comparison support. Copy the superclass profile when refining an inherited Dialect family. Return one immutable, non-null profile whose values remain stable for the lifetime of this Dialect.

Overrides:

getRowValueSupport in class Dialect

Returns:

this Dialect's stable row-value-support profile

getDmlTargetColumnQualifierSupport

@SPI({USE,IMPLEMENT,SUPPLY})
public DmlTargetColumnQualifierSupport getDmlTargetColumnQualifierSupport()

Description copied from class: Dialect

The qualifier form accepted for target-column references in update and delete statements.

Translators use this value when rendering assignments and predicates. A custom Dialect should return the least permissive form required by the database, not a form used only by an emulation.

Overrides:

getDmlTargetColumnQualifierSupport in class Dialect

Returns:

the non-null target-column qualifier support

See Also:

• DmlTargetColumnQualifierSupport

buildIdentifierHelper

@SPI({USE,IMPLEMENT,SUPPLY})
public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuildRequest request)

Description copied from interface: IdentifierSupport

Build and supply the configured identifier helper from the stable JDBC metadata snapshot and selected keyword strategy.

This inherited implementation initializes identifier casing, keywords, and namespace support from the request. Invoke it before replacing any of those values with authoritative provider settings, then build the final helper from the same builder. Settings which this implementation does not initialize may be applied before invoking it. If builder configuration cannot express a database rule, decorate the final helper with DelegatingIdentifierHelper. Do not retain the request, builder, or metadata view.

Specified by:

buildIdentifierHelper in interface IdentifierSupport

See Also:

• IdentifierHelper

defaultScrollMode

@SPI({USE,IMPLEMENT,SUPPLY})
public ScrollMode defaultScrollMode()

Description copied from class: Dialect

A default ScrollMode to be used by Query.scroll().

Overrides:

defaultScrollMode in class Dialect

Returns:

the default ScrollMode to use.

renderCommands

@SPI({USE,IMPLEMENT})
public List<String> renderCommands(TruncateRequest request)

Specified by:

renderCommands in interface TruncateSupport

getSetOperatorSqlString

@SPI({USE,IMPLEMENT})
public String getSetOperatorSqlString(SetOperator operator)

Description copied from class: Dialect

Get the SQL string representation for a specific set operator (UNION, INTERSECT, EXCEPT).

The default implementation delegates to SetOperator.sqlString(). Dialects like Cloud Spanner that require explicit 'DISTINCT' keywords can override this.

Overrides:

getSetOperatorSqlString in class Dialect

Parameters:

operator - The set operator

Returns:

The SQL fragment (e.g., "union", "union all", "union distinct")

getSingleRowTableSupport

public SingleRowTableSupport getSingleRowTableSupport()

Description copied from class: Dialect

Supply the SQL renderings used for a reusable single-row table and for an otherwise table-less select.

Override this method with one stable, non-null profile when either rendering differs from SingleRowTableSupport.STANDARD. The table expression and the complete select-only from fragment are independent; an empty fragment means that no from clause is required. Dialect subclasses refining a family profile should copy Dialect.getSingleRowTableSupport() from the superclass and change only the values which differ.

Overrides:

getSingleRowTableSupport in class Dialect

Returns:

the stable, non-null single-row-table-support profile

getNullOrderingSupport

public NullOrderingSupport getNullOrderingSupport()

Description copied from class: Dialect

Supply the database's default null ordering and explicit null-precedence syntax capabilities.

Override this method with a stable, non-null profile when the database's default null placement differs from NullOrderingSupport.STANDARD, or when it cannot render nulls first and nulls last natively. Dialect subclasses refining a family profile should copy Dialect.getNullOrderingSupport() from the superclass and change only the values which differ.

Overrides:

getNullOrderingSupport in class Dialect

Returns:

the stable, non-null null-ordering-support profile

getCteSupport

public CteSupport getCteSupport()

Description copied from class: Dialect

The common-table-expression capabilities of this Dialect.

The returned immutable profile must be non-null and stable for the lifetime of this Dialect. Hibernate may cache and reuse it. Overrides may construct a new profile or copy CteSupport.STANDARD; invoking super is not required. This method is called only after Dialect construction, has no corresponding shutdown lifecycle, and failures propagate to the operation which obtains the profile.

Overrides:

getCteSupport in class Dialect

getMutationSyntaxSupport

public MutationSyntaxSupport getMutationSyntaxSupport()

Description copied from class: Dialect

The native SQL mutation-syntax capabilities of this Dialect.

The returned immutable profile must be non-null and stable for the lifetime of this Dialect. Report syntax which the translator may use directly; do not report a capability merely because it can be emulated. QueryMutationRenderingSupport consumes this profile when selecting a native or emulated plan.

Overrides:

getMutationSyntaxSupport in class Dialect

getTupleCountSupport

public TupleCountSupport getTupleCountSupport()

Description copied from class: Dialect

Supplies the database syntax for ordinary and distinct tuple counts.

Return one non-null, immutable profile whose values remain stable for this Dialect's lifetime. Select TupleCountSupport.Syntax.UNSUPPORTED to use Hibernate's existing emulation, TupleCountSupport.Syntax.ARGUMENT_LIST for syntax such as count(a, b), or TupleCountSupport.Syntax.PARENTHESIZED_TUPLE for syntax such as count((a, b)). Configure the ordinary and distinct forms independently; a database may require different forms for them. When refining a family Dialect, copy Dialect.getTupleCountSupport() from the superclass and replace only the differing syntax choice.

Overrides:

getTupleCountSupport in class Dialect

Returns:

the non-null tuple-count-syntax profile

causesRollback

public boolean causesRollback(SQLException sqlException)

Description copied from class: Dialect

Determine whether this database marks the current transaction for rollback after the given statement failure.

Inspect the original database exception when the policy depends on its error code, SQL state, or subtype. This decision is independent of how Hibernate converts the exception. This determines both JDBC rollback state and whether a pessimistic lock failure becomes a JPA PessimisticLockException or LockTimeoutException.

Overrides:

causesRollback in class Dialect

Parameters:

sqlException - the original database exception

Returns:

true when the failed statement invalidates the transaction

buildSQLExceptionConversionDelegate

@SPI({IMPLEMENT,SUPPLY})
public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate()

Description copied from class: Dialect

Supplies vendor-specific SQL-exception conversion for this Dialect.

The returned delegate runs in addition to Hibernate's standard JDBC exception-hierarchy and SQL-state delegates. Its null result means that it declined the exception so conversion may continue. Return null from this method when the Dialect has no vendor-specific delegate.

Prefer stable vendor error codes or SQL states and preserve the original SQLException.

Overrides:

buildSQLExceptionConversionDelegate in class Dialect

Returns:

the vendor conversion delegate, or null when none is supplied

See Also:

• SQLExceptionConversionDelegate