Package org.datanucleus.store.rdbms.adapter

Class HSQLAdapter

java.lang.Object

org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

org.datanucleus.store.rdbms.adapter.HSQLAdapter

All Implemented Interfaces:

DatastoreAdapter

public class HSQLAdapter
extends BaseDatastoreAdapter

Provides methods for adapting SQL language elements to the HSQLDB database.

Nested Class Summary

Nested classes/interfaces inherited from class org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

BaseDatastoreAdapter.ColumnTypeMappings

Field Summary

Fields inherited from class org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

catalogSeparator, datastoreMajorVersion, datastoreMinorVersion, datastoreProductName, datastoreProductVersion, datastoreRevisionVersion, driverMajorVersion, driverMinorVersion, driverName, driverVersion, identifierQuoteString, MAX_IDENTIFIER_LENGTH, maxColumnNameLength, maxConstraintNameLength, maxIndexNameLength, maxTableNameLength, NONRESERVED_WORDS, reservedKeywords, SQL2003_RESERVED_WORDS, SQL92_RESERVED_WORDS, SQL99_RESERVED_WORDS, supportedJdbcTypesById, supportedOptions, unsupportedJdbcTypesById

Fields inherited from interface org.datanucleus.store.rdbms.adapter.DatastoreAdapter

ACCESS_PARENTQUERY_IN_SUBQUERY_JOINED, ALTER_TABLE_DROP_CONSTRAINT_SYNTAX, ALTER_TABLE_DROP_FOREIGN_KEY_CONSTRAINT, ANSI_CROSSJOIN_SYNTAX, ANSI_JOIN_SYNTAX, BIT_IS_REALLY_BOOLEAN, BLOB_SET_USING_SETSTRING, BOOLEAN_COMPARISON, CATALOGS_IN_TABLE_DEFINITIONS, CHAR_COLUMNS_PADDED_WITH_SPACES, CHECK_IN_CREATE_STATEMENTS, CHECK_IN_END_CREATE_STATEMENTS, CLOB_SET_USING_SETSTRING, COLUMN_LENGTH_SEMANTICS, CREATE_INDEX_COLUMN_ORDERING, CREATE_INDEXES_BEFORE_FOREIGN_KEYS, CROSSJOIN_ASINNER11_SYNTAX, DATETIME_STORES_MILLISECS, DEFAULT_BEFORE_NULL_IN_COLUMN_OPTIONS, DEFAULT_KEYWORD_IN_COLUMN_OPTIONS, DEFAULT_KEYWORD_WITH_NOT_NULL_IN_COLUMN_OPTIONS, DEFERRED_CONSTRAINTS, DISTINCT_WITH_SELECT_FOR_UPDATE, ESCAPE_EXPRESSION_IN_LIKE_PREDICATE, EXISTS_SYNTAX, FK_DELETE_ACTION_CASCADE, FK_DELETE_ACTION_DEFAULT, FK_DELETE_ACTION_NULL, FK_DELETE_ACTION_RESTRICT, FK_IN_END_CREATE_STATEMENTS, FK_UPDATE_ACTION_CASCADE, FK_UPDATE_ACTION_DEFAULT, FK_UPDATE_ACTION_NULL, FK_UPDATE_ACTION_RESTRICT, GET_GENERATED_KEYS_STATEMENT, GROUP_BY_REQUIRES_ALL_SELECT_PRIMARIES, GROUPING_WITH_SELECT_FOR_UPDATE, HAVING_WITH_SELECT_FOR_UPDATE, HOLD_CURSORS_OVER_COMMIT, IDENTIFIERS_LOWERCASE, IDENTIFIERS_LOWERCASE_QUOTED, IDENTIFIERS_MIXEDCASE, IDENTIFIERS_MIXEDCASE_QUOTED, IDENTIFIERS_MIXEDCASE_QUOTED_SENSITIVE, IDENTIFIERS_MIXEDCASE_SENSITIVE, IDENTIFIERS_UPPERCASE, IDENTIFIERS_UPPERCASE_QUOTED, IDENTITY_COLUMN_TYPE_SPECIFICATION, IDENTITY_COLUMNS, IDENTITY_KEYS_NULL_SPECIFICATION, IDENTITY_PK_IN_CREATE_TABLE_COLUMN_DEF, INCLUDE_ORDERBY_COLS_IN_SELECT, LOCK_ROW_USING_OPTION_AFTER_FROM, LOCK_ROW_USING_OPTION_WITHIN_JOIN, LOCK_ROW_USING_SELECT_FOR_UPDATE, LOCK_ROW_USING_SELECT_FOR_UPDATE_NOWAIT, MULTITABLES_WITH_SELECT_FOR_UPDATE, NATIVE_ENUM_TYPE, NULL_EQUALS_EMPTY_STRING, NULLS_IN_CANDIDATE_KEYS, NULLS_KEYWORD_IN_COLUMN_OPTIONS, OPERATOR_BITWISE_AND, OPERATOR_BITWISE_OR, OPERATOR_BITWISE_XOR, ORDERBY_NULLS_DIRECTIVES, ORDERBY_NULLS_USING_CASE_NULL, ORDERBY_NULLS_USING_COLUMN_IS_NULL, ORDERBY_NULLS_USING_ISNULL, ORDERBY_USING_SELECT_COLUMN_INDEX, ORDERING_WITH_SELECT_FOR_UPDATE, PARAMETER_IN_CASE_IN_UPDATE_CLAUSE, PERSIST_OF_UNASSIGNED_CHAR, PRIMARYKEY_IN_CREATE_STATEMENTS, PROJECTION_IN_TABLE_REFERENCE_JOINS, RAW_PREFIX_LIKE_STATEMENTS, RESULTSET_TYPE_FORWARD_ONLY, RESULTSET_TYPE_SCROLL_INSENSITIVE, RESULTSET_TYPE_SCROLL_SENSITIVE, RIGHT_OUTER_JOIN, SCHEMAS_IN_TABLE_DEFINITIONS, SEQUENCES, SOME_ANY_ALL_SUBQUERY_EXPRESSIONS, STATEMENT_BATCHING, STORED_PROCEDURES, SUBQUERY_IN_HAVING, TX_ISOLATION_NONE, TX_ISOLATION_READ_COMMITTED, TX_ISOLATION_READ_UNCOMMITTED, TX_ISOLATION_REPEATABLE_READ, TX_ISOLATION_SERIALIZABLE, UNION_SYNTAX, UNIQUE_IN_END_CREATE_STATEMENTS, UPDATE_DELETE_STATEMENT_ALLOW_TABLE_ALIAS_IN_WHERE_CLAUSE, UPDATE_STATEMENT_ALLOW_TABLE_ALIAS_IN_SET_CLAUSE, USE_UNION_ALL, VALUE_GENERATION_UUID_STRING, VIEWS

