org.datanucleus.store.rdbms.adapter

Class FirebirdAdapter

java.lang.Object

org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

org.datanucleus.store.rdbms.adapter.FirebirdAdapter

All Implemented Interfaces:

DatastoreAdapter

public class FirebirdAdapter
extends BaseDatastoreAdapter

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

See Also:

BaseDatastoreAdapter

Nested Class Summary

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

BaseDatastoreAdapter.DatastoreTypeMappings

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, properties, 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, ANALYSIS_METHODS, ANSI_CROSSJOIN_SYNTAX, ANSI_JOIN_SYNTAX, AUTO_INCREMENT_COLUMN_TYPE_SPECIFICATION, AUTO_INCREMENT_KEYS_NULL_SPECIFICATION, AUTO_INCREMENT_PK_IN_CREATE_TABLE_COLUMN_DEF, 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, 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_COLUMNS, INCLUDE_ORDERBY_COLS_IN_SELECT, LOCK_OPTION_PLACED_AFTER_FROM, LOCK_OPTION_PLACED_WITHIN_JOIN, LOCK_WITH_SELECT_FOR_UPDATE, 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, RESULTSET_TYPE_FORWARD_ONLY, RESULTSET_TYPE_SCROLL_INSENSITIVE, RESULTSET_TYPE_SCROLL_SENSITIVE, RIGHT_OUTER_JOIN, SCHEMAS_IN_TABLE_DEFINITIONS, SELECT_FOR_UPDATE_NOWAIT, 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 and Description
FirebirdAdapter(DatabaseMetaData metadata)

Method Summary

Modifier and Type	Method and Description
String	getAddPrimaryKeyStatement(PrimaryKey pk, IdentifierFactory factory) Firebird accepts the PK in the CREATE TABLE statement.
String	getDropTableStatement(Table table) Returns the appropriate SQL to drop the given table.
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 ROWS keyword.
String	getSequenceCreateStmt(String sequenceName, Integer min, Integer max, Integer start, Integer increment, Integer cacheSize) Accessor for the sequence create statement for this datastore.
String	getSequenceNextStmt(String sequenceName) Accessor for the sequence statement to get the next id 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).
String	getVendorID() Accessor for the Vendor ID for this datastore.
protected void	loadDatastoreMappings(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.
boolean	supportsCharLengthFunction()

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

addSQLTypeForJDBCType, deregisterDatastoreMappingsForJDBCType, getAdapterTime, getAddCandidateKeyStatement, getAddColumnStatement, getAddForeignKeyStatement, getAutoIncrementJavaTypeForType, getAutoIncrementKeyword, getAutoIncrementStmt, getCatalogName, getCatalogSeparator, getCheckConstraintForValues, getColumns, getContinuationString, getCreateDatabaseStatement, getCreateIndexStatement, getCreateTableStatement, getDatastoreDateStatement, getDatastoreDriverName, getDatastoreDriverVersion, getDatastoreIdentifierMaxLength, getDatastoreMappingClass, getDatastoreProductName, getDatastoreProductVersion, getDefaultSqlTypeForJavaType, getDeleteTableStatement, getDriverMajorVersion, getDriverMinorVersion, getDropDatabaseStatement, getDropViewStatement, getEscapeCharacter, getEscapePatternExpression, getExistingIndexes, getIdentifierQuoteString, getInsertStatementForNoColumns, getJDBCTypeForName, getMappingManager, getMaxForeignKeys, getMaxIndexes, getMiliseconds, getNameForJDBCType, getNewUUIDFunction, getNumericConversionFunction, getOrderString, getPatternExpressionAnyCharacter, getPatternExpressionZeroMoreCharacters, getRangeByRowNumberColumn, getRangeByRowNumberColumn2, getRequiredTransactionIsolationLevel, getSchemaName, getSelectForUpdateText, getSelectNewUUIDStmt, getSelectWithLockOption, getSQLOperationClass, getSQLTypeInfoForJdbcType, getSupportedOptions, getSurrogateForEmptyStrings, getTime, getTransactionIsolationForSchemaCreation, getUnlimitedLengthPrecisionValue, getUpdateTableStatement, getValueForProperty, initialise, initialiseDatastore, initialiseTypes, isIdentityFieldDataType, isReservedKeyword, isStatementCancel, isStatementTimeout, isValidPrimaryKeyType, iteratorReservedWords, newFKInfo, newRDBMSColumnInfo, registerDatastoreMapping, registerDatastoreMapping, sequenceExists, setProperties, 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

FirebirdAdapter

public FirebirdAdapter(DatabaseMetaData metadata)

Method Detail

getVendorID

public String getVendorID()

Description copied from interface: DatastoreAdapter

Accessor for the Vendor ID for this datastore.

Specified by:

getVendorID in interface DatastoreAdapter

Overrides:

getVendorID in class BaseDatastoreAdapter

Returns:

Vendor id for this datastore

getDropTableStatement

public String getDropTableStatement(Table table)

Description copied from class: BaseDatastoreAdapter

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

 DROP TABLE FOO CASCADE
 

Specified by:

getDropTableStatement in interface DatastoreAdapter

Overrides:

getDropTableStatement in class BaseDatastoreAdapter

Parameters:

table - The table to drop.

Returns:

The text of the SQL statement.

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

getAddPrimaryKeyStatement

public String getAddPrimaryKeyStatement(PrimaryKey pk,
                                        IdentifierFactory factory)

Firebird accepts the PK in the CREATE TABLE statement.

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

getSequenceCreateStmt

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

Accessor for the sequence create statement for this datastore.

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 sequence statement to get the next id 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

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

supportsCharLengthFunction

public boolean supportsCharLengthFunction()

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

loadDatastoreMappings

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

Load all datastore mappings for this RDBMS database.

Overrides:

loadDatastoreMappings in class BaseDatastoreAdapter

Parameters:

mgr - the PluginManager

clr - the ClassLoaderResolver