org.datanucleus.store.rdbms.adapter
Class McKoiAdapter

java.lang.Object
  org.datanucleus.store.rdbms.adapter.DatabaseAdapter
      org.datanucleus.store.rdbms.adapter.McKoiAdapter

All Implemented Interfaces:

org.datanucleus.store.mapped.DatastoreAdapter, RDBMSAdapter

public class McKoiAdapter
extends DatabaseAdapter

Provides methods for adapting SQL language elements to the McKoi database Server database.

Field Summary

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

catalogSeparator, datastoreMajorVersion, datastoreMinorVersion, datastoreProductName, datastoreProductVersion, datastoreRevisionVersion, driverMajorVersion, driverMinorVersion, driverName, driverVersion, identifierQuoteString, LOCALISER, LOCALISER_BASE, maxColumnNameLength, maxConstraintNameLength, maxIndexNameLength, maxTableNameLength, properties, reservedKeywords, supportedOptions

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

ACCESS_PARENTQUERY_IN_SUBQUERY_JOINED, ALTER_TABLE_DROP_CONSTRAINT_SYNTAX, ALTER_TABLE_DROP_FOREIGN_KEY_CONSTRAINT, ANSI_CROSSJOIN_SYNTAX, ANSI_JOIN_SYNTAX, AUTO_INCREMENT_COLUMN_TYPE_SPECIFICATION, AUTO_INCREMENT_KEYS_NULL_SPECIFICATION, AUTO_INCREMENT_PK_IN_CREATE_TABLE_COLUMN_DEF, BLOB_SET_USING_SETSTRING, 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, 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, INCLUDE_ORDERBY_COLS_IN_SELECT, LOCK_OPTION_PLACED_AFTER_FROM, LOCK_OPTION_PLACED_WITHIN_JOIN, LOCK_WITH_SELECT_FOR_UPDATE, NULL_EQUALS_EMPTY_STRING, NULLS_IN_CANDIDATE_KEYS, NULLS_KEYWORD_IN_COLUMN_OPTIONS, ORDERBY_USING_SELECT_COLUMN_INDEX, PERSIST_OF_UNASSIGNED_CHAR, PRIMARYKEY_IN_CREATE_STATEMENTS, STATEMENT_BATCHING, STORED_PROCEDURES, 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_MULTITABLE, USE_UNION_ALL, VIEWS

Fields inherited from interface org.datanucleus.store.mapped.DatastoreAdapter

ANALYSIS_METHODS, BIT_IS_REALLY_BOOLEAN, BOOLEAN_COMPARISON, CATALOGS_IN_TABLE_DEFINITIONS, ESCAPE_EXPRESSION_IN_LIKE_PREDICATE, IDENTIFIERS_LOWERCASE, IDENTIFIERS_LOWERCASE_QUOTED, IDENTIFIERS_MIXEDCASE, IDENTIFIERS_MIXEDCASE_QUOTED, IDENTIFIERS_MIXEDCASE_QUOTED_SENSITIVE, IDENTIFIERS_MIXEDCASE_SENSITIVE, IDENTIFIERS_UPPERCASE, IDENTIFIERS_UPPERCASE_QUOTED, IDENTITY_COLUMNS, PROJECTION_IN_TABLE_REFERENCE_JOINS, SCHEMAS_IN_TABLE_DEFINITIONS, SEQUENCES

Constructor Summary

McKoiAdapter(DatabaseMetaData metadata)
Constructs a McKoi SQL adapter based on the given JDBC metadata.

Method Summary

String	getAddColumnStatement(org.datanucleus.store.mapped.DatastoreContainerObject table, Column col) Accessor for the SQL statement to add a column to a table.
int	getDatastoreIdentifierMaxLength(org.datanucleus.store.mapped.IdentifierType identifierType) Method to return the maximum length of a datastore identifier of the specified type.
String	getDropTableStatement(org.datanucleus.store.mapped.DatastoreContainerObject table) Returns the appropriate SQL to drop the given table.
int	getRequiredTransactionIsolationLevel() Accessor for the "required" transaction isolation level if it has to be a certain value for this adapter.
String	getSequenceCreateStmt(String sequence_name, Integer min, Integer max, Integer start, Integer increment, Integer cache_size) Accessor for the sequence statement to create the sequence.
String	getSequenceNextStmt(String sequence_name) Accessor for the statement for getting the next id from the sequence for this datastore.
String	getVendorID()
boolean	isKeyword(String word) Tests if a given string is a SQL key word.
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.DatabaseAdapter