Constructor Summary

Constructors

Constructor	Description
HSQLAdapter(DatabaseMetaData metadata)	Constructs a HSQLDB adapter based on the given JDBC metadata.

Method Summary

Modifier and Type	Method	Description
String	getAddColumnStatement(Table table, Column col)	Accessor for the SQL statement to add a column to a table.
String	getAddPrimaryKeyStatement(PrimaryKey pk, IdentifierFactory factory)	Add a primary key using ALTER TABLE.
String	getDatastoreDateStatement()	Accessor for a statement that will return the statement to use to get the datastore date.
int	getDatastoreIdentifierMaxLength(IdentifierType identifierType)	Method to return the maximum length of a datastore identifier of the specified type.
String	getDropDatabaseStatement(String catalogName, String schemaName)	Method to return the statement necessary to drop a database with this RDBMS.
String	getDropTableStatement(Table table)	Returns the appropriate SQL to drop the given table.
String	getIdentityKeyword(org.datanucleus.store.StoreManager storeMgr)	Accessor for the auto-increment keyword for generating DDLs (CREATE TABLEs...).
String	getIdentityLastValueStmt(Table table, String columnName)	Accessor for the auto-increment sql statement for this datastore.
String	getInsertStatementForNoColumns(Table table)	Method to return the INSERT statement to use when inserting into a table that has no columns specified.
String	getRangeByLimitEndOfStatementClause(long offset, long count, boolean hasOrdering)	Method to return the SQL to append to the WHERE clause of a SELECT statement to handle restriction of ranges using the LIMIT keyword.
String	getSchemaName(Connection conn)	Accessor for the Schema Name for this datastore.
String	getSequenceCreateStmt(String sequenceName, Integer min, Integer max, Integer start, Integer increment, Integer cacheSize)	Accessor for the sequence statement to create the sequence.
String	getSequenceNextStmt(String sequenceName)	Accessor for the statement for getting the next id from the sequence for this datastore.
Class	getSQLMethodClass(String className, String methodName, org.datanucleus.ClassLoaderResolver clr)	Accessor for the SQLMethod class for the query invocation of specified class + method name (if available for this datastore).
Class	getSQLOperationClass(String operationName)	Accessor for the SQLOperation class for the specified operation (if available for this datastore).
String	getVendorID()	Accessor for the vendor ID for this adapter.
void	initialiseTypes(org.datanucleus.store.schema.StoreSchemaHandler handler, org.datanucleus.store.connection.ManagedConnection mconn)	Initialise the types for this datastore.
boolean	isValidPrimaryKeyType(org.datanucleus.metadata.JdbcType datatype)	Accessor for whether the specified type is allow to be part of a PK.
protected void	loadColumnMappings(org.datanucleus.plugin.PluginManager mgr, org.datanucleus.ClassLoaderResolver clr)	Load all datastore mappings for this RDBMS database.
SQLTypeInfo	newSQLTypeInfo(ResultSet rs)	Create a new SQL type info from the current row of the passed ResultSet.

