oracle.javatools.db.ora
Interface OracleDatabase

All Superinterfaces:

Database, DBObjectProvider

All Known Subinterfaces:

OracleDatabaseXE

public interface OracleDatabase
extends Database

Extension of the Database interface for Oracle specific implementations.

Field Summary

static int	DOMAIN_ALL
static int	DOMAIN_ARGUMENT
static int	DOMAIN_COLUMN
static int	DOMAIN_VARIABLE
static int	LAST_ORACLE_TYPE The latest oracle type supported by the api.
static java.lang.String	NESTED_TABLE_PROPERTY Property name for nested tables.
static java.lang.String	OBJECT_TABLE_PROPERTY Property name for Object Tables.
static int	OLITE_10GR3_TYPE
static int	OLITE_TYPE The type for Oracle Lite databases.
static java.lang.String	ORA_BFILE
static java.lang.String	ORA_BINARY_DOUBLE
static java.lang.String	ORA_BINARY_FLOAT
static java.lang.String	ORA_BLOB
static java.lang.String	ORA_CHAR
static java.lang.String	ORA_CHAR_VARYING
static java.lang.String	ORA_CHARACTER
static java.lang.String	ORA_CHARACTER_VARYING
static java.lang.String	ORA_CLOB
static java.lang.String	ORA_DATATYPE_ATTRIBUTE_TIME_ZONE
static java.lang.String	ORA_DATATYPE_ATTRIBUTE_UNIT
static java.lang.String	ORA_DATATYPE_ATTRIBUTE_VALUE_BYTE
static java.lang.String	ORA_DATATYPE_ATTRIBUTE_VALUE_CHAR
static java.lang.String	ORA_DATATYPE_ATTRIBUTE_VALUE_LOCAL_TIME_ZONE
static java.lang.String	ORA_DATATYPE_ATTRIBUTE_VALUE_TIME_ZONE
static java.lang.String	ORA_DATE
static java.lang.String	ORA_DEC
static java.lang.String	ORA_DECIMAL
static java.lang.String	ORA_DOUBLE_PRECISION
static java.lang.String	ORA_FLOAT
static java.lang.String	ORA_INT
static java.lang.String	ORA_INTEGER
static java.lang.String	ORA_INTERVAL_DAY
static java.lang.String	ORA_INTERVAL_YEAR
static java.lang.String	ORA_LONG
static java.lang.String	ORA_LONG_RAW
static java.lang.String	ORA_LONG_VARCHAR
static java.lang.String	ORA_NATIONAL_CHAR
static java.lang.String	ORA_NATIONAL_CHAR_VARYING
static java.lang.String	ORA_NATIONAL_CHARACTER
static java.lang.String	ORA_NATIONAL_CHARACTER_VARYING
static java.lang.String	ORA_NCHAR
static java.lang.String	ORA_NCHAR_VARYING
static java.lang.String	ORA_NCLOB
static java.lang.String	ORA_NUMBER
static java.lang.String	ORA_NUMERIC
static java.lang.String	ORA_NVARCHAR2
static java.lang.String	ORA_RAW
static java.lang.String	ORA_REAL
static java.lang.String	ORA_ROWID
static java.lang.String	ORA_SMALLINT
static java.lang.String	ORA_TIMESTAMP
static java.lang.String	ORA_UROWID
static java.lang.String	ORA_VARCHAR
static java.lang.String	ORA_VARCHAR2
static java.lang.String	ORACLE_DATABASE_TYPE The type string for Oracle databases.
static java.lang.String	ORACLE_LITE_DATABASE_TYPE The type string for OracleLite databases.
static int	ORACLE_TYPE
static int	ORACLE10g_TYPE The type for Oracle 10g R1.
static int	ORACLE10gR2_TYPE The type for Oracle 10g R2.
static int	ORACLE10gR2XE_TYPE The type for Oracle 10g R2 eXpress Edition.
static int	ORACLE11g_TYPE The type for Oracle 11g R1.
static int	ORACLE11gR2_TYPE The type for Oracle 11g R2.
static int	ORACLE11gR2XE_TYPE The type for Oracle 11g R2 eXpress Edition.
static int	ORACLE8_TYPE
static int	ORACLE8i_TYPE
static int	ORACLE9i_TYPE
static int	ORACLE9iR2_TYPE
static java.lang.String	PARTITIONED_TABLE_PROPERTY Property name for Partitioned Tables.
static java.lang.String	PASSWORD
static java.lang.String	TABLE_COMPRESS_KEY Boolean property indicating if the table is compressed.
static java.lang.String	TABLE_PARALLEL_KEY Integer property indicating the degree of parallelism on the table 0 = PARALLEL DEFAULT (Server selects the degree) 1 = NOPARALLEL (default) n = PARALLEL n If the property is not set, this will be interpretted as 1, ie NOPARALLEL.
static int	UNKNOWN_TYPE
static java.lang.String	USER_PRIVS Property name for user privileges.
static java.lang.String	USER_ROLES Property name for user roles.

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

