public class

HSQLDialect

extends Dialect
java.lang.Object
   ↳ org.hibernate.dialect.Dialect
     ↳ org.hibernate.dialect.HSQLDialect

Class Overview

An SQL dialect compatible with HSQLDB (HyperSQL).

Note this version supports HSQLDB version 1.8 and higher, only.

Enhancements to version 3.5.0 GA to provide basic support for both HSQLDB 1.8.x and 2.0 Should work with Hibernate 3.2 and later

Summary

Nested Classes
class HSQLDialect.ReadUncommittedLockingStrategy  
[Expand]
Inherited Constants
From class org.hibernate.dialect.Dialect
Public Constructors
HSQLDialect()
Public Methods
boolean bindLimitParametersFirst()
Does the LIMIT clause come at the start of the SELECT 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?
boolean dropTemporaryTableAfterUse()
Do we need to drop the temporary table after use? todo - clarify usage by Hibernate Version 1.8 GLOBAL TEMPORARY table definitions persist beyond the end of the session (data is cleared).
String generateTemporaryTableName(String baseTableName)
With HSQLDB 2.0, the table name is qualified with MODULE to assist the drop statement (in-case there is a global name beginning with HT_)
String getAddColumnString()
The syntax used to add a column to a table (optional).
String getCreateTemporaryTablePostfix()
No fragment is needed if data is not needed beyond commit, otherwise should add "on commit preserve rows"
String getCreateTemporaryTableString()
Command used to create a temporary table.
String getCurrentTimestampSQLFunctionName()
The name of the database-specific SQL function for retrieving the current timestamp.
String getCurrentTimestampSelectString()
Retrieve the command used to retrieve the current timestamp from the database.
String getDropTemporaryTableString()
Command used to drop a temporary table.
String getForUpdateString()
Get the string to append to SELECT statements to acquire locks for this dialect.
String getIdentityColumnString()
The syntax used during DDL to define a column as being an IDENTITY.
String getIdentityInsertString()
The keyword used to insert a generated value into an identity column (or null).
String getIdentitySelectString()
Get the select command to use to retrieve the last generated IDENTITY value.
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.
String getQuerySequencesString()
Get the select command used retrieve the names of all sequences.
String getSelectClauseNullString(int sqlType)
Given a java.sql.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 getCurrentTimestampSelectString() be treated as callable.
Boolean performTemporaryTableDDLInIsolation()
Different behavior for GLOBAL TEMPORARY (1.8) and LOCAL TEMPORARY (2.0)

Possible return values and their meanings:

  • TRUE - Unequivocally, perform the temporary table DDL in isolation.
boolean requiresCastingOfParametersInSelectClause()
todo - needs usage clarification If the SELECT statement is always part of a UNION, then the type of parameter is resolved by v.
boolean supportsColumnCheck()
Does this dialect support column-level check constraints?
boolean supportsCommentOn()
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?

For example, is [where XYZ in ()] a supported construct?

boolean supportsIdentityColumns()
Does this dialect support identity column key generation?
boolean supportsIfExistsAfterTableName()
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...
boolean supportsLockTimeouts()
Informational metadata about whether this dialect is known to support specifying timeouts for requested lock acquisitions.
boolean supportsPooledSequences()
Does this dialect support "pooled" sequences.
boolean supportsSequences()
Does this dialect support sequences?
boolean supportsTemporaryTables()
Does this dialect support temporary tables?
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?
boolean supportsUnique()
Does this dialect support the UNIQUE column syntax?
String toBooleanValueString(boolean bool)
The SQL literal value to which this database maps boolean values.
Protected Methods
String getCreateSequenceString(String sequenceName)
Typically dialects which support sequences can create a sequence with a single command.
String getDropSequenceString(String sequenceName)
Typically dialects which support sequences can drop a sequence with a single command.
[Expand]
Inherited Methods
From class org.hibernate.dialect.Dialect
From class java.lang.Object

Public Constructors

public HSQLDialect ()

Public Methods

public boolean bindLimitParametersFirst ()

Does the LIMIT clause come at the start of the SELECT statement, rather than at the end?