Methods inherited from class org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

addSQLTypeForJDBCType, deregisterColumnMappingsForJDBCType, getAdapterTime, getAddCandidateKeyStatement, getAddForeignKeyStatement, getCatalogName, getCatalogSeparator, getCheckConstraintForValues, getColumnMappingClass, getColumns, getContinuationString, getCreateDatabaseStatement, getCreateIndexStatement, getCreateTableStatement, getDatastoreDriverName, getDatastoreDriverVersion, getDatastoreProductName, getDatastoreProductVersion, getDefaultSqlTypeForJavaType, getDeleteTableStatement, getDriverMajorVersion, getDriverMinorVersion, getDropViewStatement, getEscapeCharacter, getEscapePatternExpression, getExistingIndexes, getIdentifierQuoteString, getIdentityJavaTypeForType, getJDBCTypeForName, getMappingManager, getMaxForeignKeys, getMaxIndexes, getMiliseconds, getNameForJDBCType, getNewUUIDFunction, getNumericConversionFunction, getOrderString, getPatternExpressionAnyCharacter, getPatternExpressionZeroMoreCharacters, getPreferredDefaultSQLTypeForJDBCType, getRangeByRowNumberColumn, getRangeByRowNumberColumn2, getRequiredTransactionIsolationLevel, getReservedWords, getSelectForUpdateText, getSelectNewUUIDStmt, getSelectWithLockOption, getSQLTypeInfoForJdbcType, getSupportedOptions, getSurrogateForEmptyStrings, getTime, getTransactionIsolationForSchemaCreation, getUnlimitedLengthPrecisionValue, getUpdateTableStatement, initialise, initialiseDatastore, isIdentityFieldDataType, isReservedKeyword, isStatementCancel, isStatementTimeout, newFKInfo, newRDBMSColumnInfo, registerColumnMapping, registerColumnMapping, sequenceExists, supportsOption, supportsQueryFetchSize, supportsTransactionIsolation, toString, validToIndexMapping, validToSelectMappingInStatement

Methods inherited from class java.lang.Object

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

Constructor Detail

HSQLAdapter

public HSQLAdapter(DatabaseMetaData metadata)

Constructs a HSQLDB adapter based on the given JDBC metadata.

Parameters:

metadata - the database metadata.

Method Detail

initialiseTypes

public void initialiseTypes(org.datanucleus.store.schema.StoreSchemaHandler handler,
                            org.datanucleus.store.connection.ManagedConnection mconn)

Initialise the types for this datastore.

Specified by:

initialiseTypes in interface DatastoreAdapter

Overrides:

initialiseTypes in class BaseDatastoreAdapter

Parameters:

handler - SchemaHandler that we initialise the types for

mconn - Managed connection to use

getVendorID

public String getVendorID()

Accessor for the vendor ID for this adapter.

Specified by:

getVendorID in interface DatastoreAdapter

Overrides:

getVendorID in class BaseDatastoreAdapter

Returns:

The vendor ID

