Package org.hibernate.dialect

Class TiDBDialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.MySQLDialect

org.hibernate.dialect.TiDBDialect

All Implemented Interfaces:

FunctionContributor, TypeContributor, ConversionContext

public class TiDBDialect
extends MySQLDialect

A SQL dialect for TiDB.

Nested Class Summary

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

Dialect.SizeStrategy, Dialect.SizeStrategyImpl

Field Summary

Fields inherited from class org.hibernate.dialect.Dialect

CLOSED_QUOTE, 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
TiDBDialect()
TiDBDialect(DatabaseVersion version)
TiDBDialect(DialectResolutionInfo info)

Method Summary

Modifier and Type	Method	Description
AggregateSupport	getAggregateSupport()	How does this dialect support aggregate types like SqlTypes.STRUCT.
String	getDual()	Returns a table expression that has one row.
String	getForUpdateNowaitString()	Retrieves the FOR UPDATE NOWAIT syntax specific to this dialect.
String	getForUpdateNowaitString(String aliases)	Get the FOR UPDATE OF column_list NOWAIT fragment appropriate for this dialect, given the aliases of the columns to be write locked.
FunctionalDependencyAnalysisSupport	getFunctionalDependencyAnalysisSupport()	Get this dialect's level of support for primary key functional dependency analysis within GROUP BY and ORDER BY clauses.
protected DatabaseVersion	getMinimumSupportedVersion()	Get the version of the SQL dialect that is the minimum supported by this implementation.
DatabaseVersion	getMySQLVersion()
String	getQuerySequencesString()	Get the select command used retrieve the names of all sequences.
String	getReadLockString(int timeout)	Get the string to append to SELECT statements to acquire READ locks for this dialect.
String	getReadLockString(String aliases, int timeout)	Get the string to append to SELECT statements to acquire READ locks for this dialect, given the aliases of the columns to be read locked.
SequenceInformationExtractor	getSequenceInformationExtractor()	A SequenceInformationExtractor which is able to extract SequenceInformation from the JDBC result set returned when Dialect.getQuerySequencesString() is executed.
SequenceSupport	getSequenceSupport()	No support for sequences.
SqlAstTranslatorFactory	getSqlAstTranslatorFactory()	Return a SqlAstTranslatorFactory specific to this dialect, or null to use the standard translator.
String	getWriteLockString(int timeout)	Get the string to append to SELECT statements to acquire pessimistic WRITE locks for this dialect.
protected void	registerDefaultKeywords()	Register the reserved words of ANSI-standard SQL as keywords.
boolean	supportsCascadeDelete()	Does this dialect support on delete actions in foreign key definitions?
boolean	supportsNoWait()	Does this dialect support NO_WAIT timeout.
boolean	supportsRecursiveCTE()	Does this dialect/database support recursive CTEs?
boolean	supportsSkipLocked()	Does this dialect support SKIP_LOCKED timeout.
boolean	supportsWait()	Does this dialect support WAIT timeout.
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.MySQLDialect

