org.hibernate.dialect

Class SybaseDialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.AbstractTransactSQLDialect

org.hibernate.dialect.SybaseDialect

All Implemented Interfaces:

ConversionContext

Direct Known Subclasses:

SybaseASEDialect

public class SybaseDialect
extends AbstractTransactSQLDialect

Superclass for all Sybase dialects.

Nested Class Summary

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

Dialect.SizeStrategy, Dialect.SizeStrategyImpl

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	jtdsDriver

Fields inherited from class org.hibernate.dialect.Dialect

CLOSED_QUOTE, DEFAULT_BATCH_SIZE, LEGACY_LOB_MERGE_STRATEGY, NEW_LOCATOR_LOB_MERGE_STRATEGY, NO_BATCH, QUOTE, STANDARD_DEFAULT_BATCH_LOAD_SIZING_STRATEGY, STREAM_XFER_LOB_MERGE_STRATEGY, TWO_SINGLE_QUOTES_REPLACEMENT

Constructor Summary

Constructors

Constructor and Description
SybaseDialect()
SybaseDialect(DialectResolutionInfo info)
SybaseDialect(int version, boolean jtdsDriver)

Method Summary

Modifier and Type	Method and Description
IdentifierHelper	buildIdentifierHelper(IdentifierHelperBuilder builder, DatabaseMetaData dbMetaData) Build the IdentifierHelper indicated by this Dialect for handling identifier conversions.
boolean	canCreateSchema() Does this dialect support schema creation?
String	castPattern(CastType from, CastType to) Obtain a pattern for the SQL equivalent to a cast() function call.
void	contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry) Allows the Dialect to contribute additional types
String	extractPattern(TemporalUnit unit) Obtain a pattern for the SQL equivalent to an extract() function call.
String	getCurrentSchemaCommand() Get the SQL command used to retrieve the current schema name.
int	getInExpressionCountLimit() Return the limit that the underlying database places on the number of elements in an IN predicate.
NationalizationSupport	getNationalizationSupport()
String	getNullColumnString() The keyword used to specify a nullable column.
SqlAstTranslatorFactory	getSqlAstTranslatorFactory() Return an SqlAstTranslatorFactory specific for the Dialect.
protected JdbcTypeDescriptor	getSqlTypeDescriptorOverride(int sqlCode) Returns the JdbcTypeDescriptor that should be used to handle the given JDBC type code.
SqmTranslatorFactory	getSqmTranslatorFactory() Return an SqmToSqlAstConverterFactory specific for the Dialect.
int	getVersion()
void	initializeFunctionRegistry(QueryEngine queryEngine) Initialize the given registry with any dialect-specific functions.
JdbcTypeDescriptor	resolveSqlTypeDescriptor(int jdbcTypeCode, int precision, int scale, JdbcTypeDescriptorRegistry jdbcTypeDescriptorRegistry)
boolean	supportsFractionalTimestampArithmetic() Whether the database supports adding a fractional interval to a timestamp e.g.
boolean	supportsNullPrecedence()
String	timestampaddPattern(TemporalUnit unit, TemporalType temporalType) Obtain a pattern for the SQL equivalent to a timestampadd() function call.
String	timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalType, TemporalType toTemporalType) Obtain a pattern for the SQL equivalent to a timestampdiff() function call.
String	translateDatetimeFormat(String format) Translate the given datetime format string from the pattern language defined by Java's DateTimeFormatter to whatever pattern language is understood by the native datetime formatting function for this database (often the to_char() function).
String	translateExtractField(TemporalUnit unit) Return the name used to identify the given field as an argument to the extract() function, or of this dialect's equivalent function.
String	trimPattern(TrimSpec specification, char character) Obtain a pattern for the SQL equivalent to a trim() function call.

Methods inherited from class org.hibernate.dialect.AbstractTransactSQLDialect

appendLockHint, applyLocksToSql, doesReadCommittedCauseWritersToBlockReaders, doesRepeatableReadCauseReadersToBlockWriters, formatBinaryLiteral, getAddColumnString, getCurrentTimestampSelectString, getFallbackSqmMutationStrategy, getForUpdateString, getGroupByConstantRenderingStrategy, getIdentityColumnSupport, getNullOrdering, getPreferredSqlTypeCodeForBoolean, getResultSet, getSelectGUIDString, getWriteRowLockStrategy, isCurrentTimestampSelectStringCallable, qualifyIndexName, registerResultSetOutParameter, replaceLtrimRtrim, supportsCurrentTimestampSelection, supportsEmptyInList, supportsExistsInSelect, supportsPartitionBy, supportsTupleDistinctCounts, supportsTuplesInSubqueries