addSQLTypeForJDBCType, getAdapterTime, getAddCandidateKeyStatement, getAddForeignKeyStatement, getAddPrimaryKeyStatement, getAutoIncrementKeyword, getAutoIncrementStmt, getCatalogName, getCatalogSeparator, getCheckConstraintForValues, getColumns, getContinuationString, getCreateIndexStatement, getCreateTableStatement, getDatastoreDateStatement, getDatastoreDriverName, getDatastoreDriverVersion, getDatastoreProductName, getDatastoreProductVersion, getDeleteTableStatement, getDriverMajorVersion, getDriverMinorVersion, getDropViewStatement, getEscapeCharacter, getEscapePatternExpression, getExistingIndexes, getIdentifierQuoteString, getInsertStatementForNoColumns, getMappingManager, getMaxForeignKeys, getMaxIndexes, getMiliseconds, getNewUUIDFunction, getNumericConversionFunction, getOperatorConcat, getOrderString, getPatternExpressionAnyCharacter, getPatternExpressionZeroMoreCharacters, getRangeByLimitEndOfStatementClause, getRangeByRowNumberColumn, getRangeByRowNumberColumn2, getSchemaName, getSelectForUpdateText, getSelectNewUUIDStmt, getSelectWithLockOption, getSQLTypeInfoForJdbcType, getSupportedOptions, getSurrogateForEmptyStrings, getTime, getTransactionIsolationForSchemaCreation, getUnlimitedLengthPrecisionValue, getValueForProperty, initialiseDatastore, initialiseTypes, isIdentityFieldDataType, isReservedKeyword, isStatementCancel, isStatementTimeout, isValidPrimaryKeyType, iteratorReservedWords, newFKInfo, newRDBMSColumnInfo, parseKeywordList, removeUnsupportedMappings, setProperties, supportsOption, supportsQueryFetchSize, supportsTransactionIsolation, toString, validToSelectMappingInStatement

Methods inherited from class java.lang.Object

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

Constructor Detail

McKoiAdapter

public McKoiAdapter(DatabaseMetaData metadata)

Constructs a McKoi SQL adapter based on the given JDBC metadata.

Parameters:

metadata - the database metadata.

Method Detail

getVendorID

public String getVendorID()

Specified by:

getVendorID in interface org.datanucleus.store.mapped.DatastoreAdapter

Overrides:

getVendorID in class DatabaseAdapter

isKeyword

public boolean isKeyword(String word)

Description copied from class: DatabaseAdapter

Tests if a given string is a SQL key word.

The list of key words tested against is defined to contain all SQL/92 key words, plus any additional key words reported by the JDBC driver for this adapter via DatabaseMetaData.getSQLKeywords().

In general, use of a SQL key word as an identifier should be avoided. SQL/92 key words are divided into reserved and non-reserved words. If a reserved word is used as an identifier it must be quoted with double quotes. Strictly speaking, the same is not true of non-reserved words. However, as C.J. Date writes in A Guide To The SQL Standard :

The rule by which it is determined within the standard that one key word needs to be reserved while another need not is not clear to this writer. In practice, it is probably wise to treat all key words as reserved.

Overrides:

isKeyword in class DatabaseAdapter

Parameters:

word - The word to test.

Returns:

true if word is a SQL key word for this DBMS. The comparison is case-insensitive.

See Also:

SQLConstants

getDatastoreIdentifierMaxLength

public int getDatastoreIdentifierMaxLength(org.datanucleus.store.mapped.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 org.datanucleus.store.mapped.DatastoreAdapter

Overrides:

getDatastoreIdentifierMaxLength in class DatabaseAdapter

Parameters:

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

Returns:

The max permitted length of this type of identifier

getAddColumnStatement

public String getAddColumnStatement(org.datanucleus.store.mapped.DatastoreContainerObject table,
                                    Column col)

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

Specified by:

getAddColumnStatement in interface RDBMSAdapter

Overrides:

getAddColumnStatement in class DatabaseAdapter

Parameters:

table - The table

col - The column

Returns:

The SQL necessary to add the column

newSQLTypeInfo

public SQLTypeInfo newSQLTypeInfo(ResultSet rs)

Description copied from interface: RDBMSAdapter

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 RDBMSAdapter

Overrides:

newSQLTypeInfo in class DatabaseAdapter

Parameters:

rs - ResultSet

Returns:

The SQL type info

getRequiredTransactionIsolationLevel

public int getRequiredTransactionIsolationLevel()

Accessor for the "required" transaction isolation level if it has to be a certain value for this adapter. McKoi requires TRANSACTION_SERIALIZABLE.

Specified by:

getRequiredTransactionIsolationLevel in interface RDBMSAdapter

Overrides:

getRequiredTransactionIsolationLevel in class DatabaseAdapter

Returns:

Transaction isolation level (-1 implies no restriction)

getDropTableStatement

public String getDropTableStatement(org.datanucleus.store.mapped.DatastoreContainerObject table)

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

 DROP TABLE FOO
 

Specified by:

getDropTableStatement in interface RDBMSAdapter

Overrides:

getDropTableStatement in class DatabaseAdapter

Parameters:

table - The table to drop.

Returns:

The text of the SQL statement.

getSequenceCreateStmt

public String getSequenceCreateStmt(String sequence_name,
                                    Integer min,
                                    Integer max,
                                    Integer start,
                                    Integer increment,
                                    Integer cache_size)

Accessor for the sequence statement to create the sequence.

Specified by:

getSequenceCreateStmt in interface RDBMSAdapter

Overrides:

getSequenceCreateStmt in class DatabaseAdapter

Parameters:

sequence_name - 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

cache_size - Cache size for the sequence

Returns:

The statement for getting the next id from the sequence

getSequenceNextStmt

public String getSequenceNextStmt(String sequence_name)

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

Specified by:

getSequenceNextStmt in interface RDBMSAdapter

Overrides:

getSequenceNextStmt in class DatabaseAdapter

Parameters:

sequence_name - Name of the sequence

Returns:

The statement for getting the next id for the sequence