Package org.hibernate.dialect

Class DB2zDialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.DB2Dialect

org.hibernate.dialect.DB2zDialect

All Implemented Interfaces:

FunctionContributor, TypeContributor, ConversionContext

public class DB2zDialect
extends DB2Dialect

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".

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.dialect.Dialect

Dialect.SizeStrategy, Dialect.SizeStrategyImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final DatabaseVersion	DB2_LUW_VERSION

Fields inherited from class org.hibernate.dialect.Dialect

CLOSED_QUOTE, FALSE_STRING_VALUES, LEGACY_LOB_MERGE_STRATEGY, LOG_BASE2OF10, NEW_LOCATOR_LOB_MERGE_STRATEGY, QUOTE, STANDARD_MULTI_KEY_LOAD_SIZING_STRATEGY, STREAM_XFER_LOB_MERGE_STRATEGY, TRUE_STRING_VALUES

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)	The database column type name for a given JDBC type code defined in Types or SqlTypes.
String	getCreateIndexString(boolean unique)	The command used to create an index, usually create index or create unique index.
String	getCreateIndexTail(boolean unique, List<Column> columns)	A string to be appended to the end of the create index command, usually to specify that null values are to be considered distinct.
DatabaseVersion	getDB2Version()	DB2 LUW Version
IdentityColumnSupport	getIdentityColumnSupport()	Get the appropriate IdentityColumnSupport for this dialect.
LimitHandler	getLimitHandler()	Obtain a LimitHandler that implements pagination support for Query.setMaxResults(int) and Query.setFirstResult(int).
protected DatabaseVersion	getMinimumSupportedVersion()	Get the version of the SQL dialect that is the minimum supported by this implementation.
String	getQuerySequencesString()	Get the select command used retrieve the names of all sequences.
String	getRowIdColumnString(String rowId)	If this dialect requires that the rowid column be declared explicitly, return the DDL column definition.
SequenceSupport	getSequenceSupport()	Get the appropriate SequenceSupport for this dialect.
SqlAstTranslatorFactory	getSqlAstTranslatorFactory()	Return a SqlAstTranslatorFactory specific to this dialect, or null to use the standard translator.
TimeZoneSupport	getTimeZoneSupport()	How the dialect supports time zone types like Types.TIMESTAMP_WITH_TIMEZONE.
String	rowId(String rowId)	The more "standard" syntax is rid_bit(alias) but here we use alias.rowid.
int	rowIdSqlType()	The JDBC type code of the rowid-like pseudo-column which acts as a high-performance row locator.
boolean	supportsIfExistsBeforeTableName()	For dropping a table, can the phrase if exists be applied before the table name?
String	timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType)	Obtain a pattern for the SQL equivalent to a timestampadd() function call.

Methods inherited from class org.hibernate.dialect.DB2Dialect

appendBinaryLiteral, appendBooleanValueString, appendDatetimeFormat, appendDateTimeLiteral, appendDateTimeLiteral, appendDateTimeLiteral, buildIdentifierHelper, buildSQLExceptionConversionDelegate, canDisableConstraints, castPattern, contributeTypes, createOptionalTableUpdateOperation, createUniqueDelegate, doesReadCommittedCauseWritersToBlockReaders, doesRoundTemporalOnOverflow, dropConstraints, extractPattern, generatedAs, getAggregateSupport, getAlterColumnTypeString, getCallableStatementSupport, getCreateUserDefinedTypeExtensionsString, getCurrentTimestampSelectString, getDefaultDecimalPrecision, getDefaultStatementBatchSize, getDisableConstraintStatement, getDmlTargetColumnQualifierSupport, getDropSchemaCommand, getDual, getEnableConstraintStatement, getFallbackSqmInsertStrategy, getFallbackSqmMutationStrategy, getForUpdateSkipLockedString, getForUpdateSkipLockedString, getForUpdateString, getFractionalSecondPrecisionInNanos, getFromDualForSelectOnly, getGlobalTemporaryTableStrategy, getInExpressionCountLimit, getLockingSupport, getMaxIdentifierLength, getMaximumSeriesSize, getMaxVarcharLength, getPreferredSqlTypeCodeForArray, getReadLockString, getReadLockString, getResultSet, getResultSet, getResultSet, getSelectClauseNullString, getSequenceInformationExtractor, getTableExporter, getTruncateTableStatement, getUniqueDelegate, getViolatedConstraintNameExtractor, getWriteLockString, getWriteLockString, initializeFunctionRegistry, isCurrentTimestampSelectStringCallable, registerColumnTypes, registerResultSetOutParameter, registerResultSetOutParameter, requiresCastForConcatenatingNonStrings, selectNullString, supportsAlterColumnType, supportsCommentOn, supportsCurrentTimestampSelection, supportsDistinctFromPredicate, supportsExistsInSelect, supportsFromClauseInUpdate, supportsInsertReturning, supportsInsertReturningRowId, supportsIsTrue, supportsLateral, supportsLobValueChangePropagation, supportsNonQueryWithCTE, supportsNullPrecedence, supportsOffsetInSubquery, supportsPartitionBy, supportsRecursiveCTE, supportsRefCursors, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsRowValueConstructorSyntax, supportsRowValueConstructorSyntaxInInList, supportsRowValueConstructorSyntaxInQuantifiedPredicates, supportsTupleDistinctCounts, supportsUserDefinedTypes, supportsValuesList, supportsWindowFunctions, supportsWithClauseInSubquery, timestampdiffPattern, translateExtractField, useInputStreamToInsertBlob

