All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class oracle.jdbc.driver.OracleConnection

java.lang.Object
   |
   +----oracle.jdbc.driver.OracleConnection

public class OracleConnection

extends Object

implements Connection, ClientDataSupport

The implementation relies on native methods. The native methods do all the work and return error codes, a return value >= 0 means the call was successful. The Java methods call the native methods, check the error codes and raise exceptions if errors occured. If the native method get_error_message returns a string that can be used to explain the error to the user.

ASCII_TO_CHAR

CHAR_TO_ASCII

CHAR_TO_JAVACHAR

CHAR_TO_UNICODE

conversion

db_access

DEBUG

JAVACHAR_TO_CHAR

NONE

RAW_TO_ASCII

RAW_TO_JAVACHAR

RAW_TO_UNICODE

UNICODE_TO_CHAR

UsingXA

XA_wants_error

OracleConnection(DBAccess, String, String, String, String, Properties)

Allocate a new OracleConnection.

OracleConnection(OraclePooledConnection, OracleConnection, boolean)

archive(int, int, String)

clearWarnings()

We do not have any connection-level warnings

close()

Rollbacks the current transaction.

commit()

createStatement()

createStatement just allocates a new statement object.

createStatement(int, int)

JDBC 2.0 Creates a Statement object that will generate ResultSet objects with the given type and concurrency.

getAutoClose()

We are always in auto-close mode.

getAutoCommit()

getCatalog()

We do not support catalogs.

getClientData(Object)

Obtain the client data value associated with a key.

getDbCsId()

Obtain the Oracle identifier of the character set used in the database server.

getDefaultExecuteBatch()

Allows the user to retrieve the batch value for the connection.

getDefaultRowPrefetch()

Allows the user to retrieve the row prefetch value for the connection.

getDescriptor(String)

Return the matched StructDescriptor.

getFDO()

INTERNAL Get Format Descriptor Object.

getIncludeSynonyms()

Returns true if DatabaseMetaData.getColumns will report information if a table synonym is passed in, and false otherwise.

getJavaObject(String)

getJdbcCsId()

Obtain the Oracle identifier of the character set used in the JDBC driver.

getMetaData()

We just return a oracle.oci8.DatabaseMetaData object.

getRemarksReporting()

Return true if the DatabaseMetaData calls getTables and getColumns will report the REMARKS column.

getSQLType(Object)

getStructAttrCsId()

Obtain the Oracle identifier of the character set used in STRUCT attributes.

getTransactionIsolation()

We only support dirty reads.

getTypeMap()

getUserName()

getUsingXAFlag()

getWarnings()

We do not have any connection-level warnings

getXAErrorFlag()

holdLine(OracleStatement)

initUserName()

isClosed()

As we do not keep a state in the Java struct we call native method even for isClosed.

isReadOnly()

Our connections are never in read-only mode.

nativeSQL(String)

This is a bogus and quickly done implementation waiting for something better

needLine()

prepareCall(String)

This is similar to createStatement.

prepareCall(String, int, int)

JDBC 2.0 Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.

prepareStatement(String)

This is similar to createStatement.

prepareStatement(String, int, int)

JDBC 2.0 Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency.

putDescriptor(String, Object)

Store the Object Descriptor for later usage.

registerSQLType(String, Class)

registerSQLType(String, String)

Map accessor methods

releaseLine()

removeClientData(Object)

Remove the specified key and any associated client data.

rollback()

setAutoClose(boolean)

We are always in auto-close mode.

setAutoCommit(boolean)

setCatalog(String)

We do not support catalogs.

setClientData(Object, Object)

Store a piece client data and associate it with the specified key.

setDefaultExecuteBatch(int)

Set the batch value for executes for all prepared statements belonging to this connection and created after the batch value was set.

setDefaultRowPrefetch(int)

Set the value of row prefetch for all statements associated with this connection and created after this value was set.

setIncludeSynonyms(boolean)

Turn on or off retrieval of synonym information in DatabaseMetaData.

setReadOnly(boolean)

We do not support read-only connections

setRemarksReporting(boolean)

Turn on or off the reporting of the REMARKS columns by the getTables and getColumns calls of the DatabaseMetaData interface.

The DatabaseMetaData calls getTables and getColumns are extremely slow if the REMARKS column has to be reported as this necessitates an expensive outer join so by default the JDBC driver does not report the REMARKS columns.