appendBooleanValueString, appendCheckConstraintOptions, appendDatetimeFormat, appendDateTimeLiteral, appendDateTimeLiteral, appendDateTimeLiteral, appendLiteral, buildIdentifierHelper, buildSQLExceptionConversionDelegate, canCreateCatalog, canCreateSchema, canDisableConstraints, castPattern, castType, closeQuote, columnType, contributeTypes, createVersion, createVersion, currentTimestamp, datetimeFormat, dropConstraints, extractPattern, getAddForeignKeyConstraintString, getAlterColumnTypeString, getCharacterSetBytesPerCharacter, getColumnComment, getCreateCatalogCommand, getCreateSchemaCommand, getCurrentTimestampSelectString, getDefaultLobLength, getDefaultMySQLStorageEngine, getDisableConstraintsStatement, getDmlTargetColumnQualifierSupport, getDropCatalogCommand, getDropForeignKeyString, getDropSchemaCommand, getDropUniqueKeyString, getEnableConstraintsStatement, getEnumTypeDeclaration, getFallbackSqmInsertStrategy, getFallbackSqmMutationStrategy, getFloatPrecision, getForUpdateSkipLockedString, getForUpdateSkipLockedString, getForUpdateString, getFractionalSecondPrecisionInNanos, getGroupBySelectItemReferenceStrategy, getIdentityColumnSupport, getLimitHandler, getMaxAliasLength, getMaxIdentifierLength, getMaximumSeriesSize, getMaxVarbinaryLength, getMaxVarcharLength, getNameQualifierSupport, getNullColumnString, getNullOrdering, getPreferredSqlTypeCodeForArray, getPreferredSqlTypeCodeForBoolean, getQueryHintString, getResultSet, getSelectGUIDString, getSizeStrategy, getSupportedTemporaryTableKind, getTableComment, getTableTypeString, getTemporaryTableAfterUseAction, getTemporaryTableBeforeUseAction, getTemporaryTableCreateCommand, getTemporaryTableDropCommand, getViolatedConstraintNameExtractor, getWriteLockString, getWriteRowLockStrategy, hasSelfReferentialForeignKeyBug, initDefaultProperties, initializeFunctionRegistry, isCurrentTimestampSelectStringCallable, isJdbcLogWarningsEnabledByDefault, isNoBackslashEscapesEnabled, openQuote, qualifyIndexName, registerColumnTypes, registerResultSetOutParameter, resolveSqlTypeDescriptor, resolveSqlTypeLength, stripsTrailingSpacesFromChar, supportsAlterColumnType, supportsBindingNullSqlTypeForSetNull, supportsColumnCheck, supportsCommentOn, supportsCurrentTimestampSelection, supportsFromClauseInUpdate, supportsIfExistsBeforeTableName, supportsIsTrue, supportsLateral, supportsLobValueChangePropagation, supportsLockTimeouts, supportsNullPrecedence, supportsOffsetInSubquery, supportsSubqueryOnMutatingTable, supportsTemporalLiteralOffset, supportsWindowFunctions, timestampdiffPattern, useMaterializedLobWhenCapacityExceeded

Methods inherited from class org.hibernate.dialect.Dialect