Methods inherited from class org.hibernate.dialect.Dialect

addPartitionKeyToPrimaryKey, addSqlHintOrComment, addUseIndexQueryHint, appendArrayLiteral, appendCheckConstraintOptions, appendIntervalLiteral, appendIntervalLiteral, appendLiteral, appendLockHint, appendUUIDLiteral, applyLocksToSql, augmentPhysicalTableTypes, augmentRecognizedTableTypes, buildLockingClauseStrategy, buildOptimisticForceIncrementStrategy, buildOptimisticStrategy, buildPessimisticForceIncrementStrategy, buildPessimisticReadStrategy, buildPessimisticWriteStrategy, buildReadStrategy, buildStringToBooleanCast, buildStringToBooleanCastDecode, buildStringToBooleanDecode, canBatchTruncate, canCreateCatalog, canCreateSchema, castType, checkVersion, closeQuote, contribute, contributeFunctions, currentDate, currentLocalTime, currentLocalTimestamp, currentTime, currentTimestamp, currentTimestampWithTimeZone, defaultScrollMode, determineDatabaseVersion, doesRepeatableReadCauseReadersToBlockWriters, equivalentTypes, escapeComment, forceLobAsLastValue, getAddColumnString, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAlterTableString, getArrayTypeName, getAuxiliaryDatabaseObjectExporter, getBatchLoadSizingStrategy, getBeforeDropStatement, getCascadeConstraintsString, getCaseInsensitiveLike, getCatalogSeparator, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckConstraintString, getColumnAliasExtractor, getColumnComment, getCreateCatalogCommand, getCreateEnumTypeCommand, getCreateEnumTypeCommand, getCreateMultisetTableString, getCreateSchemaCommand, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getCreateUserDefinedTypeKindString, getCrossReferenceParentTableFilter, getCurrentSchemaCommand, getDefaultIntervalSecondScale, getDefaultLobLength, getDefaultNonContextualLobCreation, getDefaultOrdinalityColumnName, getDefaultProperties, getDefaultTimestampPrecision, getDefaultUseGetGeneratedKeys, getDisableConstraintsStatement, getDoublePrecision, getDropCatalogCommand, getDropEnumTypeCommand, getDropEnumTypeCommand, getDropForeignKeyString, getDropTableString, getDropUniqueKeyString, getEnableConstraintsStatement, getEnumTypeDeclaration, getEnumTypeDeclaration, getFallbackSchemaManagementTool, getFloatPrecision, getForeignKeyExporter, getForUpdateNowaitString, getForUpdateNowaitString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getFunctionalDependencyAnalysisSupport, getGroupBySelectItemReferenceStrategy, getHqlTranslator, getIndexExporter, getKeywords, getLobMergeStrategy, getLocalTemporaryTableStrategy, getLockingClauseStrategy, getLockingStrategy, getLockingStrategy, getLockRowIdentifier, getLowercaseFunction, getMaxAliasLength, getMaxNVarcharCapacity, getMaxNVarcharLength, getMaxVarbinaryCapacity, getMaxVarbinaryLength, getMaxVarcharCapacity, getMultiKeyLoadSizingStrategy, getNameQualifierSupport, getNationalizationSupport, getNativeIdentifierGeneratorStrategy, getNativeParameterMarkerStrategy, getNativeValueGenerationStrategy, getNoColumnsInsertString, getNullColumnString, getNullColumnString, getNullOrdering, getParameterCountLimit, getPersistentTemporaryTableStrategy, getPessimisticLockStyle, getPreferredSqlTypeCodeForBoolean, getQueryHintString, getQueryHintString, getReadLockString, getReadLockString, getReadRowLockStrategy, getSchemaNameResolver, getSelectClauseNullString, getSelectGUIDString, getSequenceExporter, getSizeStrategy, getSqmTranslatorFactory, getSupportedTemporaryTableKind, getTableCleaner, getTableComment, getTableMigrator, getTableTypeString, getTemporaryTableAfterUseAction, getTemporaryTableBeforeUseAction, getTemporaryTableCreateCommand, getTemporaryTableCreateOptions, getTemporaryTableDdlTransactionHandling, getTemporaryTableDropCommand, getTemporaryTableExporter, getTemporaryTableTruncateCommand, getTimeoutInSeconds, getTruncateTableStatements, getUniqueKeyExporter, getUserDefinedTypeComment, getUserDefinedTypeExporter, getVersion, getWriteLockString, getWriteLockString, getWriteRowLockStrategy, hasAlterTable, hasDataTypeBeforeGeneratedAs, hasSelfReferentialForeignKeyBug, initDefaultProperties, isEmptyStringTreatedAsNull, isJdbcLogWarningsEnabledByDefault, isLob, openQuote, ordinal, prependComment, qualifyIndexName, quote, quoteCollation, registerDefaultKeywords, registerKeyword, registerKeywords, requiresColumnListInCreateView, requiresFloatCastingOfIntegerDivision, requiresParensForTupleCounts, requiresParensForTupleDistinctCounts, resolveSqlTypeCode, resolveSqlTypeCode, resolveSqlTypeDescriptor, resolveSqlTypeLength, stripsTrailingSpacesFromChar, supportsArrayConstructor, supportsBatchUpdates, supportsBindAsCallableArgument, supportsBindingNullForSetObject, supportsBindingNullSqlTypeForSetNull, supportsBitType, supportsCascadeDelete, supportsCaseInsensitiveLike, supportsCircularCascadeDeleteConstraints, supportsColumnCheck, supportsConflictClauseForInsertCTE, supportsCrossJoin, supportsDuplicateSelectItemsInQueryGroup, supportsExpectedLobUsagePattern, supportsFetchClause, supportsFilterClause, supportsForUpdate, supportsFractionalTimestampArithmetic, supportsIfExistsAfterAlterTable, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsAfterTypeName, supportsIfExistsBeforeConstraintName, supportsIfExistsBeforeTypeName, supportsInsertReturningGeneratedKeys, supportsIntersect, supportsJdbcConnectionLobCreation, supportsJoinInMutationStatementSubquery, supportsJoinsInDelete, supportsLockTimeouts, supportsMaterializedLobAccess, supportsNamedParameters, supportsNationalizedMethods, supportsNestedSubqueryCorrelation, supportsNestedWithClause, supportsNoColumnsInsert, supportsNoWait, supportsOrderByInSubquery, supportsOrdinalSelectItemReference, supportsOuterJoinForUpdate, supportsPredicateAsExpression, supportsRecursiveCycleClause, supportsRecursiveCycleUsingClause, supportsRecursiveSearchClause, supportsRowConstructor, supportsRowValueConstructorDistinctFromSyntax, supportsRowValueConstructorGtLtSyntax, supportsRowValueConstructorSyntaxInInSubQuery, supportsSimpleQueryGrouping, supportsSkipLocked, supportsStandardArrays, supportsStandardCurrentTimestampFunction, supportsSubqueryInSelect, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTableOptions, supportsTemporalLiteralOffset, supportsTemporaryTablePrimaryKey, supportsTemporaryTables, supportsTruncateWithCast, supportsTupleCounts, supportsUnboundedLobLocatorMaterialization, supportsUnionAll, supportsUnionInSubquery, supportsUpdateReturning, supportsValuesListForInsert, supportsWait, supportsWithClause, toBooleanValueString, toQuotedIdentifier, toString, transformSelectString, translateDurationField, trimPattern, unquoteGetGeneratedKeys, useArrayForMultiValuedParameters, useConnectionToCreateLob, useCrossReferenceForeignKeys, useFollowOnLocking, useMaterializedLobWhenCapacityExceeded