getDatastoreIdentifierMaxLength

public int getDatastoreIdentifierMaxLength(IdentifierType identifierType)

Method to return the maximum length of a datastore identifier of the specified type. If no limit exists then returns -1

Specified by:

getDatastoreIdentifierMaxLength in interface DatastoreAdapter

Overrides:

getDatastoreIdentifierMaxLength in class BaseDatastoreAdapter

Parameters:

identifierType - Type of identifier (see IdentifierFactory.TABLE, etc)

Returns:

The max permitted length of this type of identifier

getDropDatabaseStatement

public String getDropDatabaseStatement(String catalogName,
                                       String schemaName)

Description copied from interface: DatastoreAdapter

Method to return the statement necessary to drop a database with this RDBMS. Note that some RDBMS don't support this.

Specified by:

getDropDatabaseStatement in interface DatastoreAdapter

Overrides:

getDropDatabaseStatement in class BaseDatastoreAdapter

Parameters:

catalogName - Name of the catalog

schemaName - Name of the schema

Returns:

The DDL statement

getAddColumnStatement

public String getAddColumnStatement(Table table,
                                    Column col)

Accessor for the SQL statement to add a column to a table.

Specified by:

getAddColumnStatement in interface DatastoreAdapter

Overrides:

getAddColumnStatement in class BaseDatastoreAdapter

Parameters:

table - The table

col - The column

Returns:

The SQL necessary to add the column

getRangeByLimitEndOfStatementClause

public String getRangeByLimitEndOfStatementClause(long offset,
                                                  long count,
                                                  boolean hasOrdering)

Method to return the SQL to append to the WHERE clause of a SELECT statement to handle restriction of ranges using the LIMIT keyword.

Specified by:

getRangeByLimitEndOfStatementClause in interface DatastoreAdapter

Overrides:

getRangeByLimitEndOfStatementClause in class BaseDatastoreAdapter

Parameters:

offset - The offset to return from

count - The number of items to return

hasOrdering - Whether ordering is present

Returns:

The SQL to append to allow for ranges using LIMIT.

newSQLTypeInfo

public SQLTypeInfo newSQLTypeInfo(ResultSet rs)

Description copied from interface: DatastoreAdapter

Create a new SQL type info from the current row of the passed ResultSet. Allows an adapter to override particular types where the JDBC driver is known to be buggy.

Specified by:

newSQLTypeInfo in interface DatastoreAdapter

Overrides:

newSQLTypeInfo in class BaseDatastoreAdapter

Parameters:

rs - ResultSet

Returns:

The SQL type info

getSchemaName

public String getSchemaName(Connection conn)
                     throws SQLException

Accessor for the Schema Name for this datastore. HSQLDB 1.7.0 does not support schemas (catalog).

Specified by:

getSchemaName in interface DatastoreAdapter

Overrides:

getSchemaName in class BaseDatastoreAdapter

Parameters:

conn - Connection to the datastore

Returns:

The schema name

Throws:

SQLException - Thrown if error occurs in determining the schema name.

getAddPrimaryKeyStatement

public String getAddPrimaryKeyStatement(PrimaryKey pk,
                                        IdentifierFactory factory)

Add a primary key using ALTER TABLE. We use CREATE TABLE for this.

Specified by:

getAddPrimaryKeyStatement in interface DatastoreAdapter

Overrides:

getAddPrimaryKeyStatement in class BaseDatastoreAdapter

Parameters:

pk - An object describing the primary key.

factory - Identifier factory

Returns:

The PK statement

getDropTableStatement

public String getDropTableStatement(Table table)

Returns the appropriate SQL to drop the given table. It should return something like:

 DROP TABLE FOO
 

Specified by:

getDropTableStatement in interface DatastoreAdapter

Overrides:

getDropTableStatement in class BaseDatastoreAdapter

Parameters:

table - The table to drop.

Returns:

The text of the SQL statement.

getIdentityLastValueStmt

public String getIdentityLastValueStmt(Table table,
                                       String columnName)

Accessor for the auto-increment sql statement for this datastore.

Specified by:

getIdentityLastValueStmt in interface DatastoreAdapter

Overrides:

getIdentityLastValueStmt in class BaseDatastoreAdapter

Parameters:

table - Name of the table that the autoincrement is for

columnName - Name of the column that the autoincrement is for