addQueryHints, addSqlHintOrComment, appendArrayLiteral, appendBinaryLiteral, appendIntervalLiteral, appendIntervalLiteral, appendLockHint, appendUUIDLiteral, applyLocksToSql, augmentPhysicalTableTypes, augmentRecognizedTableTypes, buildStringToBooleanCast, buildStringToBooleanCastDecode, buildStringToBooleanDecode, canBatchTruncate, checkVersion, contribute, contributeFunctions, createOptionalTableUpdateOperation, currentDate, currentLocalTime, currentLocalTimestamp, currentTime, currentTimestampWithTimeZone, defaultScrollMode, determineDatabaseVersion, doesReadCommittedCauseWritersToBlockReaders, doesRepeatableReadCauseReadersToBlockWriters, doesRoundTemporalOnOverflow, equivalentTypes, escapeComment, forceLobAsLastValue, generatedAs, getAddColumnString, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAlterTableString, getArrayTypeName, getAuxiliaryDatabaseObjectExporter, getBatchLoadSizingStrategy, getBeforeDropStatement, getCallableStatementSupport, getCascadeConstraintsString, getCaseInsensitiveLike, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckCondition, getCheckConstraintString, getColumnAliasExtractor, getCreateEnumTypeCommand, getCreateEnumTypeCommand, getCreateIndexString, getCreateIndexTail, getCreateMultisetTableString, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getCreateUserDefinedTypeExtensionsString, getCreateUserDefinedTypeKindString, getCrossReferenceParentTableFilter, getCurrentSchemaCommand, getDefaultDecimalPrecision, getDefaultIntervalSecondScale, getDefaultNonContextualLobCreation, getDefaultOrdinalityColumnName, getDefaultProperties, getDefaultStatementBatchSize, getDefaultTimestampPrecision, getDefaultUseGetGeneratedKeys, getDisableConstraintStatement, getDoublePrecision, getDropEnumTypeCommand, getDropEnumTypeCommand, getDropTableString, getEnableConstraintStatement, getEnumTypeDeclaration, getFallbackSchemaManagementTool, getForeignKeyExporter, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getFromDualForSelectOnly, getHqlTranslator, getIndexExporter, getInExpressionCountLimit, getKeywords, getLobMergeStrategy, getLockingStrategy, getLockRowIdentifier, getLowercaseFunction, getMaxNVarcharCapacity, getMaxNVarcharLength, getMaxVarbinaryCapacity, getMaxVarcharCapacity, getMultiKeyLoadSizingStrategy, getNationalizationSupport, getNativeIdentifierGeneratorStrategy, getNativeParameterMarkerStrategy, getNativeValueGenerationStrategy, getNoColumnsInsertString, getNullColumnString, getParameterCountLimit, getQueryHintString, getReadRowLockStrategy, getResultSet, getResultSet, getRowIdColumnString, getSchemaNameResolver, getSelectClauseNullString, getSequenceExporter, getSqmTranslatorFactory, getTableCleaner, getTableExporter, getTableMigrator, getTemporaryTableCreateOptions, getTemporaryTableDdlTransactionHandling, getTemporaryTableExporter, getTemporaryTableTruncateCommand, getTimeoutInSeconds, getTimeZoneSupport, getTruncateTableStatement, getTruncateTableStatements, getUniqueDelegate, getUniqueKeyExporter, getUserDefinedTypeComment, getUserDefinedTypeExporter, getVersion, hasAlterTable, hasDataTypeBeforeGeneratedAs, isEmptyStringTreatedAsNull, isLob, ordinal, prependComment, quote, quoteCollation, registerKeyword, registerKeywords, registerResultSetOutParameter, requiresCastForConcatenatingNonStrings, requiresFloatCastingOfIntegerDivision, requiresParensForTupleCounts, requiresParensForTupleDistinctCounts, resolveSqlTypeCode, resolveSqlTypeCode, rowId, rowIdSqlType, supportsBatchUpdates, supportsBindAsCallableArgument, supportsBindingNullForSetObject, supportsBitType, supportsCaseInsensitiveLike, supportsCircularCascadeDeleteConstraints, supportsConflictClauseForInsertCTE, supportsDistinctFromPredicate, supportsExistsInSelect, supportsExpectedLobUsagePattern, supportsFetchClause, supportsFractionalTimestampArithmetic, supportsIfExistsAfterAlterTable, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsAfterTypeName, supportsIfExistsBeforeConstraintName, supportsIfExistsBeforeTypeName, supportsInsertReturning, supportsInsertReturningGeneratedKeys, supportsInsertReturningRowId, supportsJdbcConnectionLobCreation, supportsMaterializedLobAccess, supportsNamedParameters, supportsNationalizedMethods, supportsNoColumnsInsert, supportsNonQueryWithCTE, supportsOrderByInSubquery, supportsOrdinalSelectItemReference, supportsOuterJoinForUpdate, supportsPartitionBy, supportsPredicateAsExpression, supportsRefCursors, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsStandardArrays, supportsStandardCurrentTimestampFunction, supportsSubqueryInSelect, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTableOptions, supportsTemporaryTablePrimaryKey, supportsTemporaryTables, supportsTruncateWithCast, supportsTupleCounts, supportsTupleDistinctCounts, supportsUnboundedLobLocatorMaterialization, supportsUnionAll, supportsUnionInSubquery, supportsUpdateReturning, supportsValuesList, supportsValuesListForInsert, toBooleanValueString, toQuotedIdentifier, toString, transformSelectString, translateDurationField, translateExtractField, trimPattern, unquoteGetGeneratedKeys, useArrayForMultiValuedParameters, useConnectionToCreateLob, useCrossReferenceForeignKeys, useFollowOnLocking, useInputStreamToInsertBlob

Methods inherited from class java.lang.Object

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

Constructor Details

TiDBDialect

public TiDBDialect()

TiDBDialect

public TiDBDialect(DatabaseVersion version)

TiDBDialect

public TiDBDialect(DialectResolutionInfo info)

Method Details

getMySQLVersion

public DatabaseVersion getMySQLVersion()

Overrides:

getMySQLVersion in class MySQLDialect

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 MySQLDialect

registerDefaultKeywords

protected void registerDefaultKeywords()

Description copied from class: Dialect

Register the reserved words of ANSI-standard SQL as keywords.

Overrides:

registerDefaultKeywords in class MySQLDialect

See Also:

• AnsiSqlKeywords

supportsCascadeDelete

public boolean supportsCascadeDelete()

Description copied from class: Dialect

Does this dialect support on delete actions in foreign key definitions?

Overrides:

supportsCascadeDelete in class MySQLDialect

Returns:

true if the dialect does support the on delete clause.

getQuerySequencesString

public String getQuerySequencesString()

Description copied from class: Dialect

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

Overrides:

getQuerySequencesString in class Dialect

Returns:

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

getSequenceSupport

public SequenceSupport getSequenceSupport()

Description copied from class: MySQLDialect

No support for sequences.

Overrides:

getSequenceSupport in class MySQLDialect