Methods inherited from class java.lang.Object

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

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

buildLockingSupport

protected LockingSupport buildLockingSupport()

Overrides:

buildLockingSupport in class DB2Dialect

getMinimumSupportedVersion

protected DatabaseVersion getMinimumSupportedVersion()

Description copied from class: Dialect

Get the version of the SQL dialect that is the minimum supported by this implementation.

Overrides:

getMinimumSupportedVersion in class DB2Dialect

columnType

protected String columnType(int sqlTypeCode)

Description copied from class: Dialect

The database column type name for a given JDBC type code defined in Types or SqlTypes. This default implementation returns the ANSI-standard type name.

This method may be overridden by concrete Dialects as an alternative to Dialect.registerColumnTypes(TypeContributions, ServiceRegistry) for simple registrations.

Note that:

1. Implementations of this method are expected to define a sensible mapping forTypes.NCLOB Types.NCHAR, and Types.NVARCHAR. On some database, these types are simply remapped to CLOB, CHAR, and VARCHAR.
2. Mappings for Types.TIMESTAMP and Types.TIMESTAMP_WITH_TIMEZONE should support explicit specification of precision if possible.
3. As specified by DdlTypeRegistry.getDescriptor(int), this method never receives Types.LONGVARCHAR, Types.LONGNVARCHAR, nor Types.LONGVARBINARY, which are considered synonyms for their non-LONG counterparts.
4. On the other hand, the types SqlTypes.LONG32VARCHAR, SqlTypes.LONG32NVARCHAR, and SqlTypes.LONG32VARBINARY are not synonyms, and implementations of this method must define sensible mappings, for example to database-native TEXT or CLOB types.