Methods inherited from class org.hibernate.dialect.Dialect

addSqlHintOrComment, appendLockHint, areStringComparisonsCaseInsensitive, augmentRecognizedTableTypes, binaryToDecimalPrecision, bindLimitParametersFirst, bindLimitParametersInReverseOrder, buildSQLExceptionConversionDelegate, buildSQLExceptionConverter, canCreateCatalog, closeQuote, convertToFirstRowValue, createCaseFragment, createOuterJoinFragment, currentDate, currentLocalTime, currentLocalTimestamp, currentTime, currentTimestamp, currentTimestampWithTimeZone, defaultScrollMode, dropConstraints, equivalentTypes, escapeComment, escapeLiteral, forceLimitUsage, forceLobAsLastValue, formatAsTimestamp, formatAsTimestamp, formatAsTimestamp, formatDateTimeLiteral, formatDateTimeLiteral, formatDateTimeLiteral, forUpdateOfColumns, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAddUniqueConstraintString, getAlterTableString, getAuxiliaryDatabaseObjectExporter, getBooleanCheckCondition, getCallableStatementSupport, getCascadeConstraintsString, getCaseInsensitiveLike, getCastTypeName, getColumnAliasExtractor, getColumnComment, getCreateCatalogCommand, getCreateMultisetTableString, getCreateSchemaCommand, getCreateSequenceString, getCreateSequenceString, getCreateSequenceStrings, getCreateTableString, getCreateTemporaryTableColumnAnnotation, getCrossJoinSeparator, getCurrentTimestampSQLFunctionName, getDefaultBatchLoadSizingStrategy, getDefaultDecimalPrecision, getDefaultLobLength, getDefaultProperties, getDefaultTimestampPrecision, getDialect, getDialect, getDoublePrecision, getDropCatalogCommand, getDropForeignKeyString, getDropSchemaCommand, getDropSequenceString, getDropSequenceStrings, getDropTableString, getEnumCheckCondition, getFloatPrecision, getForeignKeyExporter, getForUpdateNowaitString, getForUpdateNowaitString, getForUpdateSkipLockedString, getForUpdateSkipLockedString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getFractionalSecondPrecisionInNanos, getFromDual, getGroupBySummarizationRenderingStrategy, getHibernateTypeName, getHibernateTypeName, getHqlTranslator, getIndexExporter, getKeywords, getLimitHandler, getLimitString, getLimitString, getLobMergeStrategy, getLockingStrategy, getLockRowIdentifier, getLowercaseFunction, getMaxAliasLength, getNameQualifierSupport, getNativeIdentifierGeneratorClass, getNativeIdentifierGeneratorStrategy, getNoColumnsInsertString, getNotExpression, getNullColumnString, getQueryHintString, getQueryHintString, getQuerySequencesString, getRawTypeName, getRawTypeName, getReadLockString, getReadLockString, getReadRowLockStrategy, getResultSet, getResultSet, getSchemaNameResolver, getSelectClauseNullString, getSelectSequenceNextValString, getSequenceExporter, getSequenceInformationExtractor, getSequenceNextValString, getSequenceNextValString, getSequenceSupport, getSizeStrategy, getTableAliasSeparator, getTableComment, getTableExporter, getTableTypeString, getTypeName, getTypeName, getTypeName, getTypeName, getUniqueDelegate, getUniqueKeyExporter, getViolatedConstraintNameExtractor, getWriteLockString, getWriteLockString, hasAlterTable, hasSelfReferentialForeignKeyBug, inlineLiteral, isEmptyStringTreatedAsNull, isJdbcLogWarningsEnabledByDefault, isLockTimeoutParameterized, isTypeNameRegistered, openQuote, prependComment, quote, registerColumnType, registerColumnType, registerHibernateType, registerHibernateType, registerKeyword, registerResultSetOutParameter, remapSqlTypeDescriptor, renderOrderByElement, replaceResultVariableInOrderByClauseWithPosition, requiresCastingOfParametersInSelectClause, requiresFloatCastingOfIntegerDivision, requiresParensForTupleDistinctCounts, supportsBindAsCallableArgument, supportsBitType, supportsCascadeDelete, supportsCaseInsensitiveLike, supportsCircularCascadeDeleteConstraints, supportsColumnCheck, supportsCommentOn, supportsExpectedLobUsagePattern, supportsFetchClause, supportsIfExistsAfterAlterTable, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsBeforeConstraintName, supportsIfExistsBeforeTableName, supportsJdbcConnectionLobCreation, supportsLimit, supportsLimitOffset, supportsLobValueChangePropagation, supportsLockTimeouts, supportsNamedParameters, supportsNationalizedTypes, supportsNoColumnsInsert, supportsNonQueryWithCTE, supportsNotNullUnique, supportsNoWait, supportsOffsetInSubquery, supportsOrderByInSubquery, supportsOrdinalSelectItemReference, supportsOuterJoinForUpdate, supportsParametersInInsertSelect, supportsPooledSequences, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsRowValueConstructorSyntax, supportsRowValueConstructorSyntaxInInList, supportsRowValueConstructorSyntaxInInSubquery, supportsRowValueConstructorSyntaxInQuantifiedPredicates, supportsRowValueConstructorSyntaxInSet, supportsSelectAliasInGroupByClause, supportsSelectQueryWithoutFromClause, supportsSequences, supportsSkipLocked, supportsSubqueryInSelect, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTemporalLiteralOffset, supportsTemporaryTables, supportsTimezoneTypes, supportsTruncateWithCast, supportsTupleCounts, supportsUnboundedLobLocatorMaterialization, supportsUnionAll, supportsUnionInSubquery, supportsUnique, supportsUniqueConstraintInCreateAlterTable, supportsValuesList, supportsValuesListForInsert, supportsVariableLimit, supportsWait, supportsWindowFunctions, toBooleanValueString, toString, transformSelectString, translateDurationField, useFollowOnLocking, useInputStreamToInsertBlob, useMaxForLimit, wrapDateLiteral, wrapTimeLiteral, wrapTimestampLiteral