Method Summary

void	alterSessionParameterValue(java.lang.String parameter, java.lang.String value) Changes the value of given session parameter using ALTER SESION SET parameter = value.
java.util.List<oracle.javatools.db.compilation.CompilationResults>	getCompilationResults(java.util.List<PlSqlIdentifier> plsqlIds) Returns a List of CompilationResults for PL/SQL objects defined by the List of PlSqlIdentifiers.
int	getDatabaseVersion() Returns the type of Oracle database for this provider.
int	getOracleDatabaseType() Deprecated. use getDatabaseVersion()
java.util.Map<java.lang.String,java.lang.String>	getSessionParameterQueries() Gets the Map of queries used to build the Session Parameters cache.
java.lang.String	getSessionParameterValue(java.lang.String parameter) Returns the value of given parameter from the Session Parameters cache.
java.lang.String[]	listTablespaces() Deprecated. listObjects now supports Tablespaces and Schemas
void	markSessionParametersDirty() Allows the Session Paramters cache to be marked as dirty so that the next time a value is requested, the cache will be requeried from the database.
oracle.javatools.db.compilation.CompilationResults	submitDatabaseSource(java.lang.String schemaName, java.lang.String source) Convenience method for submitting a single source.
java.util.List<oracle.javatools.db.compilation.CompilationResults>	submitDatabaseSources(java.lang.String schemaName, java.util.List<java.lang.String> sources) Submits a List of plsql sources to the database to be compiled in the current schema (or the given schemaName if not null).
boolean	supportsJava() Returns true if this Oracle version supports java in the database.
boolean	supportsPartitioning() Returns true if this Oracle instance supports partitioning of tables.

Methods inherited from interface oracle.javatools.db.Database

canRestrictSchemaList, close, exists, getConnection, getConnection, getConnectionName, getConnectionStore, getDatabaseSource, getDatabaseSource, getDatabaseType, getIdentifierQuoteString, getQualifiedName, getUserName, hasTransaction, isConnectionAlive, isConnectionClosed, isObjectValid, supportsDebugging, testSQLStatement

Methods inherited from interface oracle.javatools.db.DBObjectProvider

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

Field Detail

ORACLE_DATABASE_TYPE

static final java.lang.String ORACLE_DATABASE_TYPE

The type string for Oracle databases.

See Also:

Database.getDatabaseType(), Constant Field Values

ORACLE_LITE_DATABASE_TYPE

static final java.lang.String ORACLE_LITE_DATABASE_TYPE

The type string for OracleLite databases.

See Also:

Database.getDatabaseType(), Constant Field Values

OBJECT_TABLE_PROPERTY

static final java.lang.String OBJECT_TABLE_PROPERTY

Property name for Object Tables. Calling getProperty on a Table with this String for the property name will return Boolean.TRUE if and only if the Table is an Object Table.

See Also:

oracle.javatools.db.Table.getProperty, Constant Field Values

NESTED_TABLE_PROPERTY

static final java.lang.String NESTED_TABLE_PROPERTY

Property name for nested tables. Calling getProperty on a table with this String for the property name will return Boolean.TRUE if and only if the table is a nested table.

See Also:

oracle.javatools.db.Table.getProperty, Constant Field Values

PARTITIONED_TABLE_PROPERTY

static final java.lang.String PARTITIONED_TABLE_PROPERTY

Property name for Partitioned Tables. Calling getProperty on a Table with this String for the property name will return Boolean.TRUE if and only if the Table is a Partitioned Table.

See Also:

