org.datanucleus.store.rdbms.adapter

Class NuoDBAdapter

java.lang.Object

org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

org.datanucleus.store.rdbms.adapter.NuoDBAdapter

All Implemented Interfaces:

DatastoreAdapter

public class NuoDBAdapter
extends BaseDatastoreAdapter

Adapter for NuoDB (http://www.nuodb.com). This adapter was written based on v2.0.2 of the NuoDB JDBC driver.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NONSQL92_RESERVED_WORDS
static String	NUODB_EXTRA_RESERVED_WORDS

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

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

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

ACCESS_PARENTQUERY_IN_SUBQUERY_JOINED, ALLOW_TABLE_ALIAS_IN_UPDATE_SET_CLAUSE, 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, 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, NULL_EQUALS_EMPTY_STRING, NULLS_IN_CANDIDATE_KEYS, NULLS_KEYWORD_IN_COLUMN_OPTIONS, ORDERBY_NULLS_DIRECTIVES, ORDERBY_USING_SELECT_COLUMN_INDEX, 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, SCHEMAS_IN_TABLE_DEFINITIONS, SEQUENCES, 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, USE_UNION_ALL, VIEWS

Constructor Summary

Constructors

Constructor and Description
NuoDBAdapter(DatabaseMetaData metadata)

Method Summary

Modifier and Type	Method and Description
String	getAddPrimaryKeyStatement(PrimaryKey pk, IdentifierFactory factory) Override the default implementation since we accept the PK in the CREATE TABLE statement.
String	getAutoIncrementKeyword() Accessor for the auto-increment keyword for generating DDLs (CREATE TABLEs...).
String	getCatalogName(Connection conn) Accessor for the Catalog Name for this datastore.
String	getCreateIndexStatement(Index idx, IdentifierFactory factory) Returns the appropriate DDL to create an index.
String	getDatastoreDateStatement() Accessor for a statement that will return the statement to use to get the datastore date.
String	getDropDatabaseStatement(String catalogName, String schemaName) Method to return the statement necessary to drop a database with this RDBMS.
String	getRangeByLimitEndOfStatementClause(long offset, long count) Method to return the SQL to append to the WHERE clause of a SELECT statement to handle restriction of ranges using the OFFSET/FETCH keywords.
String	getSchemaName(Connection conn) Accessor for the Schema Name for this datastore.
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() Accessor for the Vendor ID for this datastore.
void	initialiseTypes(org.datanucleus.store.schema.StoreSchemaHandler handler, org.datanucleus.store.connection.ManagedConnection mconn) Initialise the types for this datastore.
boolean	sequenceExists(Connection conn, String catalogName, String schemaName, String seqName) Convenience method to return whether the specified sequence already exists.

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

addSQLTypeForJDBCType, getAdapterTime, getAddCandidateKeyStatement, getAddColumnStatement, getAddForeignKeyStatement, getAutoIncrementJavaTypeForType, getAutoIncrementStmt, getCatalogSeparator, getCheckConstraintForValues, getColumns, getContinuationString, getCreateDatabaseStatement, getCreateTableStatement, getDatastoreDriverName, getDatastoreDriverVersion, getDatastoreIdentifierMaxLength, getDatastoreProductName, getDatastoreProductVersion, getDeleteTableStatement, getDriverMajorVersion, getDriverMinorVersion, getDropTableStatement, getDropViewStatement, getEscapeCharacter, getEscapePatternExpression, getExistingIndexes, getIdentifierQuoteString, getInsertStatementForNoColumns, getJDBCTypeForName, getMappingManager, getMaxForeignKeys, getMaxIndexes, getMiliseconds, getNameForJDBCType, getNewUUIDFunction, getNumericConversionFunction, getOperatorConcat, getOrderString, getPatternExpressionAnyCharacter, getPatternExpressionZeroMoreCharacters, getRangeByRowNumberColumn, getRangeByRowNumberColumn2, getRequiredTransactionIsolationLevel, getSelectForUpdateText, getSelectNewUUIDStmt, getSelectWithLockOption, getSQLTypeInfoForJdbcType, getSupportedOptions, getSurrogateForEmptyStrings, getTime, getTransactionIsolationForSchemaCreation, getUnlimitedLengthPrecisionValue, getUpdateTableStatement, getValueForProperty, initialiseDatastore, isIdentityFieldDataType, isReservedKeyword, isStatementCancel, isStatementTimeout, isValidPrimaryKeyType, iteratorReservedWords, newFKInfo, newRDBMSColumnInfo, newSQLTypeInfo, removeUnsupportedMappings, setProperties, supportsOption, supportsQueryFetchSize, supportsTransactionIsolation, toString, validToSelectMappingInStatement

Methods inherited from class java.lang.Object

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

Field Detail

NONSQL92_RESERVED_WORDS

public static final String NONSQL92_RESERVED_WORDS

See Also:

Constant Field Values

NUODB_EXTRA_RESERVED_WORDS

public static final String NUODB_EXTRA_RESERVED_WORDS

See Also:

Constant Field Values

Constructor Detail

NuoDBAdapter

public NuoDBAdapter(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

getCatalogName

public String getCatalogName(Connection conn)
                      throws SQLException

Description copied from class: BaseDatastoreAdapter

Accessor for the Catalog Name for this datastore.

Specified by:

getCatalogName in interface DatastoreAdapter

Overrides:

getCatalogName in class BaseDatastoreAdapter

Parameters:

conn - Connection to the datastore

Returns:

The catalog name

Throws:

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

getSchemaName

public String getSchemaName(Connection conn)
                     throws SQLException

Description copied from class: BaseDatastoreAdapter

Accessor for the Schema Name for this datastore.

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.

initialiseTypes

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

Description copied from class: BaseDatastoreAdapter

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

getCreateIndexStatement

public String getCreateIndexStatement(Index idx,
                                      IdentifierFactory factory)

Returns the appropriate DDL to create an index. It should return something like:

 CREATE INDEX FOO_N1 ON FOO (BAR,BAZ) [Extended Settings]
 CREATE UNIQUE INDEX FOO_U1 ON FOO (BAR,BAZ) [Extended Settings]
 

Specified by:

getCreateIndexStatement in interface DatastoreAdapter

Overrides:

getCreateIndexStatement in class BaseDatastoreAdapter

Parameters:

idx - An object describing the index.

factory - Identifier factory

Returns:

The text of the SQL statement.

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

getAddPrimaryKeyStatement

public String getAddPrimaryKeyStatement(PrimaryKey pk,
                                        IdentifierFactory factory)

Override the default implementation since we accept 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

sequenceExists

public boolean sequenceExists(Connection conn,
                              String catalogName,
                              String schemaName,
                              String seqName)

Description copied from interface: DatastoreAdapter

Convenience method to return whether the specified sequence already exists.

Specified by:

sequenceExists in interface DatastoreAdapter

Overrides:

sequenceExists in class BaseDatastoreAdapter

Parameters:

conn - Connection to use for checking

catalogName - Catalog name

schemaName - Schema name

seqName - Name of the sequence

Returns:

Whether it exists

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 DatastoreAdapter

Overrides:

getSequenceCreateStmt in class BaseDatastoreAdapter

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 DatastoreAdapter

Overrides:

getSequenceNextStmt in class BaseDatastoreAdapter

Parameters:

sequence_name - Name of the sequence

Returns:

The statement for getting the next id for the sequence

getAutoIncrementKeyword

public String getAutoIncrementKeyword()

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

Specified by:

getAutoIncrementKeyword in interface DatastoreAdapter

Overrides:

getAutoIncrementKeyword in class BaseDatastoreAdapter

Returns:

The keyword for a column using auto-increment

getRangeByLimitEndOfStatementClause

public String getRangeByLimitEndOfStatementClause(long offset,
                                                  long count)

Method to return the SQL to append to the WHERE clause of a SELECT statement to handle restriction of ranges using the OFFSET/FETCH keywords.

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

Returns:

The SQL to append to allow for ranges using OFFSET/FETCH.

getDatastoreDateStatement

public String getDatastoreDateStatement()

Description copied from class: BaseDatastoreAdapter

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