Methods inherited from class java.lang.Object

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

Field Detail

jtdsDriver

protected final boolean jtdsDriver

Constructor Detail

SybaseDialect

public SybaseDialect()

SybaseDialect

public SybaseDialect(DialectResolutionInfo info)

SybaseDialect

public SybaseDialect(int version,
                     boolean jtdsDriver)

Method Detail

resolveSqlTypeDescriptor

public JdbcTypeDescriptor resolveSqlTypeDescriptor(int jdbcTypeCode,
                                                   int precision,
                                                   int scale,
                                                   JdbcTypeDescriptorRegistry jdbcTypeDescriptorRegistry)

Overrides:

resolveSqlTypeDescriptor in class AbstractTransactSQLDialect

getSqmTranslatorFactory

public SqmTranslatorFactory getSqmTranslatorFactory()

Description copied from class: Dialect

Return an SqmToSqlAstConverterFactory specific for the Dialect. Return null to use Hibernate's standard translator. Note that QueryEngineOptions.getCustomSqmTranslatorFactory() has higher precedence as it comes directly from the user config

Overrides:

getSqmTranslatorFactory in class Dialect

See Also:

StandardSqmTranslator, QueryEngine.getSqmTranslatorFactory()

getSqlAstTranslatorFactory

public SqlAstTranslatorFactory getSqlAstTranslatorFactory()

Description copied from class: Dialect

Return an SqlAstTranslatorFactory specific for the Dialect. Return null to use Hibernate's standard translator.

Overrides:

getSqlAstTranslatorFactory in class Dialect

See Also:

StandardSqlAstTranslatorFactory, JdbcEnvironment.getSqlAstTranslatorFactory()

getVersion

public int getVersion()

Specified by:

getVersion in class Dialect

supportsNullPrecedence

public boolean supportsNullPrecedence()

Overrides:

supportsNullPrecedence in class Dialect

getInExpressionCountLimit

public int getInExpressionCountLimit()

Description copied from class: Dialect

Return the limit that the underlying database places on the number of elements in an IN predicate. If the database defines no such limits, simply return zero or less-than-zero.

Overrides:

getInExpressionCountLimit in class Dialect

Returns:

int The limit, or zero-or-less to indicate no limit.

contributeTypes

public void contributeTypes(TypeContributions typeContributions,
                            ServiceRegistry serviceRegistry)

Description copied from class: Dialect

Allows the Dialect to contribute additional types

Overrides:

contributeTypes in class Dialect

Parameters:

typeContributions - Callback to contribute the types

serviceRegistry - The service registry

getNationalizationSupport

public NationalizationSupport getNationalizationSupport()

Overrides:

getNationalizationSupport in class Dialect

getSqlTypeDescriptorOverride