oracle.javatools.db.Table.getProperty, Constant Field Values

TABLE_COMPRESS_KEY

static final java.lang.String TABLE_COMPRESS_KEY

Boolean property indicating if the table is compressed. If the property is not set, this will be interpretted as Boolean.FALSE, ie not compressed.

See Also:

Constant Field Values

TABLE_PARALLEL_KEY

static final java.lang.String TABLE_PARALLEL_KEY

Integer property indicating the degree of parallelism on the table

• 0 = PARALLEL DEFAULT (Server selects the degree)
• 1 = NOPARALLEL (default)
• n = PARALLEL n

If the property is not set, this will be interpretted as 1, ie NOPARALLEL.

See Also:

Constant Field Values

USER_PRIVS

static final java.lang.String USER_PRIVS

Property name for user privileges. Calling getProperty on a Schema with this String for the property name will return a Set containing the privileges granted to that Schema.

See Also:

Constant Field Values

USER_ROLES

static final java.lang.String USER_ROLES

Property name for user roles. Calling getProperty on a Schema with this String for the property name will return a Set containing the privileges granted to that Schema.

See Also:

Constant Field Values

PASSWORD

static final java.lang.String PASSWORD

See Also:

Constant Field Values

UNKNOWN_TYPE

static final int UNKNOWN_TYPE

See Also:

Constant Field Values

OLITE_TYPE

static final int OLITE_TYPE

The type for Oracle Lite databases.

See Also:

getDatabaseVersion(), Constant Field Values

OLITE_10GR3_TYPE

static final int OLITE_10GR3_TYPE

See Also:

Constant Field Values

ORACLE_TYPE

static final int ORACLE_TYPE

See Also:

Constant Field Values

ORACLE8_TYPE

static final int ORACLE8_TYPE

See Also:

Constant Field Values

ORACLE8i_TYPE

static final int ORACLE8i_TYPE

See Also:

Constant Field Values

ORACLE9i_TYPE

static final int ORACLE9i_TYPE

See Also:

Constant Field Values

ORACLE9iR2_TYPE

static final int ORACLE9iR2_TYPE

See Also:

Constant Field Values

ORACLE10g_TYPE

static final int ORACLE10g_TYPE

The type for Oracle 10g R1.

See Also:

getDatabaseVersion(), Constant Field Values

ORACLE10gR2XE_TYPE

static final int ORACLE10gR2XE_TYPE

The type for Oracle 10g R2 eXpress Edition.

See Also:

getDatabaseVersion(), Constant Field Values

ORACLE10gR2_TYPE

static final int ORACLE10gR2_TYPE

The type for Oracle 10g R2.

See Also:

getDatabaseVersion(), Constant Field Values

ORACLE11g_TYPE

static final int ORACLE11g_TYPE

The type for Oracle 11g R1.

See Also:

getDatabaseVersion(), Constant Field Values

ORACLE11gR2XE_TYPE

static final int ORACLE11gR2XE_TYPE

The type for Oracle 11g R2 eXpress Edition.

See Also:

getDatabaseVersion(), Constant Field Values

ORACLE11gR2_TYPE

static final int ORACLE11gR2_TYPE

The type for Oracle 11g R2.

See Also:

getDatabaseVersion(), Constant Field Values

LAST_ORACLE_TYPE

static final int LAST_ORACLE_TYPE

The latest oracle type supported by the api.

See Also:

getDatabaseVersion(), Constant Field Values

DOMAIN_ALL

static final int DOMAIN_ALL

See Also:

Constant Field Values

DOMAIN_COLUMN

static final int DOMAIN_COLUMN

See Also:

Constant Field Values

DOMAIN_VARIABLE

static final int DOMAIN_VARIABLE

See Also:

Constant Field Values

DOMAIN_ARGUMENT

static final int DOMAIN_ARGUMENT

See Also:

Constant Field Values

ORA_BLOB

static final java.lang.String ORA_BLOB

See Also:

Constant Field Values

ORA_BFILE

static final java.lang.String ORA_BFILE

See Also:

Constant Field Values

ORA_BINARY_DOUBLE

static final java.lang.String ORA_BINARY_DOUBLE

See Also:

Constant Field Values

ORA_BINARY_FLOAT

static final java.lang.String ORA_BINARY_FLOAT

