Class DB2zDialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.DB2Dialect

org.hibernate.dialect.DB2zDialect

All Implemented Interfaces:

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

public class DB2zDialect
extends DB2Dialect
implements TemporalOperationSupport

A SQL dialect for DB2 for z/OS version 12.1 and above, previously known as:

• "Db2 UDB for z/OS", and
• "Db2 UDB for z/OS and OS/390".

Field Summary

Fields

Modifier and Type	Field	Description
static final DatabaseVersion	DB2_LUW_VERSION

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
DB2zDialect()
DB2zDialect(DatabaseVersion version)
DB2zDialect(DialectResolutionInfo info)

Method Summary

Modifier and Type	Method	Description
protected LockingSupport	buildLockingSupport()
protected String	columnType(int sqlTypeCode)	Return the complete database column declaration pattern for a JDBC Types or Hibernate SqlTypes code used during type registration.
String	createCommand(IndexDdlRequest request)
MutationOperation	createOptionalTableUpdateOperation(OptionalTableUpdateOperationRequest request)	Creates the JDBC mutation operation for an optional-table update.
String	createTail(IndexDdlRequest request)
DatabaseVersion	getDB2Version()	DB2 LUW Version
IdentityColumnSupport	getIdentityColumnSupport()	Supply the stable identity-column DDL, insert syntax, and identity-specific retrieval behavior for this Dialect.
LimitHandler	getLimitHandler()	Supplies execution-time pagination for already-rendered SQL requested by Query.setMaxResults(int) or Query.setFirstResult(int).
protected DatabaseVersion	getMinimumSupportedVersion()	Get the version of the SQL dialect that is the minimum supported by this implementation.
RowIdSupport	getRowIdSupport()	The more "standard" syntax is rid_bit(alias) but here we use alias.rowid.
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.
SqlAstTranslatorFactory	getSqlAstTranslatorFactory()	Supply the factory for this Dialect's single-use SQL AST translators.
TemporalOperationSupport	getTemporalOperationSupport()	Supply extraction and timestamp-arithmetic syntax.
TimeZoneSupport	getTimeZoneSupport()	Select the database's support profile for SQL with time zone types.
ValuesListSupport	getValuesListSupport()	The contexts in which this Dialect supports native multi-row values syntax.
String	timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType)	Return a timestamp-add pattern containing ?1, ?2, and ?3.

Methods inherited from class DB2Dialect

alterColumnType, appendBinaryLiteral, appendBooleanValueString, appendDateTimeLiteral, appendDateTimeLiteral, appendDateTimeLiteral, appendDefinition, appendFormat, buildIdentifierHelper, buildSQLExceptionConversionDelegate, castPattern, causesRollback, constraintControlMode, contributeDefaultProperties, contributeTypes, createUniqueDelegate, determineDatabaseVersion, determinFullDatabaseVersion, disableConstraintCommands, enableConstraintCommands, extractPattern, fractionalSecondPrecisionInNanos, getAggregateSupport, getCallableStatementSupport, getCteSupport, getCurrentTemporalSupport, getCurrentTimestampSelection, getDirectJavaTimeJdbcSupport, getDmlTargetColumnQualifierSupport, getExpressionCoercionSupport, getGeneratedValuesSupport, getGlobalTemporaryTableStrategy, getIfExistsSupport, getJdbcMetadataOverrides, getLockingSupport, getMaxIdentifierLength, getMaximumSeriesSize, getMultiTableMutationSupport, getMutationSyntaxSupport, getNamespaceSupport, getNullOrderingSupport, getParameterLimits, getPredicateSupport, getPreferredSqlTypeCodeForArray, getRefCursorSupportFactory, getRowLevelSecurity, getRowValueSupport, getSchemaCommentSupport, getSchemaDropSupport, getSelectClauseNullString, getSingleRowTableSupport, getSubquerySupport, getTableExporter, getTemporalFormatSupport, getTemporalTableSupport, getTemporalValueSemantics, getTupleCountSupport, getTypeSizingProfile, getUniqueDelegate, getUserDefinedTypeExporter, getViolatedConstraintNameExtractor, getWindowFunctionSupport, initializeFunctionRegistry, parseVersion, registerColumnTypes, registerJsonFunctions, registerXmlFunctions, renderCommands, selectNullString, supportsNationalizedMethods, supportsUserDefinedTypes, timestampdiffPattern, translateExtractField

Methods inherited from class Dialect