protected JdbcTypeDescriptor getSqlTypeDescriptorOverride(int sqlCode)

Description copied from class: Dialect

Returns the JdbcTypeDescriptor that should be used to handle the given JDBC type code. Returns null if there is no override.

Overrides:

getSqlTypeDescriptorOverride in class Dialect

Parameters:

sqlCode - A Types constant indicating the SQL column type

Returns:

The JdbcTypeDescriptor to use as an override, or null if there is no override.

initializeFunctionRegistry

public void initializeFunctionRegistry(QueryEngine queryEngine)

Description copied from class: Dialect

Initialize the given registry with any dialect-specific functions. Support for certain SQL functions is required, and if the database does not support a required function, then the dialect must define a way to emulate it. These required functions include the functions defined by the JPA query language specification:

• avg(arg) - aggregate function
• count([distinct ]arg) - aggregate function
• max(arg) - aggregate function
• min(arg) - aggregate function
• sum(arg) - aggregate function

• coalesce(arg0, arg1, ...)
• nullif(arg0, arg1)

• lower(arg)
• upper(arg)
• length(arg)
• concat(arg0, arg1, ...)
• locate(pattern, string[, start])
• substring(string, start[, length])
• trim([[spec ][character ]from] string)

• abs(arg)
• mod(arg0, arg1)
• sqrt(arg)

• current date
• current time
• current timestamp

Along with an additional set of functions defined by ANSI SQL:

• any(arg) - aggregate function
• every(arg) - aggregate function

• cast(arg as Type)
• extract(field from arg)

• ln(arg)
• exp(arg)
• power(arg0, arg1)
• floor(arg)
• ceiling(arg)

• position(pattern in string)
• substring(string from start[ for length])
• overlay(string placing replacement from start[ for length])

And the following functions for working with java.time types:

• local date
• local time
• local datetime
• offset datetime
• instant

And a number of additional "standard" functions:

• left(string, length)
• right(string, length)
• replace(string, pattern, replacement)
• pad(string with length spec[ character])

• sign(arg)
• sin(arg)
• cos(arg)
• tan(arg)
• asin(arg)
• acos(arg)
• atan(arg)
• atan2(arg0, arg1)
• round(arg0, arg1)
• least(arg0, arg1, ...)
• greatest(arg0, arg1, ...)

• format(datetime as pattern)
• str(arg) - synonym of cast(a as String)
• ifnull(arg0, arg1) - synonym of coalesce(a, b)

Finally, the following functions are defined as abbreviations for extract(), and desugared by the parser:

• second(arg) - synonym of extract(second from a)
• minute(arg) - synonym of extract(minute from a)
• hour(arg) - synonym of extract(hour from a)
• day(arg) - synonym of extract(day from a)
• month(arg) - synonym of extract(month from a)
• year(arg) - synonym of extract(year from a)

Overrides:

initializeFunctionRegistry in class AbstractTransactSQLDialect

getNullColumnString

public String getNullColumnString()

Description copied from class: Dialect

The keyword used to specify a nullable column.

Overrides:

getNullColumnString in class Dialect

Returns:

String

canCreateSchema

public boolean canCreateSchema()

Description copied from class: Dialect

Does this dialect support schema creation?

Overrides:

canCreateSchema in class Dialect

Returns:

True if the dialect supports schema creation; false otherwise.

getCurrentSchemaCommand

public String getCurrentSchemaCommand()

Description copied from class: Dialect

Get the SQL command used to retrieve the current schema name. Works in conjunction with Dialect.getSchemaNameResolver(), unless the return from there does not need this information. E.g., a custom impl might make use of the Java 1.7 addition of the Connection.getSchema() method

Overrides:

getCurrentSchemaCommand in class Dialect

Returns:

The current schema retrieval SQL

castPattern

public String castPattern(CastType from,
                          CastType to)

Description copied from class: Dialect

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

Overrides:

castPattern in class Dialect

Parameters:

from - a CastType indicating the type of the value argument

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

translateExtractField

public String translateExtractField(TemporalUnit unit)

Description copied from class: Dialect

Return the name used to identify the given field as an argument to the extract() function, or of this dialect's equivalent function.

This method does not need to handle TemporalUnit.NANOSECOND, TemporalUnit.NATIVE, TemporalUnit.OFFSET, TemporalUnit.DATE, TemporalUnit.TIME, TemporalUnit.WEEK_OF_YEAR, nor TemporalUnit.WEEK_OF_MONTH, which are already desugared by ExtractFunction.