Overrides:

columnType in class DB2Dialect

Parameters:

sqlTypeCode - a SQL type code

Returns:

a column type name, with $l, $p, $s placeholders for length, precision, scale

See Also:

• SqlTypes

getDB2Version

public DatabaseVersion getDB2Version()

Description copied from class: DB2Dialect

DB2 LUW Version

Overrides:

getDB2Version in class DB2Dialect

supportsIfExistsBeforeTableName

public boolean supportsIfExistsBeforeTableName()

Description copied from class: Dialect

For dropping a table, can the phrase if exists be applied before the table name?

Overrides:

supportsIfExistsBeforeTableName in class DB2Dialect

Returns:

true if if exists can be applied before the table name

getCreateIndexString

public String getCreateIndexString(boolean unique)

Description copied from class: Dialect

The command used to create an index, usually create index or create unique index.

Overrides:

getCreateIndexString in class Dialect

Parameters:

unique - true if the index is a unique index

Returns:

The command used to create an index.

getCreateIndexTail

public String getCreateIndexTail(boolean unique,
 List<Column> columns)

Description copied from class: Dialect

A string to be appended to the end of the create index command, usually to specify that null values are to be considered distinct.

Overrides:

getCreateIndexTail in class DB2Dialect

getTimeZoneSupport

public TimeZoneSupport getTimeZoneSupport()

Description copied from class: Dialect

How the dialect supports time zone types like Types.TIMESTAMP_WITH_TIMEZONE.

Overrides:

getTimeZoneSupport in class Dialect

getSequenceSupport

public SequenceSupport getSequenceSupport()

Description copied from class: Dialect

Get the appropriate SequenceSupport for this dialect.

Overrides:

getSequenceSupport in class DB2Dialect

getQuerySequencesString

public String getQuerySequencesString()

Description copied from class: Dialect

Get the select command used retrieve the names of all sequences.

Overrides:

getQuerySequencesString in class DB2Dialect

Returns:

The select command; or null if sequences are not supported.

getLimitHandler

public LimitHandler getLimitHandler()

Description copied from class: Dialect

Obtain a LimitHandler that implements pagination support for Query.setMaxResults(int) and Query.setFirstResult(int).

Overrides:

getLimitHandler in class DB2Dialect

getIdentityColumnSupport

public IdentityColumnSupport getIdentityColumnSupport()

Description copied from class: Dialect

Get the appropriate IdentityColumnSupport for this dialect.

Overrides:

getIdentityColumnSupport in class DB2Dialect

Returns:

the IdentityColumnSupport

timestampaddPattern

public String timestampaddPattern(TemporalUnit unit,
 TemporalType temporalType,
 IntervalType intervalType)

Description copied from class: Dialect

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

Overrides:

timestampaddPattern in class DB2Dialect

Parameters:

unit - The unit to add to the temporal

temporalType - The type of the temporal

intervalType - The type of interval to add or null if it's not a native interval

getSqlAstTranslatorFactory

public SqlAstTranslatorFactory getSqlAstTranslatorFactory()

Description copied from class: Dialect

Return a SqlAstTranslatorFactory specific to this dialect, or null to use the standard translator.

Overrides:

getSqlAstTranslatorFactory in class DB2Dialect

See Also:

• StandardSqlAstTranslatorFactory
• JdbcEnvironment.getSqlAstTranslatorFactory()

rowId

public String rowId(String rowId)

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:

rowId in class DB2Dialect

Parameters:

rowId - the name specified by RowId.value(), which is ignored if Dialect.getRowIdColumnString(java.lang.String) is not overridden

rowIdSqlType

public int rowIdSqlType()

Description copied from class: Dialect

The JDBC type code of the rowid-like pseudo-column which acts as a high-performance row locator.

Overrides:

rowIdSqlType in class DB2Dialect

Returns:

Types.ROWID by default

getRowIdColumnString

public String getRowIdColumnString(String rowId)

Description copied from class: Dialect

If this dialect requires that the rowid column be declared explicitly, return the DDL column definition.

Overrides:

getRowIdColumnString in class Dialect

Returns:

the DDL column definition, or null if the rowid is an implicit pseudo-column