You can turn the reporting of REMARKS on by passing a true argument to this method.

setTransactionIsolation(int)

We only support dirty reads.

setTypeMap(Dictionary)

setUsingXAFlag(boolean)

setXAErrorFlag(boolean)

shutdown(int)

startup(String, int)

trace(String)

 public static final boolean DEBUG

 public DBAccess db_access

 public DBConversion conversion

 public boolean XA_wants_error

 public boolean UsingXA

 public static final int CHAR_TO_ASCII

 public static final int CHAR_TO_UNICODE

 public static final int RAW_TO_ASCII

 public static final int RAW_TO_UNICODE

 public static final int UNICODE_TO_CHAR

 public static final int ASCII_TO_CHAR

 public static final int NONE

 public static final int JAVACHAR_TO_CHAR

 public static final int RAW_TO_JAVACHAR

 public static final int CHAR_TO_JAVACHAR

 public OracleConnection(DBAccess access,
                         String ur,
                         String us,
                         String p,
                         String db,
                         Properties info) throws SQLException

Allocate a new OracleConnection. We get the connection parameters as arguments.

We allocate the c_state and call the native method "connect" that does the work. If connect fails we raise an exception.

See Also:

connect

 public OracleConnection(OraclePooledConnection par,
                         OracleConnection pc,
                         boolean autoCommit) throws SQLException

 public synchronized Statement createStatement() throws SQLException

createStatement just allocates a new statement object. The statement has a pointer to the connection object.

Returns:

a new OracleStatement object

 public synchronized PreparedStatement prepareStatement(String sql) throws SQLException

This is similar to createStatement. We accept both ODBC syntax and Oracle syntax for SQL statements.

Returns:

a new OraclePreparedStatement object

 public synchronized CallableStatement prepareCall(String sql) throws SQLException

This is similar to createStatement. We accept both ODBC syntax and Oracle syntax for SQL statements.

Returns:

a new oracle.jdbc.driver.CallableStatement object

 public String nativeSQL(String sql) throws SQLException

This is a bogus and quickly done implementation waiting for something better

 public synchronized void setAutoCommit(boolean autoCommit) throws SQLException

 public synchronized boolean getAutoCommit() throws SQLException

 public synchronized void commit() throws SQLException

 public synchronized void rollback() throws SQLException

 public synchronized void close() throws SQLException

Rollbacks the current transaction. See commit for discussion of how the PreparedStatements, CallableStatement and ResultSets are closed.

See Also:

rollback, commit

 public synchronized boolean isClosed() throws SQLException

As we do not keep a state in the Java struct we call native method even for isClosed. (The alternative is to test if c_state is 0, but this breaks the information hiding strategy.)

 public synchronized DatabaseMetaData getMetaData() throws SQLException

We just return a oracle.oci8.DatabaseMetaData object. It has a pointer to the connection.

 public void setReadOnly(boolean readOnly) throws SQLException

We do not support read-only connections

 public boolean isReadOnly() throws SQLException

Our connections are never in read-only mode.

 public void setCatalog(String catalog) throws SQLException

We do not support catalogs.

 public String getCatalog() throws SQLException

We do not support catalogs.

 public synchronized void setTransactionIsolation(int level) throws SQLException

We only support dirty reads.

 public int getTransactionIsolation() throws SQLException

We only support dirty reads.

 public synchronized void setAutoClose(boolean autoClose) throws SQLException

We are always in auto-close mode.

 public boolean getAutoClose() throws SQLException

We are always in auto-close mode.

 public SQLWarning getWarnings() throws SQLException

We do not have any connection-level warnings

 public void clearWarnings() throws SQLException

We do not have any connection-level warnings

 public void trace(String s)

 public synchronized void setDefaultRowPrefetch(int value) throws SQLException

Set the value of row prefetch for all statements associated with this connection and created after this value was set.

If this value is not set by the user, only 1 row will be fetched at a time.

All statements created before this API was called will have a row prefetch of 1.

Row prefetching allows the JDBC driver to "fetch" multiple rows in one round-trip to the database. If this value is not set by the user, only 1 row will be fetched at a time.

To use the setDefaultRowPrefetch entrypoint you have to cast the Statement object to the type oracle.jdbc.driver.OracleConnection.

The user can override the row prefetch value set by this oracle.jdbc.driver.OracleConnection entrypoint for individual statements, by calling OracleStatement.setRowPrefetch for those statements.

