net.java.ao.db

Class NuoDBDatabaseProvider

java.lang.Object

net.java.ao.DatabaseProvider

net.java.ao.db.NuoDBDatabaseProvider

All Implemented Interfaces:

Disposable

public class NuoDBDatabaseProvider
extends DatabaseProvider

Author:

Philip Stoev

Nested Class Summary

Nested classes/interfaces inherited from class net.java.ao.DatabaseProvider

DatabaseProvider.RenderFieldOptions, DatabaseProvider.SqlListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set<java.lang.String>	RESERVED_WORDS

Fields inherited from class net.java.ao.DatabaseProvider

logger, quoteRef, sqlLogger, typeManager

Constructor Summary

Constructors

Constructor and Description
NuoDBDatabaseProvider(DisposableDataSource dataSource)
NuoDBDatabaseProvider(DisposableDataSource dataSource, java.lang.String schema)

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<java.lang.String>	getReservedWords() Retrieves the set of all reserved words for the underlying database.
java.sql.ResultSet	getTables(java.sql.Connection conn) Workaround for DB-7451 transaction isolation level SERIALIZABLE will not show tables created or altered with auto-commit off.
protected void	loadQuoteString()
java.lang.Object	parseValue(int type, java.lang.String value) Parses the database-agnostic String value relevant to the specified SQL type in int form (as defined by Types and returns the Java value which corresponds.
void	putNull(java.sql.PreparedStatement stmt, int index) The sql type argument is mandatory in JDBC for some reason, but is ignored by NuoDB JDBC, so any integer value can be used.
protected java.lang.Iterable<SQLAction>	renderAccessoriesForField(NameConverters nameConverters, DDLTable table, DDLField field) Create indices on field being altered.
protected java.lang.Iterable<SQLAction>	renderAlterTableChangeColumn(NameConverters nameConverters, DDLTable table, DDLField oldField, DDLField field) Generates the database-specific DDL statements required to change the given column from its old specification to the given DDL value.
protected SQLAction	renderAlterTableDropKey(DDLForeignKey key) Generates the database-specific DDL statement required to remove a foreign key from a table.
protected java.lang.String	renderAutoIncrement() Generates the DDL fragment required to specify an INTEGER field as auto-incremented.
protected java.lang.String	renderConstraintsForTable(UniqueNameConverter uniqueNameConverter, DDLTable table) Renders the foreign key constraints in database-specific DDL for the table in question.
protected SQLAction	renderCreateIndex(IndexNameConverter indexNameConverter, DDLIndex index) Generates the database-specific DDL statement required to create a new index.
protected java.lang.Iterable<SQLAction>	renderDropAccessoriesForField(NameConverters nameConverters, DDLTable table, DDLField field) Drop indices on field being altered.
protected SQLAction	renderDropIndex(IndexNameConverter indexNameConverter, DDLIndex index) Generates the database-specific DDL statement required to drop an index.
protected DatabaseProvider.RenderFieldOptions	renderFieldOptionsInAlterColumn()
protected java.lang.String	renderForeignKey(DDLForeignKey key) Foreign keys which reference primary table aren't supported because of a open issue and are rendered in commentary block.

Methods inherited from class net.java.ao.DatabaseProvider

_getFunctionNameForField, _getTriggerNameForField, _renderDropFunctionForField, _renderDropSequenceForField, _renderDropTriggerForField, _renderFunctionForField, _renderSequenceForField, _renderTriggerForField, addSqlListener, commitTransaction, convertTypeToString, dispose, executeInsertReturningKey, executeUpdate, executeUpdateForAction, executeUpdatesForActions, findForeignKeysForField, getConnection, getDateFormat, getImportedKeys, getIndexes, getMaxIDLength, getSchema, getSequences, getTypeManager, handleBlob, handleUpdateError, hasIndex, hasIndex, insertReturningKey, isCaseSensitive, isNumericType, isSchemaNotEmpty, onSql, preparedStatement, preparedStatement, preparedStatement, processID, processOnClause, processOrderClause, processTableName, processWhereClause, putBoolean, querySelectFields, queryTableName, quote, quoteTableName, removeSqlListener, renderAccessories, renderAction, renderAlterTableAddColumn, renderAlterTableAddColumnStatement, renderAlterTableAddKey, renderAlterTableChangeColumnStatement, renderAlterTableDropColumn, renderAlterTableDropColumnStatement, renderAppend, renderCreateCompositeIndex, renderDate, renderDropAccessories, renderDropColumnActions, renderDropTableStatement, renderField, renderFieldDefault, renderFields, renderFieldType, renderInsert, renderMetadataQuery, renderPrimaryKey, renderQuery, renderQueryGroupBy, renderQueryHaving, renderQueryJoins, renderQueryLimit, renderQueryOrderBy, renderQuerySelect, renderQueryWhere, renderTable, renderUnique, renderValue, rollbackTransaction, setPostConnectionProperties, setQueryResultSetProperties, setQueryStatementProperties, shorten, shouldQuoteID, shouldQuoteTableName, startTransaction, withSchema

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED_WORDS

public static final java.util.Set<java.lang.String> RESERVED_WORDS

Constructor Detail

NuoDBDatabaseProvider

public NuoDBDatabaseProvider(DisposableDataSource dataSource)

NuoDBDatabaseProvider

public NuoDBDatabaseProvider(DisposableDataSource dataSource,
                             java.lang.String schema)

Method Detail

getTables

public java.sql.ResultSet getTables(java.sql.Connection conn)
                             throws java.sql.SQLException

Workaround for DB-7451 transaction isolation level SERIALIZABLE will not show tables created or altered with auto-commit off.

Overrides:

getTables in class DatabaseProvider

Parameters:

conn - The connection to use in retrieving the database tables.

Returns:

Throws:

java.sql.SQLException

See Also:

DatabaseMetaData.getTables(String, String, String, String[])

renderAutoIncrement

protected java.lang.String renderAutoIncrement()

Description copied from class: DatabaseProvider

Generates the DDL fragment required to specify an INTEGER field as auto-incremented. For databases which do not support such flags (which is just about every database exception MySQL), "" is an acceptable return value. This method should never return null as it would cause the field rendering method to throw a NullPointerException.

Overrides:

renderAutoIncrement in class DatabaseProvider

renderFieldOptionsInAlterColumn

protected DatabaseProvider.RenderFieldOptions renderFieldOptionsInAlterColumn()

Overrides:

renderFieldOptionsInAlterColumn in class DatabaseProvider

renderAlterTableChangeColumn

protected java.lang.Iterable<SQLAction> renderAlterTableChangeColumn(NameConverters nameConverters,
                                                                     DDLTable table,
                                                                     DDLField oldField,
                                                                     DDLField field)

Description copied from class: DatabaseProvider

Generates the database-specific DDL statements required to change the given column from its old specification to the given DDL value. This method will also generate the appropriate statements to remove old triggers and functions, as well as add new ones according to the requirements of the new field definition.

The default implementation of this method functions in the manner specified by the MySQL database. Some databases will have to perform more complicated actions (such as dropping and re-adding the field) in order to satesfy the same use-case. Such databases should print a warning to stderr to ensure that the end-developer is aware of such restrictions.

Thus, the specification for this method allows for data loss. Nevertheless, if the database supplies a mechanism to accomplish the task without data loss, it should be applied.

For maximum flexibility, the default implementation of this method only deals with the dropping and addition of functions and triggers. The actual generation of the ALTER TABLE statement is done in the DatabaseProvider.renderAlterTableChangeColumnStatement(net.java.ao.schema.NameConverters, net.java.ao.schema.ddl.DDLTable, net.java.ao.schema.ddl.DDLField, net.java.ao.schema.ddl.DDLField, net.java.ao.DatabaseProvider.RenderFieldOptions) method.

Overrides:

renderAlterTableChangeColumn in class DatabaseProvider

table - The table containing the column to change.

oldField - The old column definition.

field - The new column definition (defining the resultant DDL). @return An array of DDL statements to be executed.

See Also:

#getTriggerNameForField(net.java.ao.schema.TriggerNameConverter, net.java.ao.schema.ddl.DDLTable, net.java.ao.schema.ddl.DDLField), #getFunctionNameForField(net.java.ao.schema.TriggerNameConverter, net.java.ao.schema.ddl.DDLTable, net.java.ao.schema.ddl.DDLField), #renderFunctionForField(net.java.ao.schema.TriggerNameConverter, net.java.ao.schema.ddl.DDLTable, net.java.ao.schema.ddl.DDLField), #renderTriggerForField(net.java.ao.schema.TriggerNameConverter, net.java.ao.schema.SequenceNameConverter, net.java.ao.schema.ddl.DDLTable, net.java.ao.schema.ddl.DDLField)

renderDropAccessoriesForField

protected java.lang.Iterable<SQLAction> renderDropAccessoriesForField(NameConverters nameConverters,
                                                                      DDLTable table,
                                                                      DDLField field)

Drop indices on field being altered.

Overrides:

renderDropAccessoriesForField in class DatabaseProvider

Returns:

an ordered list of SQLActions

renderAccessoriesForField

protected java.lang.Iterable<SQLAction> renderAccessoriesForField(NameConverters nameConverters,
                                                                  DDLTable table,
                                                                  DDLField field)

Create indices on field being altered.

Overrides:

renderAccessoriesForField in class DatabaseProvider

Returns:

an ordered list of SQLActions

renderCreateIndex

protected SQLAction renderCreateIndex(IndexNameConverter indexNameConverter,
                                      DDLIndex index)

Description copied from class: DatabaseProvider

Generates the database-specific DDL statement required to create a new index. The syntax for this operation is highly standardized and thus it is unlikely this method will be overridden. If the database in question does not support indexes, a warning should be printed to stderr and null returned.

Overrides:

renderCreateIndex in class DatabaseProvider

index - The index to create. This single instance contains all of the data necessary to create the index, thus no separate parameters (such as a DDLTable) are required.

Returns:

A DDL statement to be executed.

renderDropIndex

protected SQLAction renderDropIndex(IndexNameConverter indexNameConverter,
                                    DDLIndex index)

Description copied from class: DatabaseProvider

Generates the database-specific DDL statement required to drop an index. The syntax for this operation is highly standardized and thus it is unlikely this method will be overridden. If the database in question does not support indexes, a warning should be printed to stderr and null returned.

Overrides:

renderDropIndex in class DatabaseProvider

index - The index to drop. This single instance contains all of the data necessary to drop the index, thus no separate parameters (such as a DDLTable) are required.

Returns:

A DDL statement to be executed, or null.

renderConstraintsForTable

protected java.lang.String renderConstraintsForTable(UniqueNameConverter uniqueNameConverter,
                                                     DDLTable table)

Description copied from class: DatabaseProvider

Renders the foreign key constraints in database-specific DDL for the table in question. Actually, this method only loops through the foreign keys and renders indentation and line-breaks. The actual rendering is done in a second delegate method.

Overrides:

renderConstraintsForTable in class DatabaseProvider

table - The database-agnostic DDL representation of the table in question.

Returns:

The String rendering of all of the foreign keys for the table.

See Also:

DatabaseProvider.renderForeignKey(DDLForeignKey)

renderForeignKey

protected java.lang.String renderForeignKey(DDLForeignKey key)

Foreign keys which reference primary table aren't supported because of a open issue and are rendered in commentary block.

Overrides:

renderForeignKey in class DatabaseProvider

Parameters:

key - The database-agnostic foreign key representation.

Returns:

renderAlterTableDropKey

protected SQLAction renderAlterTableDropKey(DDLForeignKey key)

Description copied from class: DatabaseProvider

Generates the database-specific DDL statement required to remove a foreign key from a table. For databases which do not support such a statement, a warning should be printed to stderr and a null value returned. This method assumes that the DatabaseProvider.renderForeignKey(DDLForeignKey) method properly names the foreign key according to the DDLForeignKey.getFKName() method.

Overrides:

renderAlterTableDropKey in class DatabaseProvider

Parameters:

key - The foreign key to be removed. As this instance contains all necessary data (such as domestic table, field, etc), no additional parameters are required.

Returns:

A DDL statement to be executed, or null.

loadQuoteString

protected void loadQuoteString()

Overrides:

loadQuoteString in class DatabaseProvider

parseValue

public java.lang.Object parseValue(int type,
                                   java.lang.String value)

Description copied from class: DatabaseProvider

Parses the database-agnostic String value relevant to the specified SQL type in int form (as defined by Types and returns the Java value which corresponds. This method is completely database-agnostic, as are all of all of its delegate methods.

WARNING: This method is being considered for removal to another class (perhaps TypeManager?) as it is not a database-specific function and thus confuses the purpose of this class. Do not rely upon it heavily. (better yet, don't rely on it at all from external code. It's not designed to be part of the public API)

Overrides:

parseValue in class DatabaseProvider

Parameters:

type - The JDBC integer type of the database field against which to parse the value.

value - The database-agnostic String value to parse into a proper Java object with respect to the specified SQL type.

Returns:

A Java value which corresponds to the specified String.

getReservedWords

protected java.util.Set<java.lang.String> getReservedWords()

Description copied from class: DatabaseProvider

Retrieves the set of all reserved words for the underlying database. The set returns should be speculative, meaning that it should include any possible reserved words, not just those for a particular version. As an implementation guideline, the Set instance returned from this method should guarentee O(1) lookup times, otherwise ORM performance will suffer greatly.

Specified by:

getReservedWords in class DatabaseProvider

Returns:

A set of upper case reserved words specific to the database.

putNull

public void putNull(java.sql.PreparedStatement stmt,
                    int index)
             throws java.sql.SQLException

The sql type argument is mandatory in JDBC for some reason, but is ignored by NuoDB JDBC, so any integer value can be used.

Overrides:

putNull in class DatabaseProvider

Parameters:

stmt - The statement in which to store the NULL value.

index - The index of the parameter which should be assigned NULL.

Throws:

java.sql.SQLException