oracle.javatools.db

Class AbstractDatabase

java.lang.Object

oracle.javatools.db.AbstractDBObjectProvider

oracle.javatools.db.AbstractDatabase

All Implemented Interfaces:

Database, DBObjectProvider

Direct Known Subclasses:

DDLDatabase

public abstract class AbstractDatabase
extends AbstractDBObjectProvider
implements Database

Base implementation of the Database interface. AbstractDatabase can be subclassed to provide support for specific types of databases.

Since:

9.0.5

Field Summary

Fields inherited from class oracle.javatools.db.AbstractDBObjectProvider

CASE_SENSITIVE_NAME_POLICY, EMPTY_LIST, LOWER_CASE_NAME_POLICY, MIXED_CASE_NAME_POLICY, NEW_FROM_TEMPLATE_TYPE, TIMESTAMP_PROPERTY, UPPER_CASE_NAME_POLICY

Fields inherited from interface oracle.javatools.db.Database

FOUR_GIG, GENERIC_JDBC_DATABASE, PROVIDER_TYPE, SOURCE_TYPE_BODY, SOURCE_TYPE_SPEC, TWO_GIG

Fields inherited from interface oracle.javatools.db.DBObjectProvider

CREATE_PRIVILEDGE, DELETE_PRIVILEDGE, MODIFY_PRIVILEDGE, NEW_FROM_TEMPLATE_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDatabase(java.lang.String connStore, java.lang.String connName, java.sql.Connection conn) Constructs a new AbstractDatabase with the given connection information.
protected	AbstractDatabase(java.lang.String connStore, java.lang.String connName, java.sql.Connection conn, java.lang.String type, int version) Constructs a new AbstractDatabase with the given connection information.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelStatement() Cancels the Statement currently executing against this Database if: such a statement has been recorded by the use of a StatementWrapper/QueryWrapper both the DBMS and driver support aborting an SQL statement
boolean	canRestrictSchemaList() Whether this provider supports restricting the list of schemas to those with visible objects.
void	clearAllCaches() Clears all cached information in this provider that has been loaded from the underlying database.
void	close() Closes the Database Connection (and the supplied JDBC Connection).
DBObjectID	createID(Schema schema, java.lang.String name, java.lang.String type, java.lang.Object id)
DBObjectID	createID(java.lang.String dbName, Schema schema, java.lang.String name, java.lang.String type, java.lang.Object id)
protected Schema	createSchema(java.lang.String name)
boolean	exists(java.lang.String type, java.lang.String schema, java.lang.String name) Checks for existance of a schema object named objectName.
protected boolean	exists(SystemObject obj) Whether the specified object exists.
protected SystemObject	findOrCreateObject(DBObjectLister.ObjectInfo info, DBObjectCriteria criteria) Checks the cache for an existing object and if there isn't one creates a new object using the registered builder and marks it for lazy initialization.
protected SystemObject	findOrCreateObject(java.lang.String type, Schema schema, java.lang.String name, java.lang.Object idVal) Checks the cache for an existing object and if there isn't one creates a new object using the registered builder and marks it for lazy initialization.
protected SystemObject	findOrCreateObject(java.lang.String type, java.lang.String dbName, Schema schema, java.lang.String name, java.lang.Object idVal) Checks the cache for an existing object and if there isn't one creates a new object using the registered builder and marks it for lazy initialization.
protected SystemObject	findOrCreateObject(java.lang.String type, java.lang.String dbName, Schema schema, java.lang.String name, java.lang.Object idVal, java.lang.Long timestamp) Checks the cache for an existing object and if there isn't one creates a new object using the registered builder and marks it for lazy initialization.
protected void	finishCreate(SystemObject[] objects, SystemObject[] oldObjects) Deprecated. Replaced by finishUpdates.
protected void	finishDelete(SystemObject[] objs) Deprecated. Replaced by finishUpdates.
java.util.Collection<DBObjectChange>	finishUpdates(Difference listDiff) Processes the given objects after the DDL has been fired for a create, update or delete operation.
protected java.lang.String	getAliveTestStatement() Returns a statement that, if executed succesfully, tests whether the given connections is live.
java.lang.String	getCatalog() Gets the catalog from the database that we are connected to.
java.sql.Connection	getConnection() Gets the JDBC connection associated with this database.
java.sql.Connection	getConnection(boolean reconnect) Gets the JDBC connection associated with this database.
java.lang.String	getConnectionName() Retrieves the name for the Connection associated with this Database in whichever connection store it is stored in.
java.lang.String	getConnectionStore() Retrieves the connection store the Connection associated with this Database is stored in.
protected SystemObject	getCreatedObject(java.lang.String type, Schema schema, java.lang.String name) Used by finishCreate() to get the object that's just been created back from the database so that it can be verified before returning to the user.
protected java.lang.String	getCurrentSchemaName() Gets the name of the current (active) schema for the underlying database connection.
java.lang.String	getDatabaseSource(java.lang.String objectType, Schema schema, java.lang.String objectName) Retrieves the source for an object in the database.
java.lang.String	getDatabaseSource(java.lang.String objectType, Schema schema, java.lang.String objectName, java.lang.String sourceType) Retrieves the source for an object in the database.
java.lang.String	getDatabaseType() Gets the type of database.
int	getDatabaseVersion() Gets the version of the database for the api implementation.
java.lang.String	getDBExceptionMessage(java.sql.SQLException sqe) When a StatementWrapper encounters a SQLException when executing against the db, it calls this method with the SQLException to get a message for the wrapping DBSQLException that will be thrown.
Schema	getDefaultSchema() Returns the default schema for the connection or null if there isn't one.
DatabaseDescriptor	getDescriptor() Returns the DatabaseDescriptor for this provider.
java.lang.String	getName() The name of a provider is a displayable string that can be shown to the user to identify the provider.
protected <T extends SystemObject> T	getObjectImpl(DBObjectCriteria<T> criteria) getObject implementation for looking up a single object in the provider.
java.lang.Object	getProviderIdentifier() Gets the String that identifies this DBObjectProvider uniquely (within providers of the same type).
java.lang.String	getProviderType() Gets the String that identifies the type of DBObjectProvider this is an instance of.
java.lang.String	getQualifiedName() Retrieves a qualified name containing the connection store and connection name.
protected java.lang.String	getTransactionTestQuery()
java.lang.String	getUserName() Default implementation calls queryCurrentUserName() and caches the result until the Connection is closed.
boolean	hasTransaction() Tests whether there is currently a "transaction" open on the underlying java.sql.Connection.
boolean	isClosed() Tests whether the provider has been closed (e.g.
boolean	isConnectionAlive() Tests whether the connection underneath this Database is "alive" - i.e.
protected boolean	isConnectionAlive(java.sql.Connection conn) Implementation that checks whether the given (current) connection is alive.
java.lang.Boolean	isConnectionClosed(java.sql.SQLException sqe) This default implementation returns null unless the SQLException has a SQLState of "08003" - the ANSI standard for "closed connection".
boolean	isObjectValid(java.lang.String objectType, java.lang.String schema, java.lang.String objectName) Determines whether the specified database object is in a valid state.
static boolean	isSQLStateNotImplemented(java.sql.SQLException sqe) Tests whether the SQLState of the given exception is one of the standard jdbc states for "Not Implemented" - i.e.
boolean	isUnsupportedOperation(java.sql.SQLException sqe) Tests whether the given SQLException was thrown because a given operation was unsupported in the JDBC driver.
protected boolean	isUsernameCaseInsensitive() Deprecated. with no replacement. Override queryCurrentUserName() if the default logic is not sufficient to return an internal name.
protected java.lang.String	queryCatalog() Query the underlying Connection for the current catalog.
protected java.lang.String	queryCurrentSchemaName() Queries the database for the current schema name.
protected java.lang.String	queryCurrentUserName() Queries the current user name for the underlying Connection.
protected void	reconnect()
protected void	reconnected(java.sql.Connection c) Called when a reconnect happens to (re)initialise any member appropriately on the new Connection.
protected abstract void	registerBuilders() Called to request that the DBOBjectBuilders be registered.
protected void	registerValidators() By default this registers default validators for Schema, Sequences, Synonyms, Indexes, Constraints and Columns for the wizards to use.
void	setStatement(java.sql.Statement statement) Internal use only.
boolean	supportsDebugging() Whether this database instance supports JDWP debugging.
void	testSQLStatement(java.lang.String sql) Tests that the given SQL executes against the database.

Methods inherited from class oracle.javatools.db.AbstractDBObjectProvider

addObjectListener, addObjectListener, addObjectListener, addProviderListener, addProviderListener, cacheObject, canUpdate, checkCachedObject, commitTransaction, commitTransaction, convertObject, createObject, createObjectFactory, createObjectManager, createSchema, deleteObject, deleteSchema, destroyCache, ensureSystemObjectListDifference, findObject, findObject, findSchema, fireObjectsAdded, fireObjectsAdded, fireObjectsRemoved, fireObjectsRemoved, fireObjectUpdated, fireProviderClosed, fireProviderDeleted, fireProviderOpened, fireProviderReloaded, fireSchemaAdded, fireSchemaObjectUpdated, fireSchemaRemoved, fireSchemaUpdated, getBuilderForType, getCachedTimestamp, getCascadeManager, getCasePolicy, getDataType, getDDLGenerator, getDefaultSchemaName, getDefaultTemplateForType, getDescription, getDiffEngine, getExistingTimestamp, getExternalName, getExternalName, getExternalTimestamp, getExternalTimestampImpl, getIdentifierQuoteString, getInternalName, getInternalName, getLogger, getObject, getObject, getObjectFactory, getObjectManager, getOrCreateDataType, getPropertyManager, getQuotedNameCasePolicy, getSchema, getSchemaObjectExpanders, getTimestamp, getTimestamp, getUniqueName, getUniqueName, getUniqueNameTreatIndexAsSchemaObject, getValidatorForType, hasObjectPrivilege, hasPriviledge, hasSystemPrivilege, isEditable, isNewFromTemplateType, isRequestedObject, isRequestedObject, isValidName, isValidName, listObjects, listObjects, listObjects, listObjects, listObjects, listObjectsFromCache, listObjectsImpl, listObjectsImpl, listObjectsImpl, listObjectTypes, listSchemas, listSchemas, listSupportedDataTypes, loadObjectImpl, loadObjectImpl, loadObjectImpl, logEvent, markForLazyInit, markForLazyInit, normaliseType, putCachedTimestampKey, quoteIdentifier, registerBuilder, registerSchemaObjectExpander, registerType, registerValidator, removeObjectListener, removeProviderListener, removeProviderListener, resetObject, resetObject, resolveID, resolveIDImpl, resolveReferenceID, resolveUnspecifiedTypeID, resumeTimestampQueries, setDefaultTemplateForType, supportsObjectType, supportsTimestamps, supportsTimestamps, suspendTimestampQueries, uncacheObject, updateObject, updateObjects, updateObjects, updateSchema, validateName, validateName, validateObject, validateObject, validateObject, validateObject, validateObjectProperty, validateObjectProperty, validateObjectProperty, validateObjectProperty, validateSchema, validateSchema, validateUniqueName, validateUniqueName

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.javatools.db.Database

getIdentifierQuoteString

Methods inherited from interface oracle.javatools.db.DBObjectProvider

addObjectListener, addObjectListener, addObjectListener, addProviderListener, addProviderListener, canCreate, canDelete, canUpdate, commitTransaction, createObject, createObjects, createSchema, deleteObject, deleteObjects, deleteSchema, getCascadeManager, getDataType, getDDLGenerator, getDefaultTemplateForType, getDescription, getDiffEngine, getExternalName, getExternalName, getInternalName, getInternalName, getObject, getObject, getObjectFactory, getObjectManager, getOrCreateDataType, getPropertyManager, getSchema, getTimestamp, getTimestamp, getUniqueName, getUniqueName, hasObjectPrivilege, hasPriviledge, hasSystemPrivilege, isEditable, isNewFromTemplateType, isValidName, isValidName, listObjects, listObjects, listObjects, listObjects, listObjects, listObjectTypes, listSchemas, listSchemas, listSupportedDataTypes, quoteIdentifier, removeObjectListener, removeProviderListener, removeProviderListener, setDefaultTemplateForType, supportsObjectType, supportsTimestamps, undeleteObject, undeleteObjects, updateObject, updateObjects, updateObjects, updateSchema, validateName, validateName, validateObject, validateObject, validateObject, validateObject, validateObjectProperty, validateObjectProperty, validateObjectProperty, validateObjectProperty, validateSchema, validateSchema, validateUniqueName, validateUniqueName

Constructor Detail

AbstractDatabase

protected AbstractDatabase(java.lang.String connStore,
                java.lang.String connName,
                java.sql.Connection conn)

Constructs a new AbstractDatabase with the given connection information.

Parameters:

connStore - the name of the connection store containing the connection.

connName - the name for the connection

conn - the Connection to wrap

AbstractDatabase

protected AbstractDatabase(java.lang.String connStore,
                java.lang.String connName,
                java.sql.Connection conn,
                java.lang.String type,
                int version)

Constructs a new AbstractDatabase with the given connection information.

Parameters:

connStore - the name of the connection store containing the connection.

connName - the name for the connection

conn - the Connection to wrap

type - the api database type for this database

version - the api database version for this database

Method Detail

getProviderType

public final java.lang.String getProviderType()

Description copied from interface: DBObjectProvider

Gets the String that identifies the type of DBObjectProvider this is an instance of. This is used by the DBObjectProviderFactory in conjunction with the identifier to find or create provider instances.

Specified by:

getProviderType in interface DBObjectProvider

See Also:

DBObjectProvider.getProviderIdentifier(), DBObjectProviderFactory.findOrCreateProvider(String,Object)

getProviderIdentifier

public final java.lang.Object getProviderIdentifier()

Description copied from interface: DBObjectProvider

Gets the String that identifies this DBObjectProvider uniquely (within providers of the same type). This is used by the DBObjectProviderFactory in conjunction with the type to find or create provider instances. Note this is not a displayable name, it is an internal identifier for the provider (use getName() for a displayable String).

Specified by:

getProviderIdentifier in interface DBObjectProvider

See Also:

DBObjectProvider.getProviderType(), DBObjectProviderFactory.findOrCreateProvider(String,Object), DBObjectProvider.getName()

getDatabaseType

public final java.lang.String getDatabaseType()

Description copied from interface: Database

Gets the type of database. This method uses JDBC metadata to determine the database type.

Specified by:

getDatabaseType in interface Database

Returns:

an String describing the type of database

See Also:

DatabaseMetaData.getDatabaseProductName()

getDatabaseVersion

public final int getDatabaseVersion()

Description copied from interface: Database

Gets the version of the database for the api implementation. This will not numerically correspond to the database model number, but is an int that the Database implementation uses to identify different versions.

Specified by:

getDatabaseVersion in interface Database

registerValidators

protected void registerValidators()

By default this registers default validators for Schema, Sequences, Synonyms, Indexes, Constraints and Columns for the wizards to use.

exists

protected final boolean exists(SystemObject obj)

Whether the specified object exists. Calls exists(String,String,String) with the appropriate details.

Parameters:

obj - The object being checked

Returns:

whether the object exists.

registerBuilders

protected abstract void registerBuilders()

Called to request that the DBOBjectBuilders be registered.

getConnection

public final java.sql.Connection getConnection()

Description copied from interface: Database

Gets the JDBC connection associated with this database. If the Connection is closed the Database will silently try and reconnect. If reconnect fails, the original (dead) Connection will be returned.

Code should, where possible, use one of the wrapper classes in oracle.javatools.db.execute to use a Connection and not need to directly call this method.

Specified by:

getConnection in interface Database

Returns:

the Connection owned by this database object

See Also:

Database.getConnection(boolean)

getConnection

public final java.sql.Connection getConnection(boolean reconnect)
                                        throws DBException

Description copied from interface: Database

Gets the JDBC connection associated with this database. If the given connection has been closed, the Database can attempt to reconnect it if desired. Any problem with the reconnect will be thrown as a DBException. Note that if reconnect is true, a test of the connection will be performed which hits the database using Database.isConnectionAlive().

Specified by:

getConnection in interface Database

Parameters:

reconnect - whether to try and reconnect to the db

Returns:

the Connection owned by this database object

Throws:

DBException - wrapping a SQLException if there is a problem reconnecting

isClosed

public final boolean isClosed()

Description copied from class: AbstractDBObjectProvider

Tests whether the provider has been closed (e.g. Connection is closed). The default returns false, override as appropriate.

Overrides:

isClosed in class AbstractDBObjectProvider

isConnectionAlive

public final boolean isConnectionAlive()

Description copied from interface: Database

Tests whether the connection underneath this Database is "alive" - i.e. whether it is open and working.

Note the implementation of this is database specific - a positive can be assumed true but a negative could be incorrect.

Specified by:

isConnectionAlive in interface Database

Returns:

true if the underlying jdbc connection is working

See Also:

Database.getConnection(boolean)

isConnectionAlive

protected boolean isConnectionAlive(java.sql.Connection conn)

Implementation that checks whether the given (current) connection is alive. Implementations should not call getConnection() or similar, and only check the passed Connection object.

The calling of this method assumes that if the execution is blocked waiting for a monitor lock, the block is because of the Connection being busy and therefore alive. It is therefore illegal for any implemenation of this method to try and get the monitor lock for any object other than the connection.

Parameters:

conn - the connection to check (will not be null).

Returns:

whether the given connection is alive.

getAliveTestStatement

protected java.lang.String getAliveTestStatement()

Returns a statement that, if executed succesfully, tests whether the given connections is live. The statement must yield a positive return from Statement.execute(java.lang.String) to be a valid test (e.g. SELECT 1 FROM DUAL for Oracle).

Returns:

a sql statement to test whether a connection is alive, or null.

isConnectionClosed

public java.lang.Boolean isConnectionClosed(java.sql.SQLException sqe)

This default implementation returns null unless the SQLException has a SQLState of "08003" - the ANSI standard for "closed connection". Few JDBC drivers adhere to the standard, so for all other exceptions this method will return null indicating that the exception cannot be identified. Consequently for the connection closed support to work a Database implementation should override this method.

Specified by:

isConnectionClosed in interface Database

Parameters:

sqe - the exception to test

Returns:

true if the connection signifies that the connection is closed.

hasTransaction

public boolean hasTransaction()

Description copied from interface: Database

Tests whether there is currently a "transaction" open on the underlying java.sql.Connection.

Note the implementation of this is database specific - a positive can be assumed true but a negative could be incorrect.

Specified by:

hasTransaction in interface Database

Returns:

true we are able to determine that a transaction is currently open on the underlying jdbc connection.

getTransactionTestQuery

protected java.lang.String getTransactionTestQuery()

testSQLStatement

public void testSQLStatement(java.lang.String sql)
                      throws DBException

Description copied from interface: Database

Tests that the given SQL executes against the database. This is separate to the SQLQueryBuilder API and is a simple test against the database.

Specified by:

testSQLStatement in interface Database

Parameters:

sql - the sql to test

Throws:

InvalidSQLException - if the sql doesn't execute (because the syntax is invalid etc).

DBException - for any other error in executing the sql

getName

public final java.lang.String getName()

Description copied from interface: DBObjectProvider

The name of a provider is a displayable string that can be shown to the user to identify the provider. It may not be unique, to uniquely identify a provider use getProviderIdentifier().

Specified by:

getName in interface DBObjectProvider

See Also:

DBObjectProvider.getProviderIdentifier()

getConnectionName

public final java.lang.String getConnectionName()

Description copied from interface: Database

Retrieves the name for the Connection associated with this Database in whichever connection store it is stored in.

Specified by:

getConnectionName in interface Database

Returns:

a String containing the connection name

See Also:

Database.getConnectionStore(), Database.getQualifiedName()

getConnectionStore

public final java.lang.String getConnectionStore()

Description copied from interface: Database

Retrieves the connection store the Connection associated with this Database is stored in. This is not a displayable string.

Specified by:

getConnectionStore in interface Database

Returns:

a String containing the connection store identifier.

See Also:

Database.getQualifiedName()

getQualifiedName

public final java.lang.String getQualifiedName()

Description copied from interface: Database

Retrieves a qualified name containing the connection store and connection name. The string is encoded so that it can be used as part of a URL. This is not a displayable string.

If this connection has no connection store associated with it, this method will simply return the encoded connection name.

Specified by:

getQualifiedName in interface Database

Returns:

a String containing the encoded, qualified name.

See Also:

Database.getConnectionStore(), Database.getConnectionName()

reconnect

protected void reconnect()
                  throws DBException

Throws:

DBException

reconnected

protected void reconnected(java.sql.Connection c)

Called when a reconnect happens to (re)initialise any member appropriately on the new Connection.

Parameters:

c - the connection to initialise on

clearAllCaches

public void clearAllCaches()

Description copied from class: AbstractDBObjectProvider

Clears all cached information in this provider that has been loaded from the underlying database.

Overrides:

clearAllCaches in class AbstractDBObjectProvider

close

public void close()

Description copied from interface: Database

Closes the Database Connection (and the supplied JDBC Connection).

Specified by:

close in interface Database

exists

public boolean exists(java.lang.String type,
             java.lang.String schema,
             java.lang.String name)

Description copied from interface: Database

Checks for existance of a schema object named objectName.

Specified by:

exists in interface Database

name - The name of the schema object.

Returns:

true if the object exists, false otherwise.

isObjectValid

public boolean isObjectValid(java.lang.String objectType,
                    java.lang.String schema,
                    java.lang.String objectName)

Description copied from interface: Database

Determines whether the specified database object is in a valid state.

Specified by:

isObjectValid in interface Database

Parameters:

objectType - the type of the object.

schema - the name of the schema containing the object

objectName - the name of the object

createSchema

protected final Schema createSchema(java.lang.String name)

finishCreate

@Deprecated
protected void finishCreate(SystemObject[] objects,
                           SystemObject[] oldObjects)
                     throws DBException

Deprecated. Replaced by finishUpdates.

Throws:

DBException

finishUpdates

public java.util.Collection<DBObjectChange> finishUpdates(Difference listDiff)
                                                   throws DBException

Processes the given objects after the DDL has been fired for a create, update or delete operation. Can be called externally if the updates were done outside of the Database implementation (e.g. ddl or pl/sql fired by another process).

Parameters:

listDiff - a Difference of two SystemObject[] representing the original and updated object definitions

Throws:

DBException - if we cannot find any of the new or updated objects in the database

getCreatedObject

protected SystemObject getCreatedObject(java.lang.String type,
                            Schema schema,
                            java.lang.String name)
                                 throws DBException

Used by finishCreate() to get the object that's just been created back from the database so that it can be verified before returning to the user.

By default this just calls AbstractDBObjectProvider.loadObjectImpl(DBObjectCriteria). It is separate from loadObjectImpl to allow subclasses to customise logic for matching an object that has been created, but the db has changed the name during the create process.

It is not expected that the object will already be in the cache when this method is called.

Throws:

DBException

See Also:

finishCreate(oracle.javatools.db.SystemObject[], oracle.javatools.db.SystemObject[])

finishDelete

@Deprecated
protected void finishDelete(SystemObject[] objs)

Deprecated. Replaced by finishUpdates.

getDatabaseSource

public java.lang.String getDatabaseSource(java.lang.String objectType,
                                 Schema schema,
                                 java.lang.String objectName)
                                   throws DBException

Description copied from interface: Database

Retrieves the source for an object in the database. The specified object is assumed to be of some type that represents source; non-source based objects will return null.

Specified by:

getDatabaseSource in interface Database

Parameters:

objectType - The type of object for which the source is needed

schema - The Schema containing the object

objectName - The name of the object

Returns:

The source representing the object

Throws:

DBException - if an error occurs fetching the source

getDatabaseSource

public java.lang.String getDatabaseSource(java.lang.String objectType,
                                 Schema schema,
                                 java.lang.String objectName,
                                 java.lang.String sourceType)
                                   throws DBException

Description copied from interface: Database

Retrieves the source for an object in the database. The specified object is assumed to be of some type that represents source; non-source based objects will return null. This method combines spec and body for those source types that support both.

Specified by:

getDatabaseSource in interface Database

Parameters:

objectType - The type of object for which the source is needed

schema - The Schema containing the object

objectName - The name of the object

sourceType - In the case of types that have more than one source, the type of source required. Can be Database.SOURCE_TYPE_SPEC or Database.SOURCE_TYPE_BODY. If null, the default of body is selected.

Returns:

The source representing the object

Throws:

DBException - if an error occurs fetching the source

getDefaultSchema

public Schema getDefaultSchema()
                        throws DBException

Returns the default schema for the connection or null if there isn't one. If the database doesn't support schemas, returns an anonymous schema.

Specified by:

getDefaultSchema in interface DBObjectProvider

Throws:

DBException

isUsernameCaseInsensitive

@Deprecated
protected boolean isUsernameCaseInsensitive()

Deprecated. with no replacement. Override queryCurrentUserName() if the default logic is not sufficient to return an internal name.

getCurrentSchemaName

protected final java.lang.String getCurrentSchemaName()
                                               throws DBException

Gets the name of the current (active) schema for the underlying database connection.

Throws:

DBException

queryCurrentSchemaName

protected java.lang.String queryCurrentSchemaName()
                                           throws DBException

Queries the database for the current schema name. Implementations need not do any locking or caching here, this method will only be called once per Database and the return value cached. The default returns null which means that the user name will be used as the current schema name.

Returns:

the current schema name, or null if the schema name is the same as the current user name. The returned name should be in "internal" form.

Throws:

DBException

getCatalog

public final java.lang.String getCatalog()

Gets the catalog from the database that we are connected to. If the database doesn't support catalogs, this will return an empty string.

Returns:

the database catalog we're connected to

queryCatalog

protected java.lang.String queryCatalog()
                                 throws DBException

Query the underlying Connection for the current catalog. Called once by getCatalog(), implementations can customise if needed.

Throws:

DBException

getUserName

public final java.lang.String getUserName()

Default implementation calls queryCurrentUserName() and caches the result until the Connection is closed.

Specified by:

getUserName in interface Database

Returns:

the connected user name.

See Also:

DBObjectProvider.getDefaultSchema()

queryCurrentUserName

protected java.lang.String queryCurrentUserName()
                                         throws DBException

Queries the current user name for the underlying Connection. The default implementation queries the user name from the connection metadata.

Returns:

the current user name in "internal" form.

Throws:

DBException

supportsDebugging

public boolean supportsDebugging()

Description copied from interface: Database

Whether this database instance supports JDWP debugging. If the database does not support debugging, or only supports debugging using a custom protocol, this method should return false.

Specified by:

supportsDebugging in interface Database

Returns:

true if JDWP debugging is supported against this database, false otherwise

getObjectImpl

protected <T extends SystemObject> T getObjectImpl(DBObjectCriteria<T> criteria)
                                        throws DBException

Description copied from class: AbstractDBObjectProvider

getObject implementation for looking up a single object in the provider. The criteria might include more than one type, but the method is only expected to return a single object. If this has been called with too ambiguous a criteria set then it will simply return the first object that it finds that matches.

Overrides:

getObjectImpl in class AbstractDBObjectProvider

Parameters:

criteria - the lookup criteria

Returns:

an object that matches the criteria

Throws:

DBException

getDescriptor

public DatabaseDescriptor getDescriptor()

Description copied from interface: DBObjectProvider

Returns the DatabaseDescriptor for this provider.

Specified by:

getDescriptor in interface DBObjectProvider

canRestrictSchemaList

public boolean canRestrictSchemaList()

Description copied from interface: Database

Whether this provider supports restricting the list of schemas to those with visible objects. For some providers, determining this list may be significantly more expensive than just returning a raw list of schemas.

Specified by:

canRestrictSchemaList in interface Database

Returns:

whether this provider allows the schema list to be restricted to those schemas with visible objects

setStatement

public void setStatement(java.sql.Statement statement)

Internal use only. Sets the current statement being executed against the database.

Parameters:

statement - the Statement being executed

Throws:

java.lang.IllegalArgumentException - if a non-null Statement is passed and there is already a non-null Statement recorded against the AbstractDatabase

For internal use only. Application developers should not use this

cancelStatement

public void cancelStatement()

Cancels the Statement currently executing against this Database if:

1. such a statement has been recorded by the use of a StatementWrapper/QueryWrapper
2. both the DBMS and driver support aborting an SQL statement

findOrCreateObject

protected final SystemObject findOrCreateObject(java.lang.String type,
                              Schema schema,
                              java.lang.String name,
                              java.lang.Object idVal)
                                         throws DBException

Checks the cache for an existing object and if there isn't one creates a new object using the registered builder and marks it for lazy initialization.

Parameters:

type - the object type

schema - the owning schema (or null for a non-schema object)

name - the object name

idVal - the identifier for the object in the db (or null if name is the identifier).

Throws:

DBException

findOrCreateObject

protected final SystemObject findOrCreateObject(java.lang.String type,
                              java.lang.String dbName,
                              Schema schema,
                              java.lang.String name,
                              java.lang.Object idVal)
                                         throws DBException

Checks the cache for an existing object and if there isn't one creates a new object using the registered builder and marks it for lazy initialization.

Parameters:

type - the object type

dbName - the name of the containing database (or null for normal objects).

schema - the owning schema (or null for a non-schema object)

name - the object name

idVal - the identifier for the object in the db (or null if name is the identifier).

Throws:

DBException

findOrCreateObject

protected final SystemObject findOrCreateObject(java.lang.String type,
                              java.lang.String dbName,
                              Schema schema,
                              java.lang.String name,
                              java.lang.Object idVal,
                              java.lang.Long timestamp)
                                         throws DBException

Checks the cache for an existing object and if there isn't one creates a new object using the registered builder and marks it for lazy initialization.

Parameters:

type - the object type

dbName - the name of the containing database (or null for normal objects).

schema - the owning schema (or null for a non-schema object)

name - the object name

idVal - the identifier for the object in the db (or null if name is the identifier).

timestamp - the timestamp for the object (when it was last modified) from the db (or null if we don't have one).

Throws:

DBException

findOrCreateObject

protected final SystemObject findOrCreateObject(DBObjectLister.ObjectInfo info,
                              DBObjectCriteria criteria)
                                         throws DBException

Checks the cache for an existing object and if there isn't one creates a new object using the registered builder and marks it for lazy initialization.

Parameters:

info - the listed object information

criteria - the criteria used to list the object

Throws:

DBException

createID

public final DBObjectID createID(Schema schema,
                  java.lang.String name,
                  java.lang.String type,
                  java.lang.Object id)

createID

public final DBObjectID createID(java.lang.String dbName,
                  Schema schema,
                  java.lang.String name,
                  java.lang.String type,
                  java.lang.Object id)

getDBExceptionMessage

public java.lang.String getDBExceptionMessage(java.sql.SQLException sqe)

When a StatementWrapper encounters a SQLException when executing against the db, it calls this method with the SQLException to get a message for the wrapping DBSQLException that will be thrown.

Parameters:

sqe - the encountered exception

Returns:

a message to use in the DBException that will wrap this SQLException

isUnsupportedOperation

public boolean isUnsupportedOperation(java.sql.SQLException sqe)

Tests whether the given SQLException was thrown because a given operation was unsupported in the JDBC driver. This should only need to be overridden if the JDBC driver doesn't use the standard SQLFeatureNotSupportedException or the standard sql states for an unsupported operation.

isSQLStateNotImplemented

public static boolean isSQLStateNotImplemented(java.sql.SQLException sqe)

Tests whether the SQLState of the given exception is one of the standard jdbc states for "Not Implemented" - i.e. "S1C00" or "IM001".

Parameters:

sqe - the exception to check

Returns:

true if the exception is because the requested operation was not implemented (by one of the standard sql states).