getAggregateSupport

public AggregateSupport getAggregateSupport()

Description copied from class: Dialect

How does this dialect support aggregate types like SqlTypes.STRUCT.

Overrides:

getAggregateSupport in class MySQLDialect

getSequenceInformationExtractor

public SequenceInformationExtractor getSequenceInformationExtractor()

Description copied from class: Dialect

A SequenceInformationExtractor which is able to extract SequenceInformation from the JDBC result set returned when Dialect.getQuerySequencesString() is executed.

Overrides:

getSequenceInformationExtractor in class Dialect

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 MySQLDialect

See Also:

• StandardSqlAstTranslatorFactory
• JdbcEnvironment.getSqlAstTranslatorFactory()

supportsRecursiveCTE

public boolean supportsRecursiveCTE()

Description copied from class: Dialect

Does this dialect/database support recursive CTEs?

Overrides:

supportsRecursiveCTE in class MySQLDialect

Returns:

true if recursive CTEs are supported

supportsSkipLocked

public boolean supportsSkipLocked()

Description copied from class: Dialect

Does this dialect support SKIP_LOCKED timeout.

Overrides:

supportsSkipLocked in class MySQLDialect

Returns:

true if SKIP_LOCKED is supported

supportsNoWait

public boolean supportsNoWait()

Description copied from class: Dialect

Does this dialect support NO_WAIT timeout.

Overrides:

supportsNoWait in class MySQLDialect

Returns:

true if NO_WAIT is supported

supportsWait

public boolean supportsWait()

Description copied from class: Dialect

Does this dialect support WAIT timeout.

Overrides:

supportsWait in class MySQLDialect

Returns:

true if WAIT is supported

getReadLockString

public String getReadLockString(int timeout)

Description copied from class: Dialect

Get the string to append to SELECT statements to acquire READ locks for this dialect.

Location of the returned string is treated the same as Dialect.getForUpdateString().

Overrides:

getReadLockString in class MySQLDialect

Parameters:

timeout - in milliseconds, -1 for indefinite wait and 0 for no wait.

Returns:

The appropriate LOCK clause string.

getReadLockString

public String getReadLockString(String aliases,
 int timeout)

Description copied from class: Dialect

Get the string to append to SELECT statements to acquire READ locks for this dialect, given the aliases of the columns to be read locked.

Location of the returned string is treated the same as Dialect.getForUpdateString().

Overrides:

getReadLockString in class MySQLDialect

Parameters:

aliases - The columns to be read locked.

timeout - in milliseconds, -1 for indefinite wait and 0 for no wait.

Returns:

The appropriate LOCK clause string.

getWriteLockString

public String getWriteLockString(int timeout)

Description copied from class: Dialect

Get the string to append to SELECT statements to acquire pessimistic WRITE locks for this dialect.

Location of the returned string is treated the same as Dialect.getForUpdateString().

Overrides:

getWriteLockString in class MySQLDialect

Parameters:

timeout - in milliseconds, -1 for indefinite wait and 0 for no wait.

Returns:

The appropriate LOCK clause string.

getForUpdateNowaitString

public String getForUpdateNowaitString()

Description copied from class: Dialect

Retrieves the FOR UPDATE NOWAIT syntax specific to this dialect.

Overrides:

getForUpdateNowaitString in class MySQLDialect

Returns:

The appropriate FOR UPDATE NOWAIT clause string.

getForUpdateNowaitString

public String getForUpdateNowaitString(String aliases)

Description copied from class: Dialect

Get the FOR UPDATE OF column_list NOWAIT fragment appropriate for this dialect, given the aliases of the columns to be write locked.

Overrides:

getForUpdateNowaitString in class MySQLDialect

Parameters:

aliases - The columns to be write locked.

Returns:

The appropriate FOR UPDATE OF colunm_list NOWAIT clause string.

getFunctionalDependencyAnalysisSupport

public FunctionalDependencyAnalysisSupport getFunctionalDependencyAnalysisSupport()

Description copied from class: Dialect

Get this dialect's level of support for primary key functional dependency analysis within GROUP BY and ORDER BY clauses.

Overrides:

getFunctionalDependencyAnalysisSupport in class MySQLDialect

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 MySQLDialect

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

getDual

public String getDual()

Description copied from class: Dialect

Returns a table expression that has one row.

Overrides:

getDual in class MySQLDialect

Returns:

the SQL equivalent to Oracle's dual.