Returns
  • true if limit parameters should come before other parameters

public boolean doesReadCommittedCauseWritersToBlockReaders ()

For the underlying database, is READ_COMMITTED isolation implemented by forcing readers to wait for write locks to be released?

Returns
  • True if writers block readers to achieve READ_COMMITTED; false otherwise.

public boolean doesRepeatableReadCauseReadersToBlockWriters ()

For the underlying database, is REPEATABLE_READ isolation implemented by forcing writers to wait for read locks to be released?

Returns
  • True if readers block writers to achieve REPEATABLE_READ; false otherwise.

public boolean dropTemporaryTableAfterUse ()

Do we need to drop the temporary table after use? todo - clarify usage by Hibernate Version 1.8 GLOBAL TEMPORARY table definitions persist beyond the end of the session (data is cleared). If there are not too many such tables, perhaps we can avoid dropping them and reuse the table next time?

Returns
  • True if the table should be dropped.

public String generateTemporaryTableName (String baseTableName)

With HSQLDB 2.0, the table name is qualified with MODULE to assist the drop statement (in-case there is a global name beginning with HT_)

Parameters
baseTableName The table name from which to base the temp table name.
Returns
  • The generated temp table name.

public String getAddColumnString ()

The syntax used to add a column to a table (optional).

Returns
  • The "add column" fragment.

public String getCreateTemporaryTablePostfix ()

No fragment is needed if data is not needed beyond commit, otherwise should add "on commit preserve rows"

Returns
  • Any required postfix.

public String getCreateTemporaryTableString ()

Command used to create a temporary table.

Returns
  • The command used to create a temporary table.

public String getCurrentTimestampSQLFunctionName ()

The name of the database-specific SQL function for retrieving the current timestamp.

Returns
  • The function name.

public String getCurrentTimestampSelectString ()

Retrieve the command used to retrieve the current timestamp from the database.

Returns
  • The command.

public String getDropTemporaryTableString ()

Command used to drop a temporary table.

Returns
  • The command used to drop a temporary table.

public String getForUpdateString ()

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

Returns
  • The appropriate FOR UPDATE clause string.

public String getIdentityColumnString ()

The syntax used during DDL to define a column as being an IDENTITY.

Returns
  • The appropriate DDL fragment.

public String getIdentityInsertString ()

The keyword used to insert a generated value into an identity column (or null). Need if the dialect does not support inserts that specify no column values.

Returns
  • The appropriate keyword.

public String getIdentitySelectString ()

Get the select command to use to retrieve the last generated IDENTITY value.

Returns
  • The appropriate select command

public String getLimitString (String sql, boolean hasOffset)

Apply s limit clause to the query.

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.

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 getLimitString(String, int, int).

Parameters
sql The query to which to apply the limit.
hasOffset Is the query requesting an offset?
Returns
  • the modified SQL

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.

Parameters
lockable The persister for the entity to be locked.
lockMode The type of lock to be acquired.
Returns
  • The appropriate locking strategy.

public String getQuerySequencesString ()

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

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

public String getSelectClauseNullString (int sqlType)

Given a java.sql.Types type code, determine an appropriate null value to use in a select clause.

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.

Parameters
sqlType The java.sql.Types type code.
Returns
  • The appropriate select clause value fragment.

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

This differs from getSequenceNextValString(String) in that this should return an expression usable within another statement.

Parameters
sequenceName the name of the sequence
Returns
  • The "nextval" fragment.

public String getSequenceNextValString (String sequenceName)

Generate the appropriate select statement to to retrieve the next value of a sequence.

This should be a "stand alone" select statement.

Parameters
sequenceName the name of the sequence
Returns
  • String The "nextval" select string.

public ViolatedConstraintNameExtracter getViolatedConstraintNameExtracter ()

public boolean isCurrentTimestampSelectStringCallable ()

Should the value returned by getCurrentTimestampSelectString() be treated as callable. Typically this indicates that JDBC escape syntax is being used...

Returns

public Boolean performTemporaryTableDDLInIsolation ()

Different behavior for GLOBAL TEMPORARY (1.8) and LOCAL TEMPORARY (2.0)