Overrides:

translateExtractField in class Dialect

extractPattern

public String extractPattern(TemporalUnit unit)

Description copied from class: Dialect

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

This method does not need to handle TemporalUnit.NANOSECOND, TemporalUnit.NATIVE, TemporalUnit.OFFSET, TemporalUnit.DATE, TemporalUnit.TIME, TemporalUnit.WEEK_OF_YEAR, or TemporalUnit.WEEK_OF_MONTH, which are already desugared by ExtractFunction.

Overrides:

extractPattern in class Dialect

Parameters:

unit - the first argument

supportsFractionalTimestampArithmetic

public boolean supportsFractionalTimestampArithmetic()

Description copied from class: Dialect

Whether the database supports adding a fractional interval to a timestamp e.g. `timestamp + 0.5 second`

Overrides:

supportsFractionalTimestampArithmetic in class Dialect

timestampaddPattern

public String timestampaddPattern(TemporalUnit unit,
                                  TemporalType temporalType)

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 Dialect

Parameters:

unit - the first argument

temporalType - true if the third argument is a

timestampdiffPattern

public String timestampdiffPattern(TemporalUnit unit,
                                   TemporalType fromTemporalType,
                                   TemporalType toTemporalType)

Description copied from class: Dialect

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

Overrides:

timestampdiffPattern in class Dialect

Parameters:

unit - the first argument

fromTemporalType - true if the first argument is a timestamp, false if a date

toTemporalType - true if the second argument is

trimPattern

public String trimPattern(TrimSpec specification,
                          char character)

Description copied from class: Dialect

Obtain a pattern for the SQL equivalent to a trim() function call. The resulting pattern must contain a ?1 placeholder for the argument of type String.

Overrides:

trimPattern in class AbstractTransactSQLDialect

Parameters:

specification - leading or trailing

character - the character to trim

translateDatetimeFormat

public String translateDatetimeFormat(String format)

Description copied from class: Dialect

Translate the given datetime format string from the pattern language defined by Java's DateTimeFormatter to whatever pattern language is understood by the native datetime formatting function for this database (often the to_char() function).

Since it's never possible to translate all of the pattern letter sequences understood by DateTimeFormatter, only the following subset of pattern letters is accepted by Hibernate:

• G: era
• y: year of era
• Y: year of week-based year
• M: month of year
• w: week of week-based year (ISO week number)
• W: week of month
• E: day of week (name)
• e: day of week (number)
• d: day of month
• D: day of year
• a: AM/PM
• H: hour of day (24 hour time)
• h: hour of AM/PM (12 hour time)
• m: minutes
• s: seconds
• z,Z,x: timezone offset

In addition, punctuation characters and single-quoted literal strings are accepted.

Overrides:

translateDatetimeFormat in class Dialect

Returns:

a pattern accepted by the function that formats dates and times in this dialect

buildIdentifierHelper

public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuilder builder,
                                              DatabaseMetaData dbMetaData)
                                       throws SQLException

Description copied from class: Dialect

Build the IdentifierHelper indicated by this Dialect for handling identifier conversions. Returning null is allowed and indicates that Hibernate should fallback to building a "standard" helper. In the fallback path, any changes made to the IdentifierHelperBuilder during this call will still be incorporated into the built IdentifierHelper.

The incoming builder will have the following set:

• IdentifierHelperBuilder.isGloballyQuoteIdentifiers()
• IdentifierHelperBuilder.getUnquotedCaseStrategy() - initialized to UPPER
• IdentifierHelperBuilder.getQuotedCaseStrategy() - initialized to MIXED

By default Hibernate will do the following:

• Call IdentifierHelperBuilder.applyIdentifierCasing(DatabaseMetaData)
• Call IdentifierHelperBuilder.applyReservedWords(DatabaseMetaData)
• Applies AnsiSqlKeywords.sql2003() as reserved words
• Applies the {#link #sqlKeywords} collected here as reserved words
• Applies the Dialect's NameQualifierSupport, if it defines one

Overrides:

buildIdentifierHelper in class Dialect

Parameters:

builder - A semi-configured IdentifierHelper builder.

dbMetaData - Access to the metadata returned from the driver if needed and if available. WARNING: may be null

Returns:

The IdentifierHelper instance to use, or null to indicate Hibernate should use its fallback path

Throws:

SQLException - Accessing the DatabaseMetaData can throw it. Just re-throw and Hibernate will handle.

See Also:

Dialect.getNameQualifierSupport()