addPartitionKeyToPrimaryKey, appendArrayLiteral, augmentPhysicalTableTypes, augmentRecognizedTableTypes, buildLockingClauseStrategy, buildStringToBooleanCast, buildStringToBooleanCastDecode, castType, contributeKeywords, defaultScrollMode, equivalentTypes, getAlterTableSupport, getArraySupport, getArrayTypeName, getBatchLoadSizingStrategy, getCatalogSeparator, getCheckConstraintSupport, getColumnAliasExtractor, getColumnDefinitionSupport, getConstraintControlSupport, getDefaultOrdinalityColumnName, getDefaultProperties, getEntityLockingStrategyFactory, getEnumSupport, getFetchClauseSupport, getForeignKeyExporter, getForeignKeySupport, getFunctionalDependencyAnalysisSupport, getIdentifierSupport, getIndexDdlSupport, getIndexExporter, getInformationExtractor, getKeywords, getKeywordSupport, getLiteralSupport, getLobMergeStrategy, getLobSupport, getLocalTemporaryTableStrategy, getLockingClauseStrategy, getLowercaseFunction, getMultiKeyLoadSizingStrategy, getNameQualifierSupport, getNationalizationSupport, getNativeParameterMarkerStrategy, getNativeValueGenerationStrategy, getObjectNullBindingStrategy, getPersistentTemporaryTableStrategy, getPreferredSqlTypeCodeForBoolean, getQueryHintPlacement, getQueryHintString, getQueryHintString, getSchemaNameResolver, getSequenceExporter, getSetOperationSupport, getSetOperatorSqlString, getSizeStrategy, getStringValueSemantics, getSyntheticTableGroupSupport, getTableCleaner, getTableCreationSupport, getTableMigrator, getTemporaryTableExporter, getTruncateSupport, getVersion, isJdbcLogWarningsEnabledByDefault, narrowCastType, resolveSqlTypeCode, resolveSqlTypeCode, resolveSqlTypeDescriptor, resolveSqlTypeLength, supportsCrossJoin, supportsFilterClause, supportsOrdinalSelectItemReference, throttleDdl, toString, trimPattern, truncateMode

Methods inherited from class Object

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

Methods inherited from interface AlterTableSupport

addColumnPrefix, addColumnSuffix, alterTableCommand

Methods inherited from interface CheckConstraintSupport

render, supports

Methods inherited from interface ConstraintControlSupport

disableCommands, enableCommands

Methods inherited from interface CurrentTemporalSupport

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

Methods inherited from interface ForeignKeySupport

renderAddConstraint, renderDropConstraint, requiresSelfReferentialForeignKeyNullification, supportsAlterTableConstraints, supportsOnDeleteAction

Methods inherited from interface IdentifierSupport

closeQuote, getMaxAliasLength, openQuote, quote, quoteCollation, toQuotedIdentifier

Methods inherited from interface IndexDdlSupport

nameQualification

Methods inherited from interface KeywordSupport

acceptsJdbcKeyword

Methods inherited from interface LiteralSupport

appendIntervalLiteral, appendIntervalLiteral, appendLiteral, appendUUIDLiteral, toBooleanValueString

Methods inherited from interface TableCreationSupport

createTableCommand, requiresViewColumnList, tableCreationOptions

Methods inherited from interface TemporalOperationSupport

extractPattern, fractionalSecondPrecisionInNanos, timestampdiffPattern, translateDurationField, translateExtractField

Field Details

DB2_LUW_VERSION

public static final DatabaseVersion DB2_LUW_VERSION

Constructor Details

DB2zDialect

public DB2zDialect(DialectResolutionInfo info)

DB2zDialect

public DB2zDialect()

DB2zDialect

public DB2zDialect(DatabaseVersion version)

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 DB2Dialect

See Also:

• TemporalOperationSupport

buildLockingSupport

protected LockingSupport buildLockingSupport()

Overrides:

buildLockingSupport in class DB2Dialect

getMinimumSupportedVersion

@SPI({IMPLEMENT,SUPPLY})
protected DatabaseVersion getMinimumSupportedVersion()

Description copied from class: Dialect

Get 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:

getMinimumSupportedVersion in class DB2Dialect

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 DB2Dialect

getDB2Version

public DatabaseVersion getDB2Version()

Description copied from class: DB2Dialect

DB2 LUW Version

Overrides:

getDB2Version in class DB2Dialect

createCommand

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

Specified by:

createCommand in interface IndexDdlSupport

createTail

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

Specified by:

createTail in interface IndexDdlSupport

Overrides:

createTail in class DB2Dialect

getTimeZoneSupport

@SPI({IMPLEMENT,SUPPLY})
public TimeZoneSupport getTimeZoneSupport()

Description copied from class: Dialect

Select the database's support profile for SQL with time zone types.

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:

getTimeZoneSupport in class Dialect

Returns:

the database time-zone type support profile

See Also:

• TimeZoneSupport

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 DB2Dialect

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 DB2Dialect

See Also:

• SequenceInformationExtractor
• SequenceInformationExtractors

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 DB2Dialect

Returns:

a non-null handler

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 DB2Dialect

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

Overrides:

timestampaddPattern in class DB2Dialect

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 DB2Dialect

Returns:

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

See Also:

• OptionalTableUpdateOperationRequest
• MutationOperation

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 DB2Dialect

See Also:

• SqlAstTranslatorFactory
• JdbcEnvironment.getSqlAstTranslatorFactory()

getRowIdSupport

@SPI({IMPLEMENT,SUPPLY})
public RowIdSupport getRowIdSupport()

Description copied from class: DB2Dialect

The more "standard" syntax is rid_bit(alias) but here we use alias.rowid.

There is also an alternative rid() of type bigint, but it cannot be used with partitioning.

Overrides:

getRowIdSupport in class DB2Dialect

Returns:

the stable non-null row-id strategy

See Also:

• RowIdSupport

getValuesListSupport

public ValuesListSupport getValuesListSupport()

Description copied from class: Dialect

The contexts in which this Dialect supports native multi-row values syntax.

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:

getValuesListSupport in class DB2Dialect