Possible return values and their meanings:

  • TRUE - Unequivocally, perform the temporary table DDL in isolation.
  • FALSE - Unequivocally, do not perform the temporary table DDL in isolation.
  • null - defer to the JDBC driver response in regards to dataDefinitionCausesTransactionCommit()

Returns
  • see the result matrix above.

public boolean requiresCastingOfParametersInSelectClause ()

todo - needs usage clarification If the SELECT statement is always part of a UNION, then the type of parameter is resolved by v. 2.0, but not v. 1.8 (assuming the other SELECT in the UNION has a column reference in the same position and can be type-resolved). On the other hand if the SELECT statement is isolated, all versions of HSQLDB require casting for "select ? from .." to work.

Returns
  • True if select clause parameter must be cast()ed

public boolean supportsColumnCheck ()

Does this dialect support column-level check constraints?

Returns
  • True if column-level CHECK constraints are supported; false otherwise.

public boolean supportsCommentOn ()

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

Returns
  • True if the current timestamp can be retrieved; false otherwise.

public boolean supportsEmptyInList ()

Does this dialect support empty IN lists?

For example, is [where XYZ in ()] a supported construct?

Returns
  • True if empty in lists are supported; false otherwise.

public boolean supportsIdentityColumns ()

Does this dialect support identity column key generation?

Returns
  • True if IDENTITY columns are supported; false otherwise.

public boolean supportsIfExistsAfterTableName ()

public boolean supportsLimit ()

Does this dialect support some form of limiting query results via a SQL clause?

Returns
  • True if this dialect supports some form of LIMIT.

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

For BLOBs, the internal value might be changed by: setBinaryStream(long), setBytes(long, byte[]), setBytes(long, byte[], int, int), or truncate(long).

For CLOBs, the internal value might be changed by: setAsciiStream(long), setCharacterStream(long), setString(long, String), setString(long, String, int, int), or truncate(long).

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 supportsExpectedLobUsagePattern().

Returns
  • True if the changes are propagated back to the database; false otherwise.

public boolean supportsLockTimeouts ()

Informational metadata about whether this dialect is known to support specifying timeouts for requested lock acquisitions.

Returns
  • True is this dialect supports specifying lock timeouts.

public boolean supportsPooledSequences ()

Does this dialect support "pooled" sequences. Not aware of a better name for this. Essentially can we specify the initial and increment values?

Returns
  • True if such "pooled" sequences are supported; false otherwise.

public boolean supportsSequences ()

Does this dialect support sequences?

Returns
  • True if sequences supported; false otherwise.

public boolean supportsTemporaryTables ()

Does this dialect support temporary tables?

Returns
  • True if temp tables are supported; false otherwise.

public boolean supportsTupleDistinctCounts ()

Does this dialect support `count(distinct a,b)`?

Returns
  • True if the database supports counting disintct tuples; false otherwise.

public boolean supportsUnionAll ()

Does this dialect support UNION ALL, which is generally a faster variant of UNION?

Returns
  • True if UNION ALL is supported; false otherwise.

public boolean supportsUnique ()

Does this dialect support the UNIQUE column syntax?

Returns
  • boolean

public String toBooleanValueString (boolean bool)

The SQL literal value to which this database maps boolean values.

Parameters
bool The boolean value
Returns
  • The appropriate SQL literal.

Protected Methods

protected String getCreateSequenceString (String sequenceName)

Typically dialects which support sequences can create a sequence with a single command. This is convenience form of getCreateSequenceStrings(String) to help facilitate that.

Dialects which support sequences and can create a sequence in a single command need *only* override this method. Dialects which support sequences but require multiple commands to create a sequence should instead override getCreateSequenceStrings(String).

Parameters
sequenceName The name of the sequence
Returns
  • The sequence creation command

protected String getDropSequenceString (String sequenceName)

Typically dialects which support sequences can drop a sequence with a single command. This is convenience form of getDropSequenceStrings(String) to help facilitate that.

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 getDropSequenceStrings(String).

Parameters
sequenceName The name of the sequence
Returns
  • The sequence drop commands