See Also:

Constant Field Values

ORA_CHAR

static final java.lang.String ORA_CHAR

See Also:

Constant Field Values

ORA_CHAR_VARYING

static final java.lang.String ORA_CHAR_VARYING

See Also:

Constant Field Values

ORA_CHARACTER

static final java.lang.String ORA_CHARACTER

See Also:

Constant Field Values

ORA_CHARACTER_VARYING

static final java.lang.String ORA_CHARACTER_VARYING

See Also:

Constant Field Values

ORA_CLOB

static final java.lang.String ORA_CLOB

See Also:

Constant Field Values

ORA_DATE

static final java.lang.String ORA_DATE

See Also:

Constant Field Values

ORA_DEC

static final java.lang.String ORA_DEC

See Also:

Constant Field Values

ORA_DECIMAL

static final java.lang.String ORA_DECIMAL

See Also:

Constant Field Values

ORA_DOUBLE_PRECISION

static final java.lang.String ORA_DOUBLE_PRECISION

See Also:

Constant Field Values

ORA_FLOAT

static final java.lang.String ORA_FLOAT

See Also:

Constant Field Values

ORA_INT

static final java.lang.String ORA_INT

See Also:

Constant Field Values

ORA_INTEGER

static final java.lang.String ORA_INTEGER

See Also:

Constant Field Values

ORA_INTERVAL_DAY

static final java.lang.String ORA_INTERVAL_DAY

See Also:

Constant Field Values

ORA_INTERVAL_YEAR

static final java.lang.String ORA_INTERVAL_YEAR

See Also:

Constant Field Values

ORA_LONG

static final java.lang.String ORA_LONG

See Also:

Constant Field Values

ORA_LONG_RAW

static final java.lang.String ORA_LONG_RAW

See Also:

Constant Field Values

ORA_LONG_VARCHAR

static final java.lang.String ORA_LONG_VARCHAR

See Also:

Constant Field Values

ORA_NATIONAL_CHAR

static final java.lang.String ORA_NATIONAL_CHAR

See Also:

Constant Field Values

ORA_NATIONAL_CHAR_VARYING

static final java.lang.String ORA_NATIONAL_CHAR_VARYING

See Also:

Constant Field Values

ORA_NATIONAL_CHARACTER

static final java.lang.String ORA_NATIONAL_CHARACTER

See Also:

Constant Field Values

ORA_NATIONAL_CHARACTER_VARYING

static final java.lang.String ORA_NATIONAL_CHARACTER_VARYING

See Also:

Constant Field Values

ORA_NCHAR

static final java.lang.String ORA_NCHAR

See Also:

Constant Field Values

ORA_NCHAR_VARYING

static final java.lang.String ORA_NCHAR_VARYING

See Also:

Constant Field Values

ORA_NCLOB

static final java.lang.String ORA_NCLOB

See Also:

Constant Field Values

ORA_NUMBER

static final java.lang.String ORA_NUMBER

See Also:

Constant Field Values

ORA_NUMERIC

static final java.lang.String ORA_NUMERIC

See Also:

Constant Field Values

ORA_NVARCHAR2

static final java.lang.String ORA_NVARCHAR2

See Also:

Constant Field Values

ORA_RAW

static final java.lang.String ORA_RAW

See Also:

Constant Field Values

ORA_REAL

static final java.lang.String ORA_REAL

See Also:

Constant Field Values

ORA_ROWID

static final java.lang.String ORA_ROWID

See Also:

Constant Field Values

ORA_SMALLINT

static final java.lang.String ORA_SMALLINT

See Also:

Constant Field Values

ORA_TIMESTAMP

static final java.lang.String ORA_TIMESTAMP

See Also:

Constant Field Values

ORA_UROWID

static final java.lang.String ORA_UROWID

See Also:

Constant Field Values

ORA_VARCHAR

static final java.lang.String ORA_VARCHAR

See Also:

Constant Field Values

ORA_VARCHAR2

static final java.lang.String ORA_VARCHAR2

See Also:

Constant Field Values

ORA_DATATYPE_ATTRIBUTE_TIME_ZONE

static final java.lang.String ORA_DATATYPE_ATTRIBUTE_TIME_ZONE

See Also:

Constant Field Values