The row_prefetch will be turned back to 1 automatically by the driver if any of the select-column types is streaming (long data or long raw data). This is overrides any value the user might set. Also, this will be done regardless of wether the streaming columns are read or not.

To use the setDefaultRowPrefetch entrypoint you have to cast the Connection object to the type oracle.jdbc.driver.OracleConnection.

See Also:

setRowPrefetch, getDefaultRowPrefetch

 public synchronized int getDefaultRowPrefetch()

Allows the user to retrieve the row prefetch value for the connection.

The row prefetch from the connection is used for all statements associated with this connection. However, the user can also define a different row prefetch value for each statement. This can be done using Oraclestatement.setRowPrefetch, which will override the default value provided from the connection. Therefore, the row prefetch value returned by this getDefaultRowPrefetch entrypoint is valid for statements for which the user has not defined a different row prefetch.

To use the setDefaultRowPrefetch entrypoint you have to cast the Connection object to the type oracle.jdbc.driver.OracleConnection.

See Also:

setRowPrefetch, setDefaultRowPrefetch

 public synchronized void setDefaultExecuteBatch(int batch) throws SQLException

Set the batch value for executes for all prepared statements belonging to this connection and created after the batch value was set.

All statements created before using this API to set the batch value will have a batch value of 1.

Batching allows the JDBC driver to avoid making one round-trip to the RDBMS to execute a prepared statement every time bind variables change. The driver "batches" multiple executions of the statement with different bind variables. Actual execution normally happens when the number of executions reaches the pre-defined "batch" value. The set of bind variables along with the number of times the statement needs to be executed (equal to "batch"), are sent to the RDBMS in one round-trip.

To use the setDefaultExecuteBatch entrypoint you have to cast the Connection object to the type oracle.jdbc.driver.OracleConnection.

The user can override the batch value set by this setDefaultExecuteBatch entrypoint for individual prepared statements, by calling OraclePreparedStatement.setExecuteBatch for those statements.

The default value of batch will be overridden by the driver for a particular statement if that statement has any streaming bind values.

See Also:

setRowPrefetch, getDefaultRowPrefetch

 public synchronized int getDefaultExecuteBatch()

Allows the user to retrieve the batch value for the connection.

The batch value from the connection is used for all prepared statements associated with this connection. However, the user can also define a different batch value for individual prepared statements. This can be done by using OraclePreparedStatement.setExecuteBatch, which will override the default value provided from the connection. Therefore, the row prefetch value returned by this getDefaultExecuteBatch entrypoint is valid for prepared statements for which the user has not defined a different batch value.

To use the getDefaultExecuteBatch entrypoint you have to cast the Connection object to the type oracle.jdbc.driver.OracleConnection.

See Also:

setRowPrefetch, setDefaultRowPrefetch

 public synchronized void setRemarksReporting(boolean reportRemarks)

Turn on or off the reporting of the REMARKS columns by the getTables and getColumns calls of the DatabaseMetaData interface.

The DatabaseMetaData calls getTables and getColumns are extremely slow if the REMARKS column has to be reported as this necessitates an expensive outer join so by default the JDBC driver does not report the REMARKS columns.

You can turn the reporting of REMARKS on by passing a true argument to this method. You turn it back off by passing a false argument.

You can also control the reporting of REMARKS by passing a property named "remarksReporting" as "true" to the DriverManager.getConnection call.

 public synchronized boolean getRemarksReporting()

Return true if the DatabaseMetaData calls getTables and getColumns will report the REMARKS column.

 public void setIncludeSynonyms(boolean synonyms)

Turn on or off retrieval of synonym information in DatabaseMetaData. getColumns.

Similar to setRemarksReporting, getColumns performs extremely slow if information about synonyms has to be included, because it neccessitates an outer join. By default, the JDBC driver will not report information about table columns when you pass a synonym to getColumns.

You can get synonym information by passing true to this method, and turn it off by passing false. You can also control this behavior by passing a property named "includeSynonyms" as "true" to DriverManager.getConnection.

 public boolean getIncludeSynonyms()