Returns:

The statement for getting the latest auto-increment key

getIdentityKeyword

public String getIdentityKeyword(org.datanucleus.store.StoreManager storeMgr)

Accessor for the auto-increment keyword for generating DDLs (CREATE TABLEs...).

Specified by:

getIdentityKeyword in interface DatastoreAdapter

Overrides:

getIdentityKeyword in class BaseDatastoreAdapter

Parameters:

storeMgr - The Store Manager

Returns:

The keyword for a column using auto-increment

getInsertStatementForNoColumns

public String getInsertStatementForNoColumns(Table table)

Method to return the INSERT statement to use when inserting into a table that has no columns specified. This is the case when we have a single column in the table and that column is autoincrement/identity (and so is assigned automatically in the datastore).

Specified by:

getInsertStatementForNoColumns in interface DatastoreAdapter

Overrides:

getInsertStatementForNoColumns in class BaseDatastoreAdapter

Parameters:

table - The table

Returns:

The INSERT statement

isValidPrimaryKeyType

public boolean isValidPrimaryKeyType(org.datanucleus.metadata.JdbcType datatype)

Accessor for whether the specified type is allow to be part of a PK.

Specified by:

isValidPrimaryKeyType in interface DatastoreAdapter

Overrides:

isValidPrimaryKeyType in class BaseDatastoreAdapter

Parameters:

datatype - The JDBC type

Returns:

Whether it is permitted in the PK

getDatastoreDateStatement

public String getDatastoreDateStatement()

Accessor for a statement that will return the statement to use to get the datastore date.

Specified by:

getDatastoreDateStatement in interface DatastoreAdapter

Overrides:

getDatastoreDateStatement in class BaseDatastoreAdapter

Returns:

SQL statement to get the datastore date

getSequenceCreateStmt

public String getSequenceCreateStmt(String sequenceName,
                                    Integer min,
                                    Integer max,
                                    Integer start,
                                    Integer increment,
                                    Integer cacheSize)

Accessor for the sequence statement to create the sequence.

Specified by:

getSequenceCreateStmt in interface DatastoreAdapter

Overrides:

getSequenceCreateStmt in class BaseDatastoreAdapter

Parameters:

sequenceName - Name of the sequence

min - Minimum value for the sequence

max - Maximum value for the sequence

start - Start value for the sequence

increment - Increment value for the sequence

cacheSize - Cache size for the sequence

Returns:

The statement for getting the next id from the sequence

getSequenceNextStmt

public String getSequenceNextStmt(String sequenceName)

Accessor for the statement for getting the next id from the sequence for this datastore.

Specified by:

getSequenceNextStmt in interface DatastoreAdapter

Overrides:

getSequenceNextStmt in class BaseDatastoreAdapter

Parameters:

sequenceName - Name of the sequence

Returns:

The statement for getting the next id for the sequence

getSQLOperationClass

public Class getSQLOperationClass(String operationName)

Description copied from interface: DatastoreAdapter

Accessor for the SQLOperation class for the specified operation (if available for this datastore).

Specified by:

getSQLOperationClass in interface DatastoreAdapter

Overrides:

getSQLOperationClass in class BaseDatastoreAdapter

Parameters:

operationName - operation name

Returns:

SQLOperation class (or null if none available)

getSQLMethodClass

public Class getSQLMethodClass(String className,
                               String methodName,
                               org.datanucleus.ClassLoaderResolver clr)

Description copied from interface: DatastoreAdapter

Accessor for the SQLMethod class for the query invocation of specified class + method name (if available for this datastore).

Specified by:

getSQLMethodClass in interface DatastoreAdapter

Overrides:

getSQLMethodClass in class BaseDatastoreAdapter

Parameters:

className - Name of the class (or null if this is a STATIC method)

methodName - Method name

clr - ClassLoader resolver, in case className is a subclass of a supported type

Returns:

The SQLMethod class (or null if not defined for this datastore).

loadColumnMappings

protected void loadColumnMappings(org.datanucleus.plugin.PluginManager mgr,
                                  org.datanucleus.ClassLoaderResolver clr)

Load all datastore mappings for this RDBMS database.

Overrides:

loadColumnMappings in class BaseDatastoreAdapter

Parameters:

mgr - the PluginManager

clr - the ClassLoaderResolver