Class SQLServerDialect
- All Implemented Interfaces:
CheckConstraintSupport, ForeignKeySupport, IdentifierSupport, KeywordSupport, LiteralSupport, AlterTableSupport, ColumnDefinitionSupport, ConstraintControlSupport, IndexDdlSupport, TableCreationSupport, TruncateSupport, CurrentTemporalSupport, TemporalFormatSupport, TemporalOperationSupport, ConversionContext
- Direct Known Subclasses:
AzureSQLServerDialect, SqlServerSpatialDialect
This dialect does not support SQL Server's SNAPSHOT isolation level.
Please refer to the SQL Server documentation.
-
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_STRATEGYFields inherited from interface ConstraintControlSupport
NONEFields inherited from interface TruncateSupport
STANDARD -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanWhether every table partition key must also occur in its primary key.alterColumnType(AlterColumnTypeRequest request) voidappendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone) Append a datetime literal for ajava.timevalue.voidappendDateTimeLiteral(SqlAppender appender, Calendar calendar, TemporalType precision, TimeZone jdbcTimeZone) Append a datetime literal for aCalendarvalue.voidappendDateTimeLiteral(SqlAppender appender, Date date, TemporalType precision, TimeZone jdbcTimeZone) Append a datetime literal for a legacyDatevalue.voidappendDefinition(SqlAppender appender, ColumnDefinitionRequest request) voidappendFormat(SqlAppender appender, String format) Append the database translation of the supplied Hibernate format pattern.voidappendUUIDLiteral(SqlAppender appender, UUID literal) Append a SQL UUID literal expression.Build and supply the configured identifier helper from the stable JDBC metadata snapshot and selected keyword strategy.Supplies vendor-specific SQL-exception conversion for this Dialect.castPattern(CastType from, CastType to) Obtain a pattern for the SQL equivalent to acast()function call.protected StringcastType(int sqlTypeCode) Return the complete cast-target type pattern forsqlTypeCode.booleancausesRollback(SQLException sqlException) Determine whether this database marks the current transaction for rollback after the given statement failure.charReturn the character which closes a quoted identifier.protected StringcolumnType(int sqlTypeCode) protected voidcontributeKeywords(KeywordRegistration registration) Contribute ANSI and database-specific SQL keywords.voidcontributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry) Contribute database-specific Java, JDBC, DDL, and basic type descriptors.createCommand(IndexDdlRequest request) Creates the JDBC mutation operation for an optional-table update.createTail(IndexDdlRequest request) Render the current SQL date expression.Render the current SQL time expression used forjava.sql.Time.Render the current SQL timestamp expression used forjava.sql.Timestamp.Render the current timestamp-with-time-zone expression.static ReplacerdatetimeFormat(String format) Determine the database version, as precise as possible and using Dialect-specific techniques, from aDialectResolutionInfoobject.extractPattern(TemporalUnit unit) Return an extraction pattern containing?1for the field and?2for the value.longEven though SQL Server only supports 1/10th microsecond precision, we use nanosecond as the "native" precision for datetime arithmetic since it simplifies calculations.Supply the aggregate-column mapping, DDL, read, assignment, and write behavior for this dialect.Supply the callable-statement protocol for this database and JDBC driver.The common-table-expression capabilities of this Dialect.Supply current temporal expressions and database-side timestamp retrieval.The current_timestamp is more accurate, but only known to be supported in SQL Server 7.0 and later and Sybase not known to support it at allThe qualifier form accepted for target-column references in update and delete statements.Supply thefetchclause forms accepted by this database.Supply the common Transact-SQL identity profile.Supply existence-check placement for schema DDL targets.Supplies execution-time pagination for already-rendered SQL requested byQuery.setMaxResults(int)orQuery.setFirstResult(int).Supplies this Dialect's local temporary-table strategy.Supplies the cohesive pessimistic-locking profile for this Dialect.intReturn the database's maximum identifier length.protected intSQL Server doesn't support thegenerate_seriesfunction orlateralrecursive CTEs, so it has to be emulated with a top level recursive CTE which requires an upper bound on the amount of elements that the series can return.protected DatabaseVersionGet the version of the SQL dialect that is the minimum supported by this implementation.The native SQL mutation-syntax capabilities of this Dialect.Supply catalog and schema qualification support, or returnnullto useDatabaseMetaData.Supply catalog and schema lifecycle behavior to schema tooling.Supply the database's default null ordering and explicit null-precedence syntax capabilities.Supply the JDBC strategy for binding an untyped Javanull.Supplies the database limits forIN-expression elements and total JDBC statement parameters.The database's native predicate syntax and predicate-placement profile.intSelect the defaultSqlTypescode for a basic Java array or collection.getQueryHintString(String sql, String hints) Apply a hint to the given SQL query.Supplies the complete database-native row-level-security strategy for this Dialect.The native row-value syntax of this Dialect.Supply the exporter used to create and drop relational sequences.Supply the strategy Hibernate uses to discover existing database sequences and their metadata.Supplies the complete sequence value-expression and lifecycle-DDL strategy for this Dialect.Supplies the database's set operators and structural query-group capabilities.Supply the strategy which resolves column sizes for mapped Java and JDBC types.Supply the factory for this Dialect's single-use SQL AST translators.Supplies the database's supported subquery placements.Supply the exporter used to create and drop relational tables.Supply datetime-format translation.Supply extraction and timestamp-arithmetic syntax.Supplies the complete temporal-table DDL and historical-query strategy for this Dialect.Supply temporal precision-adjustment and literal-offset semantics.Select the database's support profile for SQLwith time zonetypes.Supplies this Dialect's resolved type-sizing limits and defaults.Supply the stable strategy used for unique-key representation and DDL.The contexts in which this Dialect supports native multi-rowvaluessyntax.Supplies the extractor used to recover violated constraint names from database exceptions.Supplies the native window-function syntax supported by this database.voidinitializeFunctionRegistry(FunctionContributions functionContributions) Contribute the database-specific function descriptors after independent function contributors have run.charReturn the character which opens a quoted identifier.protected voidregisterColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry) Register the inherited ANSI-oriented DDL type descriptors during Dialect type contribution.render(CheckConstraintRenderRequest request) resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry) Resolve the non-null JDBC descriptor for result-set metadata.timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType) Return a timestamp-add pattern containing?1,?2, and?3.timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalType, TemporalType toTemporalType) Return a timestamp-difference pattern containing?1,?2, and?3.Translate a duration unit name.Translate an extraction field name.trimPattern(TrimSpec specification, boolean isWhitespace) Obtain a pattern for the SQL equivalent to atrim()function call.Methods inherited from class AbstractTransactSQLDialect
addColumnPrefix, appendBinaryLiteral, contributeDefaultProperties, getExpressionCoercionSupport, getLockingClauseStrategy, getMultiTableMutationSupport, getPreferredSqlTypeCodeForBoolean, getTupleCountSupport, nameQualification, replaceLtrimRtrimMethods inherited from class Dialect
appendArrayLiteral, augmentPhysicalTableTypes, augmentRecognizedTableTypes, buildLockingClauseStrategy, buildStringToBooleanCast, buildStringToBooleanCastDecode, constraintControlMode, defaultScrollMode, equivalentTypes, getAlterTableSupport, getArraySupport, getArrayTypeName, getBatchLoadSizingStrategy, getCatalogSeparator, getCheckConstraintSupport, getColumnAliasExtractor, getColumnDefinitionSupport, getConstraintControlSupport, getDefaultOrdinalityColumnName, getDefaultProperties, getDirectJavaTimeJdbcSupport, getEntityLockingStrategyFactory, getEnumSupport, getForeignKeyExporter, getForeignKeySupport, getFunctionalDependencyAnalysisSupport, getGeneratedValuesSupport, getGlobalTemporaryTableStrategy, getIdentifierSupport, getIndexDdlSupport, getIndexExporter, getInformationExtractor, getJdbcMetadataOverrides, getKeywords, getKeywordSupport, getLiteralSupport, getLobMergeStrategy, getLobSupport, getLowercaseFunction, getMultiKeyLoadSizingStrategy, getNationalizationSupport, getNativeParameterMarkerStrategy, getNativeValueGenerationStrategy, getPersistentTemporaryTableStrategy, getQueryHintPlacement, getQueryHintString, getRefCursorSupportFactory, getRowIdSupport, getSchemaCommentSupport, getSchemaDropSupport, getSchemaNameResolver, getSelectClauseNullString, getSetOperatorSqlString, getSingleRowTableSupport, getStringValueSemantics, getSyntheticTableGroupSupport, getTableCleaner, getTableCreationSupport, getTableMigrator, getTemporaryTableExporter, getTruncateSupport, getUserDefinedTypeExporter, getVersion, isJdbcLogWarningsEnabledByDefault, narrowCastType, resolveSqlTypeCode, resolveSqlTypeCode, resolveSqlTypeLength, supportsCrossJoin, supportsFilterClause, supportsNationalizedMethods, supportsOrdinalSelectItemReference, supportsUserDefinedTypes, throttleDdl, toString, truncateModeMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface AlterTableSupport
addColumnSuffix, alterTableCommandMethods inherited from interface CheckConstraintSupport
supportsMethods inherited from interface ConstraintControlSupport
disableCommands, disableConstraintCommands, enableCommands, enableConstraintCommandsMethods inherited from interface CurrentTemporalSupport
currentLocalTime, currentLocalTimestamp, isCurrentTimestampStable, usesStandardCurrentTimestampFunctionMethods inherited from interface ForeignKeySupport
renderAddConstraint, renderDropConstraint, requiresSelfReferentialForeignKeyNullification, supportsAlterTableConstraints, supportsOnDeleteActionMethods inherited from interface IdentifierSupport
getMaxAliasLength, quote, quoteCollation, toQuotedIdentifierMethods inherited from interface KeywordSupport
acceptsJdbcKeywordMethods inherited from interface LiteralSupport
appendBooleanValueString, appendIntervalLiteral, appendIntervalLiteral, appendLiteral, toBooleanValueStringMethods inherited from interface TableCreationSupport
createTableCommand, requiresViewColumnList, tableCreationOptionsMethods inherited from interface TruncateSupport
renderCommands
-
Constructor Details
-
SQLServerDialect
public SQLServerDialect() -
SQLServerDialect
-
SQLServerDialect
-
-
Method Details
-
getTemporalOperationSupport
Description copied from class:DialectSupply extraction and timestamp-arithmetic syntax. Return one stable, non-null, thread-safe implementation. Providers may implementTemporalOperationSupportdirectly and returnthis.- Overrides:
getTemporalOperationSupportin classDialect- See Also:
-
getTemporalFormatSupport
Description copied from class:DialectSupply datetime-format translation. Return one stable, non-null, thread-safe implementation.- Overrides:
getTemporalFormatSupportin classDialect- See Also:
-
getTemporalValueSemantics
Description copied from class:DialectSupply temporal precision-adjustment and literal-offset semantics. Return one stable, non-null immutable profile.- Overrides:
getTemporalValueSemanticsin classDialect- See Also:
-
getCurrentTemporalSupport
Description copied from class:DialectSupply current temporal expressions and database-side timestamp retrieval. Return one stable, non-null, thread-safe implementation. Providers may implementCurrentTemporalSupportdirectly and returnthis.- Overrides:
getCurrentTemporalSupportin classAbstractTransactSQLDialect- See Also:
-
getTypeSizingProfile
Description copied from class:DialectSupplies this Dialect's resolved type-sizing limits and defaults.
Return
TypeSizingProfile.STANDARDwhen 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:
getTypeSizingProfilein classDialect
-
determineDatabaseVersion
Description copied from class:DialectDetermine the database version, as precise as possible and using Dialect-specific techniques, from aDialectResolutionInfoobject.This method is called during superclass construction by
Dialect(DialectResolutionInfo). Implementations must not depend on subclass initialization. Integration providers may also invoke this method on an existing Dialect when database metadata becomes available after the Dialect was constructed.- Overrides:
determineDatabaseVersionin classDialect- Parameters:
info- The dialect resolution info that would be passed by Hibernate ORM to the constructor of a Dialect of the same type.- Returns:
- The corresponding database version.
-
getMinimumSupportedVersion
Description copied from class:DialectGet the version of the SQL dialect that is the minimum supported by this implementation.This method is called during superclass construction. Implementations must return construction-safe immutable data and must not depend on subclass initialization.
- Overrides:
getMinimumSupportedVersionin classDialect
-
contributeKeywords
Description copied from class:DialectContribute ANSI and database-specific SQL keywords.
Invoke
superfirst to retain the SQL:2003 words. Omittingsuperdeliberately replaces the inherited keyword profile. Register words only during this callback and do not retain the registration target.- Overrides:
contributeKeywordsin classDialect- Parameters:
registration- the scoped keyword target
-
columnType
Description copied from class:DialectReturn the complete database column declaration pattern for a JDBC
Typesor HibernateSqlTypescode used during type registration.Use only
$l,$p, and$sfor length, precision, and scale. Define distinct mappings for theLONG32codes; the JDBCLONGsynonyms are normalized before this hook. Delegate unknown inherited codes to the superclass so its standard exception remains authoritative.- Overrides:
columnTypein classAbstractTransactSQLDialect
-
castType
Description copied from class:DialectReturn 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). -
registerColumnTypes
@SPI({IMPLEMENT,SUPPLY}) protected void registerColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry) Description copied from class:DialectRegister the inherited ANSI-oriented DDL type descriptors during Dialect type contribution.
Override this focused sub-hook to extend or replace column type registrations. Invoke
superfirst 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 independentTypeContributorinstead when the contribution is not owned by a Dialect.- Overrides:
registerColumnTypesin classDialect- Parameters:
typeContributions- the Hibernate-supplied contribution targetserviceRegistry- the Hibernate-supplied bootstrap services- See Also:
-
getPreferredSqlTypeCodeForArray
Description copied from class:DialectSelect the default
SqlTypescode for a basic Java array or collection.Return the container type Hibernate should request when no local mapping selects one. Typical choices are
SqlTypes.ARRAY,SqlTypes.TABLE,SqlTypes.JSON_ARRAY,SqlTypes.XML_ARRAY, andSqlTypes.VARBINARY. Thehibernate.type.preferred_array_jdbc_typesetting takes precedence over this Dialect default. This method selects a type code; contribute a JDBC descriptor or customize DDL rendering through their dedicated contracts.- Overrides:
getPreferredSqlTypeCodeForArrayin classDialect- Returns:
- a container type code defined by
SqlTypes - See Also:
-
resolveSqlTypeDescriptor
@SPI({USE,IMPLEMENT}) public JdbcType resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry) Description copied from class:DialectResolve the non-null JDBC descriptor for result-set metadata.
Preserve vendor replacement and array-component resolution, and delegate unmatched codes to
jdbcTypeRegistry.- Overrides:
resolveSqlTypeDescriptorin classAbstractTransactSQLDialect
-
getTimeZoneSupport
Description copied from class:DialectSelect the database's support profile for SQL
with time zonetypes.Override this method to report whether the database preserves the original zone, normalizes values to UTC, or has no native support. This value participates in mapping and JDBC type selection; it does not control temporal-literal syntax.
- Overrides:
getTimeZoneSupportin classDialect- Returns:
- the database time-zone type support profile
- See Also:
-
getMaxIdentifierLength
Description copied from interface:IdentifierSupportReturn the database's maximum identifier length.- Specified by:
getMaxIdentifierLengthin interfaceIdentifierSupport
-
contributeTypes
@SPI({IMPLEMENT,SUPPLY}) public void contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry) Description copied from class:DialectContribute 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
superfirst unless the Dialect intentionally replaces the complete inherited contribution protocol. Obtain reusable dialect-specific JDBC descriptors from the family facades inorg.hibernate.dialect.type.spi, and preserve whether a descriptor replaces an existing registration or is added only when absent.- Overrides:
contributeTypesin classAbstractTransactSQLDialect- Parameters:
typeContributions- the Hibernate-supplied contribution registryserviceRegistry-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
TypeContributorinstead when the contribution is not owned by a Dialect.
-
initializeFunctionRegistry
@SPI({IMPLEMENT,SUPPLY}) public void initializeFunctionRegistry(FunctionContributions functionContributions) Description copied from class:DialectContribute the database-specific function descriptors after independent function contributors have run.
Override this callback to extend or replace the inherited function set. Invoke
superfirst 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 independentFunctionContributorinstead when the contribution is not owned by a Dialect.- Overrides:
initializeFunctionRegistryin classAbstractTransactSQLDialect- Parameters:
functionContributions- the Hibernate-supplied function contribution target- See Also:
-
getMaximumSeriesSize
protected int getMaximumSeriesSize()SQL Server doesn't support thegenerate_seriesfunction orlateralrecursive CTEs, so it has to be emulated with a top level recursive CTE which requires an upper bound on the amount of elements that the series can return. -
trimPattern
Description copied from class:DialectObtain a pattern for the SQL equivalent to atrim()function call. The resulting pattern must contain a ?1 placeholder for the argument of typeStringand a ?2 placeholder for the trim character ifisWhitespacewas false.- Overrides:
trimPatternin classAbstractTransactSQLDialect- Parameters:
specification- leading, trailing, or bothisWhitespace-trueif trimming whitespace, and the ?2 placeholder for the trim character should be omitted,falseif the trim character is explicit and the ?2 placeholder must be included in the pattern
-
getSqlAstTranslatorFactory
Description copied from class:DialectSupply the factory for this Dialect's single-use SQL AST translators.
Return
nullto useStandardSqlAstTranslatorFactory. A custom Dialect should normally return a reusable factory derived from that class and create translators derived fromAbstractSqlAstTranslatoror an appropriate supported family base. The factory must not retain translation requests, and every translator it returns is used for one translation.- Overrides:
getSqlAstTranslatorFactoryin classDialect- See Also:
-
getAggregateSupport
Description copied from class:DialectSupply the aggregate-column mapping, DDL, read, assignment, and write behavior for this dialect. Override this method to return a provider implementation ofAggregateSupport, or retain the standard behavior returned by the default.- Overrides:
getAggregateSupportin classDialect- Returns:
- this dialect's aggregate support
- See Also:
-
getSizeStrategy
Description copied from class:DialectSupply the strategy which resolves column sizes for mapped Java and JDBC types.
Return the standard strategy unless this database changes column-size resolution. For focused deviations, construct a stable
StandardSizeStrategywith this Dialect, override the affected cases, and delegate all other cases to the standard implementation. The result must be non-null and stable for the lifetime of this Dialect.- Overrides:
getSizeStrategyin classDialect
-
castPattern
Description copied from class:DialectObtain a pattern for the SQL equivalent to acast()function call. The resulting pattern must contain ?1 and ?2 placeholders for the arguments.- Overrides:
castPatternin classDialect- Parameters:
from- aCastTypeindicating the type of the value argumentto- aCastTypeindicating the type the value argument is cast to
-
currentTimestamp
Description copied from interface:CurrentTemporalSupportRender the current SQL timestamp expression used forjava.sql.Timestamp.- Specified by:
currentTimestampin interfaceCurrentTemporalSupport
-
buildIdentifierHelper
@SPI({USE,IMPLEMENT,SUPPLY}) public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuildRequest request) Description copied from interface:IdentifierSupportBuild 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:
buildIdentifierHelperin interfaceIdentifierSupport- See Also:
-
currentTime
Description copied from interface:CurrentTemporalSupportRender the current SQL time expression used forjava.sql.Time.- Specified by:
currentTimein interfaceCurrentTemporalSupport
-
currentDate
Description copied from interface:CurrentTemporalSupportRender the current SQL date expression.- Specified by:
currentDatein interfaceCurrentTemporalSupport
-
currentTimestampWithTimeZone
Description copied from interface:CurrentTemporalSupportRender the current timestamp-with-time-zone expression.- Specified by:
currentTimestampWithTimeZonein interfaceCurrentTemporalSupport
-
getLimitHandler
Description copied from class:DialectSupplies execution-time pagination for already-rendered SQL requested by
Query.setMaxResults(int)orQuery.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 stockLimitHandleror extend a supported handler family. The returned handler may be reused concurrently and must not retain per-query state.- Overrides:
getLimitHandlerin classDialect- Returns:
- a non-null handler
-
getValuesListSupport
Description copied from class:DialectThe contexts in which this Dialect supports native multi-row
valuessyntax.The returned immutable profile must be non-null and stable for the lifetime of this Dialect. Report only native syntax support; translator emulation is selected separately.
- Overrides:
getValuesListSupportin classDialect
-
getPredicateSupport
Description copied from class:DialectThe database's native predicate syntax and predicate-placement profile.
Override this method to supply independent support for a native case-insensitive-
likeoperator, scalardistinct from, truthness predicates, and predicates used as value expressions. An absent case-insensitive-likeoperator selects Hibernate's lowercase-expression emulation. Return one immutable, non-null profile whose values remain stable for the lifetime of this Dialect; do not override individual consumers to reproduce these decisions.- Overrides:
getPredicateSupportin classDialect- Returns:
- this Dialect's stable predicate-support profile
-
closeQuote
Description copied from interface:IdentifierSupportReturn the character which closes a quoted identifier.- Specified by:
closeQuotein interfaceIdentifierSupport
-
getIfExistsSupport
Description copied from class:DialectSupply existence-check placement for schema DDL targets.
Return one immutable profile for this Dialect's lifetime.
- Overrides:
getIfExistsSupportin classDialect- See Also:
-
openQuote
Description copied from interface:IdentifierSupportReturn the character which opens a quoted identifier.- Specified by:
openQuotein interfaceIdentifierSupport
-
getLockingSupport
Description copied from class:DialectSupplies 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:
getLockingSupportin classDialect- See Also:
-
getCurrentTimestampSelection
The current_timestamp is more accurate, but only known to be supported in SQL Server 7.0 and later and Sybase not known to support it at allSelect the JDBC command used for database-side current timestamp retrieval, or return
nullwhen the database offers no supported command.- Specified by:
getCurrentTimestampSelectionin interfaceCurrentTemporalSupport- Overrides:
getCurrentTimestampSelectionin classAbstractTransactSQLDialect- See Also:
-
addPartitionKeyToPrimaryKey
Description copied from class:DialectWhether every table partition key must also occur in its primary key.
Return
trueonly when the database requires the rule for both ordinary and temporal-history tables. This has nothing to do with window-function partitioning.- Overrides:
addPartitionKeyToPrimaryKeyin classDialect
-
getParameterLimits
Description copied from class:DialectSupplies the database limits for
IN-expression elements and total JDBC statement parameters.Return a non-null, immutable profile whose values remain stable for this Dialect's lifetime. Use
ParameterLimits.UNLIMITEDwhen neither limit applies andParameterLimits.of(int)when both limits are identical. Keep the dimensions independent when the database imposes different expression and statement limits; Hibernate uses them for different planning decisions.- Overrides:
getParameterLimitsin classDialect- Returns:
- the non-null parameter-limit profile
-
getIdentityColumnSupport
Description copied from class:AbstractTransactSQLDialectSupply the common Transact-SQL identity profile. Subclasses may override this profile when their identity declaration or retrieval SQL differs.- Overrides:
getIdentityColumnSupportin classAbstractTransactSQLDialect
-
getCteSupport
Description copied from class:DialectThe 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; invokingsuperis 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:
getCteSupportin classDialect
-
getSequenceSupport
Description copied from class:DialectSupplies 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 ofSequenceSupport.- Overrides:
getSequenceSupportin classDialect- Returns:
- the non-null sequence-support strategy
- See Also:
-
getRowLevelSecurity
Description copied from class:DialectSupplies the complete database-native row-level-security strategy for this Dialect.
Return the same stable, thread-safe strategy for the Dialect's lifetime. Use
RowLevelSecurityStrategies.none()when native row-level security is unsupported, and return declarative DDL instead of mutating boot metadata.- Overrides:
getRowLevelSecurityin classDialect- Returns:
- the non-null row-level-security strategy
- See Also:
-
getSequenceInformationExtractor
Description copied from class:DialectSupply 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 withSequenceInformationExtractors.builder(String), and implementSequenceInformationExtractordirectly only for a genuinely multi-stage algorithm.- Overrides:
getSequenceInformationExtractorin classDialect- See Also:
-
getQueryHintString
Description copied from class:DialectApply a hint to the given SQL query.The entire query is provided, allowing full control over the placement and syntax of the hint.
By default, ignore the hint and simply return the query.
- Overrides:
getQueryHintStringin classDialect- Parameters:
sql- The query to which to apply the hint.hints- The hints to apply- Returns:
- The modified SQL
-
getNullOrderingSupport
Description copied from class:DialectSupply 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 rendernulls firstandnulls lastnatively. Dialect subclasses refining a family profile should copyDialect.getNullOrderingSupport()from the superclass and change only the values which differ.- Overrides:
getNullOrderingSupportin classAbstractTransactSQLDialect- Returns:
- the stable, non-null null-ordering-support profile
-
getSubquerySupport
Description copied from class:DialectSupplies 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
existspredicates in the select list are separate capabilities. Lateral spelling and fallback rendering remain translator responsibilities. When refining a family Dialect, start fromSubquerySupport.builder(super.getSubquerySupport())and change only the differing placements.- Overrides:
getSubquerySupportin classAbstractTransactSQLDialect- Returns:
- this Dialect's stable subquery-support profile
-
getWindowFunctionSupport
Description copied from class:DialectSupplies the native window-function syntax supported by this database.
Return one non-null, immutable profile whose values remain stable for this Dialect's lifetime. Baseline window calls, window partitioning, each frame unit, and frame exclusion are independent grammar facts. Every refinement requires baseline window support, and frame exclusion additionally requires a supported frame unit. Function-specific restrictions and individual frame-bound restrictions remain the responsibility of focused rendering.
When refining a family Dialect, start from
WindowFunctionSupport.builder(super.getWindowFunctionSupport())and change only the differing features.- Overrides:
getWindowFunctionSupportin classDialect- Returns:
- this Dialect's stable window-function-support profile
-
getFetchClauseSupport
Description copied from class:DialectSupply the
fetchclause forms accepted by this database.Return one non-null immutable profile whose identity and answers remain stable for this Dialect's lifetime. The four forms are independent; do not infer percent or ties support from ordinary row-count support.
- Overrides:
getFetchClauseSupportin classDialect- Returns:
- the stable
fetchclause capability profile - See Also:
-
getViolatedConstraintNameExtractor
@SPI({IMPLEMENT,SUPPLY}) public ViolatedConstraintNameExtractor getViolatedConstraintNameExtractor()Description copied from class:DialectSupplies the extractor used to recover violated constraint names from database exceptions.
The extractor returns
nullwhen a name cannot be recovered. Do not use an empty string or sentinel to represent absence.- Specified by:
getViolatedConstraintNameExtractorin interfaceConversionContext- Overrides:
getViolatedConstraintNameExtractorin classDialect- Returns:
- the non-null constraint-name extractor
- See Also:
-
causesRollback
Description copied from class:DialectDetermine 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
PessimisticLockExceptionorLockTimeoutException.- Overrides:
causesRollbackin classDialect- Parameters:
sqlException- the original database exception- Returns:
truewhen the failed statement invalidates the transaction
-
buildSQLExceptionConversionDelegate
@SPI({IMPLEMENT,SUPPLY}) public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate()Description copied from class:DialectSupplies 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
nullresult means that it declined the exception so conversion may continue. Returnnullfrom this method when the Dialect has no vendor-specific delegate.Prefer stable vendor error codes or SQL states and preserve the original
SQLException.- Overrides:
buildSQLExceptionConversionDelegatein classDialect- Returns:
- the vendor conversion delegate, or
nullwhen none is supplied - See Also:
-
fractionalSecondPrecisionInNanos
Even though SQL Server only supports 1/10th microsecond precision, we use nanosecond as the "native" precision for datetime arithmetic since it simplifies calculations.- Specified by:
fractionalSecondPrecisionInNanosin interfaceTemporalOperationSupport
-
extractPattern
Description copied from interface:TemporalOperationSupportReturn an extraction pattern containing?1for the field and?2for the value.- Specified by:
extractPatternin interfaceTemporalOperationSupport
-
timestampaddPattern
@SPI({USE,IMPLEMENT}) public String timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType) Description copied from interface:TemporalOperationSupportReturn a timestamp-add pattern containing?1,?2, and?3.- Specified by:
timestampaddPatternin interfaceTemporalOperationSupport
-
timestampdiffPattern
@SPI({USE,IMPLEMENT}) public String timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalType, TemporalType toTemporalType) Description copied from interface:TemporalOperationSupportReturn a timestamp-difference pattern containing?1,?2, and?3.- Specified by:
timestampdiffPatternin interfaceTemporalOperationSupport
-
translateDurationField
Description copied from interface:TemporalOperationSupportTranslate a duration unit name.- Specified by:
translateDurationFieldin interfaceTemporalOperationSupport
-
translateExtractField
Description copied from interface:TemporalOperationSupportTranslate an extraction field name.- Specified by:
translateExtractFieldin interfaceTemporalOperationSupport
-
appendFormat
Description copied from interface:TemporalFormatSupportAppend the database translation of the supplied Hibernate format pattern.- Specified by:
appendFormatin interfaceTemporalFormatSupport
-
datetimeFormat
-
appendUUIDLiteral
Description copied from interface:LiteralSupportAppend a SQL UUID literal expression.- Specified by:
appendUUIDLiteralin interfaceLiteralSupport
-
appendDateTimeLiteral
@SPI({USE,IMPLEMENT}) public void appendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone) Description copied from class:DialectAppend a datetime literal for a
java.timevalue.Preserve the value's offset only when the Dialect's temporal-value semantics permit it. Append immediately and retain no invocation state.
- Specified by:
appendDateTimeLiteralin interfaceLiteralSupport- Overrides:
appendDateTimeLiteralin classDialect
-
appendDateTimeLiteral
@SPI({USE,IMPLEMENT}) public void appendDateTimeLiteral(SqlAppender appender, Date date, TemporalType precision, TimeZone jdbcTimeZone) Description copied from class:DialectAppend a datetime literal for a legacy
Datevalue.Apply the supplied JDBC time zone where required, append immediately, and retain no invocation state.
- Specified by:
appendDateTimeLiteralin interfaceLiteralSupport- Overrides:
appendDateTimeLiteralin classDialect
-
appendDateTimeLiteral
@SPI({USE,IMPLEMENT}) public void appendDateTimeLiteral(SqlAppender appender, Calendar calendar, TemporalType precision, TimeZone jdbcTimeZone) Description copied from class:DialectAppend a datetime literal for a
Calendarvalue.Preserve Calendar-specific time-zone and millisecond semantics, append immediately, and retain no invocation state.
- Specified by:
appendDateTimeLiteralin interfaceLiteralSupport- Overrides:
appendDateTimeLiteralin classDialect
-
appendDefinition
@SPI({USE,IMPLEMENT}) public void appendDefinition(SqlAppender appender, ColumnDefinitionRequest request) - Specified by:
appendDefinitionin interfaceColumnDefinitionSupport
-
getLocalTemporaryTableStrategy
Description copied from class:DialectSupplies this Dialect's local temporary-table strategy.
Return
nullwhen the database has no supported local temporary-table form. A non-null strategy must be stable for the Dialect lifetime and consistent withDialect.getTemporaryTableExporter().- Overrides:
getLocalTemporaryTableStrategyin classAbstractTransactSQLDialect
-
getNamespaceSupport
Description copied from class:DialectSupply catalog and schema lifecycle behavior to schema tooling.
Return one stable, non-null strategy. Prefer a complete immutable profile from
NamespaceSupports, and implementNamespaceSupportdirectly only for custom or multi-command namespace SQL.- Overrides:
getNamespaceSupportin classDialect- See Also:
-
createCommand
- Specified by:
createCommandin interfaceIndexDdlSupport
-
createTail
- Specified by:
createTailin interfaceIndexDdlSupport
-
alterColumnType
- Specified by:
alterColumnTypein interfaceAlterTableSupport
-
getNameQualifierSupport
Description copied from class:DialectSupply catalog and schema qualification support, or return
nullto useDatabaseMetaData.This value does not define the catalog separator; override
Dialect.getCatalogSeparator()independently when the metadata-free fallback is not..- Overrides:
getNameQualifierSupportin classDialect- See Also:
-
getUniqueDelegate
Description copied from class:DialectSupply 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.internalleaf.- Overrides:
getUniqueDelegatein classDialect- See Also:
-
getTableExporter
Description copied from class:DialectSupply the exporter used to create and drop relational tables.
Return one stable exporter owned by this Dialect. Prefer
StandardTableExporterwhen only its focused table-DDL template hooks are needed.- Overrides:
getTableExporterin classDialect
-
getSequenceExporter
Description copied from class:DialectSupply the exporter used to create and drop relational sequences.
Return one stable exporter owned by this Dialect. Prefer
StandardSequenceExporterwhen only sequence-name qualification differs.- Overrides:
getSequenceExporterin classDialect
-
createOptionalTableUpdateOperation
@SPI({USE,IMPLEMENT,SUPPLY}) public MutationOperation createOptionalTableUpdateOperation(OptionalTableUpdateOperationRequest request) Description copied from class:DialectCreates 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:
createOptionalTableUpdateOperationin classDialect- Returns:
- a non-null operation for the supplied optional-table update
- See Also:
-
getDmlTargetColumnQualifierSupport
@SPI({USE,IMPLEMENT,SUPPLY}) public DmlTargetColumnQualifierSupport getDmlTargetColumnQualifierSupport()Description copied from class:DialectThe 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:
getDmlTargetColumnQualifierSupportin classDialect- Returns:
- the non-null target-column qualifier support
- See Also:
-
getMutationSyntaxSupport
Description copied from class:DialectThe 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.
QueryMutationRenderingSupportconsumes this profile when selecting a native or emulated plan.- Overrides:
getMutationSyntaxSupportin classDialect
-
getCallableStatementSupport
Description copied from class:DialectSupply the callable-statement protocol for this database and JDBC driver.
Return one non-null strategy whose behavior remains stable for this Dialect's lifetime. Use
CallableStatementSupportsfor the standard and stock database protocols.- Overrides:
getCallableStatementSupportin classDialect- Returns:
- the callable-statement strategy
- See Also:
-
render
- Specified by:
renderin interfaceCheckConstraintSupport
-
getObjectNullBindingStrategy
Description copied from class:DialectSupply the JDBC strategy for binding an untyped Javanull.- Overrides:
getObjectNullBindingStrategyin classDialect- Returns:
- the non-null binding strategy
- See Also:
-
getSetOperationSupport
Description copied from class:DialectSupplies the database's set operators and structural query-group capabilities.
Return one non-null, immutable profile whose values remain stable for this Dialect's lifetime. Declare each
SetOperatorindependently; support for a distinct operator never implies itsALLform. Structural capabilities such asUNIONplacement in subqueries are separate from operator support. Continue to overrideDialect.getSetOperatorSqlString(SetOperator)when an operator requires database-specific spelling. When refining a family Dialect, start fromSetOperationSupport.builder(super.getSetOperationSupport())and change only the differing values.- Overrides:
getSetOperationSupportin classDialect- Returns:
- this Dialect's stable set-operation profile
-
getRowValueSupport
Description copied from class:DialectThe native row-value syntax of this Dialect.
Override this method to supply explicit
row(a, b)construction, row equality, ordering, and distinctness comparisons, row-valuedINlists, row-valuedINsubqueries, and quantified row comparisons. Treat each feature as an exact native-syntax declaration: do not inferIN-subquery support fromIN-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:
getRowValueSupportin classDialect- Returns:
- this Dialect's stable row-value-support profile
-
getTemporalTableSupport
Description copied from class:DialectSupplies the complete temporal-table DDL and historical-query strategy for this Dialect.
Return an immutable strategy and use the supported request values without retaining them. Prefer
TemporalTableSupports.standard(int, int, boolean)when only the column type, precision, and table-check capability differ.- Overrides:
getTemporalTableSupportin classDialect- Returns:
- the non-null temporal-table support strategy
- See Also:
-