Returns true if DatabaseMetaData.getColumns will report information if a table synonym is passed in, and false otherwise.

 public synchronized void needLine() throws SQLException

 public synchronized void holdLine(OracleStatement stmt)

 public synchronized void releaseLine()

 public synchronized void startup(String startup_str,
                                  int mode) throws SQLException

 public synchronized void shutdown(int mode) throws SQLException

 public synchronized void archive(int mode,
                                  int aseq,
                                  String acstext) throws SQLException

 public synchronized void registerSQLType(String sql_name,
                                          String java_class_name) throws SQLException

Map accessor methods

 public synchronized void registerSQLType(String sql_name,
                                          Class java_class) throws SQLException

 public synchronized String getSQLType(Object obj) throws SQLException

 public synchronized Object getJavaObject(String sql_name) throws SQLException

 public synchronized void putDescriptor(String sql_name,
                                        Object desc) throws SQLException

Store the Object Descriptor for later usage.

 public synchronized Object getDescriptor(String sql_name)

Return the matched StructDescriptor.

 public short getJdbcCsId() throws SQLException

Obtain the Oracle identifier of the character set used in the JDBC driver.

Returns:

the Oracle identifier of the character set. See oracle.sql.CharacterSet for the set of constants defined for the identifiers.

 public short getDbCsId() throws SQLException

Obtain the Oracle identifier of the character set used in the database server.

Returns:

the Oracle identifier of the character set. See oracle.sql.CharacterSet for the set of constants defined for the identifiers.

 public synchronized short getStructAttrCsId() throws SQLException

Obtain the Oracle identifier of the character set used in STRUCT attributes. Note that TTC always send structure attributes in the database character set.

Returns:

the Oracle identifier of the character set. See oracle.sql.CharacterSet for the set of constants defined for the identifiers.

 public synchronized Statement createStatement(int resultSetType,
                                               int resultSetConcurrency) throws SQLException

JDBC 2.0 Creates a Statement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the createStatement method above, but it allows the default result set type and result set concurrency type to be overridden.

Parameters:

resultSetType - a result set type; see ResultSet.TYPE_XXX

Returns:

a new Statement object

Throws: SQLException

if a database access error occurs

 public synchronized PreparedStatement prepareStatement(String sql,
                                                        int resultSetType,
                                                        int resultSetConcurrency) throws SQLException

JDBC 2.0 Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareStatement method above, but it allows the default result set type and result set concurrency type to be overridden.

Parameters:

resultSetType - a result set type; see ResultSet.TYPE_XXX

resultSetConcurrency - a concurrency type; see ResultSet.CONCUR_XXX

Returns:

a new PreparedStatement object containing the pre-compiled SQL statement

Throws: SQLException

if a database access error occurs

 public synchronized CallableStatement prepareCall(String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency) throws SQLException

JDBC 2.0 Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type and result set concurrency type to be overridden.

Parameters:

resultSetType - a result set type; see ResultSet.TYPE_XXX

resultSetConcurrency - a concurrency type; see ResultSet.CONCUR_XXX

Returns:

a new CallableStatement object containing the pre-compiled SQL statement

Throws: SQLException

if a database access error occurs

 public synchronized Dictionary getTypeMap()

 public synchronized void setTypeMap(Dictionary map)

 public void setUsingXAFlag(boolean value)

 public boolean getUsingXAFlag()

 public synchronized void setXAErrorFlag(boolean value)

 public synchronized boolean getXAErrorFlag()

 public synchronized void initUserName() throws SQLException

 public synchronized String getUserName() throws SQLException

 public synchronized byte[] getFDO() throws SQLException

INTERNAL Get Format Descriptor Object. (INTERNAL)

 public synchronized Object getClientData(Object key)

Obtain the client data value associated with a key.

Parameters:

key key - whose associated value is to be returned.

Returns:

value associated with the specified key, or null if there is no value for this key.

Throws: NullPointerException

if the specified key is null.

 public synchronized Object setClientData(Object key,
                                          Object value)

Store a piece client data and associate it with the specified key. Neither the key nor the value can be null. If the specified key already existed, the old value is replaced.

Parameters:

key key - with which the specified client data value is to be associated.

value client - data value to be associated with the specified key.

Returns:

previous client data value associated with specified key, or null if there was no previous association.

Throws: NullPointerException

if the specified key or value is null.

 public synchronized Object removeClientData(Object key)

Remove the specified key and any associated client data.

Parameters:

key key - to be removed along with its associated value

Returns:

client data value being removed, or null if there was no data found.

Throws: NullPointerException

if the specified key is null.

All Packages  Class Hierarchy  This Package  Previous  Next  Index