ORA_DATATYPE_ATTRIBUTE_VALUE_TIME_ZONE

static final java.lang.String ORA_DATATYPE_ATTRIBUTE_VALUE_TIME_ZONE

See Also:

Constant Field Values

ORA_DATATYPE_ATTRIBUTE_VALUE_LOCAL_TIME_ZONE

static final java.lang.String ORA_DATATYPE_ATTRIBUTE_VALUE_LOCAL_TIME_ZONE

See Also:

Constant Field Values

ORA_DATATYPE_ATTRIBUTE_UNIT

static final java.lang.String ORA_DATATYPE_ATTRIBUTE_UNIT

See Also:

Constant Field Values

ORA_DATATYPE_ATTRIBUTE_VALUE_CHAR

static final java.lang.String ORA_DATATYPE_ATTRIBUTE_VALUE_CHAR

See Also:

Constant Field Values

ORA_DATATYPE_ATTRIBUTE_VALUE_BYTE

static final java.lang.String ORA_DATATYPE_ATTRIBUTE_VALUE_BYTE

See Also:

Constant Field Values

Method Detail

getOracleDatabaseType

@Deprecated
int getOracleDatabaseType()

Deprecated. use getDatabaseVersion()

getDatabaseVersion

int getDatabaseVersion()

Returns the type of Oracle database for this provider. The types are sequencial so ORACLE9i_TYPE < ORACLE10g_TYPE etc. The latest supported type is LAST_ORACLE_TYPE.

Specified by:

getDatabaseVersion in interface Database

See Also:

ORACLE11g_TYPE, ORACLE10gR2_TYPE, ORACLE10g_TYPE, OLITE_TYPE, OLITE_10GR3_TYPE

listTablespaces

@Deprecated
java.lang.String[] listTablespaces()

Deprecated. listObjects now supports Tablespaces and Schemas

Lists the available tablespaces in the database.

supportsJava

boolean supportsJava()

Returns true if this Oracle version supports java in the database.

supportsPartitioning

boolean supportsPartitioning()

Returns true if this Oracle instance supports partitioning of tables.

getSessionParameterValue

java.lang.String getSessionParameterValue(java.lang.String parameter)

Returns the value of given parameter from the Session Parameters cache. The cache is populated when the first value is requested using the union of queries held in the Session Parameter Queries Map. The values of these queries can be seen, and modified if required, by retireving the map with getSessionParameterQueries().

alterSessionParameterValue

void alterSessionParameterValue(java.lang.String parameter,
                                java.lang.String value)
                                throws DBException

Changes the value of given session parameter using
ALTER SESION SET parameter = value.
If the alter session statement succeeds, the new value is also placed in the Session Parameters cache.

Parameters:

parameter -

value -

Throws:

DBException - if the set fails

markSessionParametersDirty

void markSessionParametersDirty()

Allows the Session Paramters cache to be marked as dirty so that the next time a value is requested, the cache will be requeried from the database. This may be useful if a value has been changed without using alterSessionParameterValue(java.lang.String, java.lang.String) as its value cannot be changed with ALTER SESSION for example.

getSessionParameterQueries

java.util.Map<java.lang.String,java.lang.String> getSessionParameterQueries()

Gets the Map of queries used to build the Session Parameters cache. Adding, replacing or removing entries from the map will cause the Session Paramters cache to be marked as dirty (see markSessionParametersDirty()).

submitDatabaseSources

java.util.List<oracle.javatools.db.compilation.CompilationResults> submitDatabaseSources(java.lang.String schemaName,
                                                                                         java.util.List<java.lang.String> sources)

Submits a List of plsql sources to the database to be compiled in the current schema (or the given schemaName if not null). CREATE OR REPLACE is optional.

Returns:

List of CompilationResults.

submitDatabaseSource

oracle.javatools.db.compilation.CompilationResults submitDatabaseSource(java.lang.String schemaName,
                                                                        java.lang.String source)

Convenience method for submitting a single source. See submitDatabaseSources(java.lang.String, java.util.List) for details.

getCompilationResults

java.util.List<oracle.javatools.db.compilation.CompilationResults> getCompilationResults(java.util.List<PlSqlIdentifier> plsqlIds)

Returns a List of CompilationResults for PL/SQL objects defined by the List of PlSqlIdentifiers.