public class HSQLDialect extends Dialect
An SQL dialect compatible with HSQLDB (HyperSQL). <p/> Note this version supports HSQLDB version 1.8 and higher, only. <p/> Enhancements to version 3.5.0 GA to provide basic support for both HSQLDB 1.8.x and 2.x Does not works with Hibernate 3.2 - 3.4 without alteration.
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
Constructor and Description |
---|
HSQLDialect()
Constructs a HSQLDialect
|
Modifier and Type | Method and Description |
---|---|
boolean |
bindLimitParametersFirst()
Does the <tt>LIMIT</tt> clause come at the start of the
<tt>SELECT</tt> statement, rather than at the end?
|
boolean |
doesReadCommittedCauseWritersToBlockReaders()
For the underlying database, is READ_COMMITTED isolation implemented by
forcing readers to wait for write locks to be released?
|
boolean |
doesRepeatableReadCauseReadersToBlockWriters()
For the underlying database, is REPEATABLE_READ isolation implemented by
forcing writers to wait for read locks to be released?
|
String |
getAddColumnString()
The syntax used to add a column to a table (optional).
|
protected String |
getCreateSequenceString(String sequenceName)
HSQL will start with 0, by default.
|
protected String |
getCreateSequenceString(String sequenceName,
int initialValue,
int incrementSize)
Because of the overridden
getCreateSequenceString(String) , we must also override
getCreateSequenceString(String, int, int) to prevent 2 instances of "start with". |
String |
getCurrentTimestampSelectString()
Retrieve the command used to retrieve the current timestamp from the
database.
|
String |
getCurrentTimestampSQLFunctionName()
The name of the database-specific SQL function for retrieving the
current timestamp.
|
MultiTableBulkIdStrategy |
getDefaultMultiTableBulkIdStrategy() |
protected String |
getDropSequenceString(String sequenceName)
Typically dialects which support sequences can drop a sequence
with a single command.
|
String |
getForUpdateString()
Get the string to append to SELECT statements to acquire locks
for this dialect.
|
IdentityColumnSupport |
getIdentityColumnSupport()
Get the appropriate
IdentityColumnSupport |
LimitHandler |
getLimitHandler()
Returns the delegate managing LIMIT clause.
|
String |
getLimitString(String sql,
boolean hasOffset)
Apply s limit clause to the query.
|
LockingStrategy |
getLockingStrategy(Lockable lockable,
LockMode lockMode)
For HSQLDB 2.0, this is a copy of the base class implementation.
|
NameQualifierSupport |
getNameQualifierSupport()
By default interpret this based on DatabaseMetaData.
|
String |
getQuerySequencesString()
Get the select command used retrieve the names of all sequences.
|
String |
getSelectClauseNullString(int sqlType)
Given a
Types type code, determine an appropriate
null value to use in a select clause. |
String |
getSelectSequenceNextValString(String sequenceName)
Generate the select expression fragment that will retrieve the next
value of a sequence as part of another (typically DML) statement.
|
String |
getSequenceNextValString(String sequenceName)
Generate the appropriate select statement to to retrieve the next value
of a sequence.
|
ViolatedConstraintNameExtracter |
getViolatedConstraintNameExtracter() |
boolean |
isCurrentTimestampSelectStringCallable()
Should the value returned by
Dialect.getCurrentTimestampSelectString()
be treated as callable. |
boolean |
requiresCastingOfParametersInSelectClause()
Does this dialect require that parameters appearing in the <tt>SELECT</tt> clause be wrapped in <tt>cast()</tt>
calls to tell the db parser the expected type.
|
boolean |
supportsColumnCheck()
Does this dialect support column-level check constraints?
|
boolean |
supportsCommentOn()
Does this dialect/database support commenting on tables, columns, etc?
|
boolean |
supportsCurrentTimestampSelection()
HSQLDB 1.8.x requires CALL CURRENT_TIMESTAMP but this should not
be treated as a callable statement.
|
boolean |
supportsEmptyInList()
Does this dialect support empty IN lists?
<p/>
For example, is [where XYZ in ()] a supported construct?
|
boolean |
supportsIfExistsAfterTableName()
For dropping a table, can the phrase "if exists" be applied after the table name?
<p/>
NOTE : Only one or the other (or neither) of this and
Dialect.supportsIfExistsBeforeTableName() should return true |
boolean |
supportsLimit()
Does this dialect support some form of limiting query results
via a SQL clause?
|
boolean |
supportsLobValueChangePropogation()
Does the dialect support propagating changes to LOB
values back to the database? Talking about mutating the
internal value of the locator as opposed to supplying a new
locator instance…
<p/>
For BLOBs, the internal value might be changed by:
Blob.setBinaryStream(long) ,
Blob.setBytes(long, byte[]) ,
Blob.setBytes(long, byte[], int, int) ,
or Blob.truncate(long) . |
boolean |
supportsLockTimeouts()
Informational metadata about whether this dialect is known to support
specifying timeouts for requested lock acquisitions.
|
boolean |
supportsNamedParameters(DatabaseMetaData databaseMetaData)
Override the DatabaseMetaData#supportsNamedParameters()
|
boolean |
supportsPooledSequences()
Does this dialect support "pooled" sequences.
|
boolean |
supportsSequences()
Does this dialect support sequences?
|
boolean |
supportsTupleDistinctCounts()
Does this dialect support
count(distinct a,b) ? |
boolean |
supportsUnionAll()
Does this dialect support UNION ALL, which is generally a faster
variant of UNION?
|
String |
toBooleanValueString(boolean bool)
The SQL literal value to which this database maps boolean values.
|
addSqlHintOrComment, appendLockHint, appendLockHint, applyLocksToSql, areStringComparisonsCaseInsensitive, augmentRecognizedTableTypes, bindLimitParametersInReverseOrder, buildIdentifierHelper, buildSQLExceptionConversionDelegate, buildSQLExceptionConverter, canCreateCatalog, canCreateSchema, cast, cast, cast, closeQuote, contributeTypes, convertToFirstRowValue, createCaseFragment, createOuterJoinFragment, defaultScrollMode, dropConstraints, escapeLiteral, forceLimitUsage, forceLobAsLastValue, forUpdateOfColumns, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAddUniqueConstraintString, getAlterTableString, getAuxiliaryDatabaseObjectExporter, getCallableStatementSupport, getCascadeConstraintsString, getCaseInsensitiveLike, getCastTypeName, getColumnAliasExtractor, getColumnComment, getCreateCatalogCommand, getCreateMultisetTableString, getCreateSchemaCommand, getCreateSequenceStrings, getCreateSequenceStrings, getCreateTableString, getCrossJoinSeparator, getCurrentSchemaCommand, getDefaultBatchLoadSizingStrategy, getDefaultProperties, getDialect, getDialect, getDropCatalogCommand, getDropForeignKeyString, getDropSchemaCommand, getDropSequenceStrings, getDropTableString, getForeignKeyExporter, getForUpdateNowaitString, getForUpdateNowaitString, getForUpdateSkipLockedString, getForUpdateSkipLockedString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getFunctions, getHibernateTypeName, getHibernateTypeName, getIndexExporter, getInExpressionCountLimit, getKeywords, getLimitString, getLobMergeStrategy, getLowercaseFunction, getMaxAliasLength, getNativeIdentifierGeneratorClass, getNativeIdentifierGeneratorStrategy, getNoColumnsInsertString, getNotExpression, getNullColumnString, getQueryHintString, getQueryHintString, getReadLockString, getReadLockString, getResultSet, getResultSet, getResultSet, getSchemaNameResolver, getSelectGUIDString, getSequenceExporter, getSequenceInformationExtractor, getSqlTypeDescriptorOverride, getTableComment, getTableExporter, getTableTypeString, getTypeName, getTypeName, getUniqueDelegate, getUniqueKeyExporter, getWriteLockString, getWriteLockString, hasAlterTable, hasSelfReferentialForeignKeyBug, inlineLiteral, isJdbcLogWarningsEnabledByDefault, isLegacyLimitHandlerBehaviorEnabled, isLockTimeoutParameterized, isTypeNameRegistered, openQuote, prependComment, qualifyIndexName, quote, registerColumnType, registerColumnType, registerFunction, registerHibernateType, registerHibernateType, registerKeyword, registerResultSetOutParameter, registerResultSetOutParameter, remapSqlTypeDescriptor, renderOrderByElement, replaceResultVariableInOrderByClauseWithPosition, requiresParensForTupleDistinctCounts, supportsBindAsCallableArgument, supportsCascadeDelete, supportsCaseInsensitiveLike, supportsCircularCascadeDeleteConstraints, supportsExistsInSelect, supportsExpectedLobUsagePattern, supportsIfExistsAfterAlterTable, supportsIfExistsAfterConstraintName, supportsIfExistsBeforeConstraintName, supportsIfExistsBeforeTableName, supportsLimitOffset, supportsNationalizedTypes, supportsNonQueryWithCTE, supportsNotNullUnique, supportsNoWait, supportsOuterJoinForUpdate, supportsParametersInInsertSelect, supportsPartitionBy, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsRowValueConstructorSyntax, supportsRowValueConstructorSyntaxInInList, supportsSkipLocked, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTupleCounts, supportsTuplesInSubqueries, supportsUnboundedLobLocatorMaterialization, supportsUnique, supportsUniqueConstraintInCreateAlterTable, supportsValuesList, supportsVariableLimit, toString, transformSelectString, useFollowOnLocking, useFollowOnLocking, useInputStreamToInsertBlob, useMaxForLimit
public String getAddColumnString()
Dialect
The syntax used to add a column to a table (optional).
getAddColumnString
in class Dialect
public boolean supportsLockTimeouts()
Dialect
Informational metadata about whether this dialect is known to support specifying timeouts for requested lock acquisitions.
supportsLockTimeouts
in class Dialect
public String getForUpdateString()
Dialect
Get the string to append to SELECT statements to acquire locks for this dialect.
getForUpdateString
in class Dialect
public LimitHandler getLimitHandler()
Dialect
Returns the delegate managing LIMIT clause.
getLimitHandler
in class Dialect
public boolean supportsLimit()
Dialect
Does this dialect support some form of limiting query results via a SQL clause?
supportsLimit
in class Dialect
public String getLimitString(String sql, boolean hasOffset)
Dialect
Apply s limit clause to the query.
<p/>
Typically dialects utilize variable
limit clauses when they support limits. Thus, when building the
select command we do not actually need to know the limit or the offest
since we will just be using placeholders.
<p/>
Here we do still pass along whether or not an offset was specified
so that dialects not supporting offsets can generate proper exceptions.
In general, dialects will override one or the other of this method and
Dialect.getLimitString(String, int, int)
.
getLimitString
in class Dialect
sql
- The query to which to apply the limit.hasOffset
- Is the query requesting an offset?public boolean bindLimitParametersFirst()
Dialect
Does the <tt>LIMIT</tt> clause come at the start of the <tt>SELECT</tt> statement, rather than at the end?
bindLimitParametersFirst
in class Dialect
public boolean supportsIfExistsAfterTableName()
Dialect
For dropping a table, can the phrase "if exists" be applied after the table name?
<p/>
NOTE : Only one or the other (or neither) of this and Dialect.supportsIfExistsBeforeTableName()
should return true
supportsIfExistsAfterTableName
in class Dialect
true
if the "if exists" can be applied after the table namepublic boolean supportsColumnCheck()
Dialect
Does this dialect support column-level check constraints?
supportsColumnCheck
in class Dialect
public boolean supportsSequences()
Dialect
Does this dialect support sequences?
supportsSequences
in class Dialect
public boolean supportsPooledSequences()
Dialect
Does this dialect support "pooled" sequences. Not aware of a better name for this. Essentially can we specify the initial and increment values?
supportsPooledSequences
in class Dialect
Dialect.getCreateSequenceStrings(String, int, int)
,
Dialect.getCreateSequenceString(String, int, int)
protected String getCreateSequenceString(String sequenceName)
HSQL will start with 0, by default. In order for Hibernate to know that this not transient, manually start with 1.
getCreateSequenceString
in class Dialect
sequenceName
- The name of the sequenceprotected String getCreateSequenceString(String sequenceName, int initialValue, int incrementSize) throws MappingException
Because of the overridden getCreateSequenceString(String)
, we must also override
getCreateSequenceString(String, int, int)
to prevent 2 instances of "start with".
getCreateSequenceString
in class Dialect
sequenceName
- The name of the sequenceinitialValue
- The initial value to apply to 'create sequence' statementincrementSize
- The increment value to apply to 'create sequence' statementMappingException
- If sequences are not supported.protected String getDropSequenceString(String sequenceName)
Dialect
Typically dialects which support sequences can drop a sequence
with a single command. This is convenience form of
Dialect.getDropSequenceStrings(java.lang.String)
to help facilitate that.
<p/>
Dialects which support sequences and can drop a sequence in a
single command need only override this method. Dialects
which support sequences but require multiple commands to drop
a sequence should instead override Dialect.getDropSequenceStrings(java.lang.String)
.
getDropSequenceString
in class Dialect
sequenceName
- The name of the sequencepublic String getSelectSequenceNextValString(String sequenceName)
Dialect
Generate the select expression fragment that will retrieve the next
value of a sequence as part of another (typically DML) statement.
<p/>
This differs from Dialect.getSequenceNextValString(String)
in that this
should return an expression usable within another statement.
getSelectSequenceNextValString
in class Dialect
sequenceName
- the name of the sequencepublic String getSequenceNextValString(String sequenceName)
Dialect
Generate the appropriate select statement to to retrieve the next value of a sequence. <p/> This should be a "stand alone" select statement.
getSequenceNextValString
in class Dialect
sequenceName
- the name of the sequencepublic String getQuerySequencesString()
Dialect
Get the select command used retrieve the names of all sequences.
getQuerySequencesString
in class Dialect
SchemaUpdate
public ViolatedConstraintNameExtracter getViolatedConstraintNameExtracter()
getViolatedConstraintNameExtracter
in interface ConversionContext
getViolatedConstraintNameExtracter
in class Dialect
public String getSelectClauseNullString(int sqlType)
Dialect
Given a Types
type code, determine an appropriate
null value to use in a select clause.
<p/>
One thing to consider here is that certain databases might
require proper casting for the nulls here since the select here
will be part of a UNION/UNION ALL.
getSelectClauseNullString
in class Dialect
sqlType
- The Types
type code.public boolean supportsUnionAll()
Dialect
Does this dialect support UNION ALL, which is generally a faster variant of UNION?
supportsUnionAll
in class Dialect
public MultiTableBulkIdStrategy getDefaultMultiTableBulkIdStrategy()
getDefaultMultiTableBulkIdStrategy
in class Dialect
public boolean supportsCurrentTimestampSelection()
HSQLDB 1.8.x requires CALL CURRENT_TIMESTAMP but this should not be treated as a callable statement. It is equivalent to "select current_timestamp from dual" in some databases. HSQLDB 2.0 also supports VALUES CURRENT_TIMESTAMP <p/>
Does this dialect support a way to retrieve the database’s current timestamp value?
supportsCurrentTimestampSelection
in class Dialect
public boolean isCurrentTimestampSelectStringCallable()
Dialect
Should the value returned by Dialect.getCurrentTimestampSelectString()
be treated as callable. Typically this indicates that JDBC escape
syntax is being used…
isCurrentTimestampSelectStringCallable
in class Dialect
Dialect.getCurrentTimestampSelectString()
return
is callable; false otherwise.public String getCurrentTimestampSelectString()
Dialect
Retrieve the command used to retrieve the current timestamp from the database.
getCurrentTimestampSelectString
in class Dialect
public String getCurrentTimestampSQLFunctionName()
Dialect
The name of the database-specific SQL function for retrieving the current timestamp.
getCurrentTimestampSQLFunctionName
in class Dialect
public LockingStrategy getLockingStrategy(Lockable lockable, LockMode lockMode)
For HSQLDB 2.0, this is a copy of the base class implementation. For HSQLDB 1.8, only READ_UNCOMMITTED is supported. <p/>
Get a strategy instance which knows how to acquire a database-level lock of the specified mode for this dialect.
getLockingStrategy
in class Dialect
lockable
- The persister for the entity to be locked.lockMode
- The type of lock to be acquired.public boolean supportsCommentOn()
Dialect
Does this dialect/database support commenting on tables, columns, etc?
supportsCommentOn
in class Dialect
true
if commenting is supportedpublic boolean supportsEmptyInList()
Dialect
Does this dialect support empty IN lists? <p/> For example, is [where XYZ in ()] a supported construct?
supportsEmptyInList
in class Dialect
public boolean requiresCastingOfParametersInSelectClause()
Dialect
Does this dialect require that parameters appearing in the <tt>SELECT</tt> clause be wrapped in <tt>cast()</tt> calls to tell the db parser the expected type.
requiresCastingOfParametersInSelectClause
in class Dialect
public boolean doesReadCommittedCauseWritersToBlockReaders()
Dialect
For the underlying database, is READ_COMMITTED isolation implemented by forcing readers to wait for write locks to be released?
doesReadCommittedCauseWritersToBlockReaders
in class Dialect
public boolean doesRepeatableReadCauseReadersToBlockWriters()
Dialect
For the underlying database, is REPEATABLE_READ isolation implemented by forcing writers to wait for read locks to be released?
doesRepeatableReadCauseReadersToBlockWriters
in class Dialect
public boolean supportsLobValueChangePropogation()
Dialect
Does the dialect support propagating changes to LOB
values back to the database? Talking about mutating the
internal value of the locator as opposed to supplying a new
locator instance…
<p/>
For BLOBs, the internal value might be changed by:
Blob.setBinaryStream(long)
,
Blob.setBytes(long, byte[])
,
Blob.setBytes(long, byte[], int, int)
,
or Blob.truncate(long)
.
<p/>
For CLOBs, the internal value might be changed by:
Clob.setAsciiStream(long)
,
Clob.setCharacterStream(long)
,
Clob.setString(long, String)
,
Clob.setString(long, String, int, int)
,
or Clob.truncate(long)
.
<p/>
NOTE : I do not know the correct answer currently for
databases which (1) are not part of the cruise control process
or (2) do not Dialect.supportsExpectedLobUsagePattern()
.
supportsLobValueChangePropogation
in class Dialect
public String toBooleanValueString(boolean bool)
Dialect
The SQL literal value to which this database maps boolean values.
toBooleanValueString
in class Dialect
bool
- The boolean valuepublic boolean supportsTupleDistinctCounts()
Dialect
Does this dialect support count(distinct a,b)
?
supportsTupleDistinctCounts
in class Dialect
public IdentityColumnSupport getIdentityColumnSupport()
Dialect
Get the appropriate IdentityColumnSupport
getIdentityColumnSupport
in class Dialect
public NameQualifierSupport getNameQualifierSupport()
Dialect
By default interpret this based on DatabaseMetaData.
getNameQualifierSupport
in class Dialect
public boolean supportsNamedParameters(DatabaseMetaData databaseMetaData) throws SQLException
Dialect
Override the DatabaseMetaData#supportsNamedParameters()
supportsNamedParameters
in class Dialect
SQLException
- Accessing the DatabaseMetaData can throw it. Just re-throw and Hibernate will handle.Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.