EngineConnection (Apache Derby V10.14 Internals)

All Superinterfaces:

java.lang.AutoCloseable, java.sql.Connection, java.sql.Wrapper

All Known Implementing Classes:

BrokeredConnection, BrokeredConnection42, EmbedConnection
```
public interface EngineConnection
extends java.sql.Connection
```
Additional methods the embedded engine exposes on its Connection object implementations. An internal api only, mainly for the network server. Allows consistent interaction between EmbedConnections and BrokeredConnections.

Field Summary
- Fields inherited from interface java.sql.Connection
  TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`abort(java.util.concurrent.Executor executor)`
`void`	`addWarning(java.sql.SQLWarning newWarning)`	Add a SQLWarning to this Connection object.
`java.lang.String`	`getCurrentSchemaName()`	Obtain the name of the current schema, so that the NetworkServer can use it for piggy-backing
`java.lang.Object`	`getLOBMapping(int key)`	Get the LOB reference corresponding to the locator.
`int`	`getNetworkTimeout()`
`int`	`getPrepareIsolation()`	Return prepare isolation
`java.lang.String`	`getSchema()`	Get the name of the current schema.
`boolean`	`isInGlobalTransaction()`	Is this a global transaction
`void`	`resetFromPool()`	Resets the connection before it is returned from a PooledConnection to a new application request (wrapped by a BrokeredConnection).
`void`	`setDrdaID(java.lang.String drdaID)`	Set the DRDA identifier for this connection.
`void`	`setNetworkTimeout(java.util.concurrent.Executor executor, int millis)`
`void`	`setPrepareIsolation(int level)`	Set the transaction isolation level that will be used for the next prepare.
`void`	`setSchema(java.lang.String schemaName)`	Set the default schema for the Connection.

Methods inherited from interface java.sql.Connection
beginRequest, clearWarnings, close, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, endRequest, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getMetaData, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setHoldability, setReadOnly, setSavepoint, setSavepoint, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid, setTransactionIsolation, setTypeMap

Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap

- Method Detail
  - setDrdaID
```
void setDrdaID(java.lang.String drdaID)
```
    Set the DRDA identifier for this connection.
  - isInGlobalTransaction
```
boolean isInGlobalTransaction()
```
    Is this a global transaction
    
    Returns:
    
    true if this is a global XA transaction
  - setPrepareIsolation
```
void setPrepareIsolation(int level)
                  throws java.sql.SQLException
```
    Set the transaction isolation level that will be used for the next prepare. Used by network server to implement DB2 style isolation levels. Note the passed in level using the Derby constants from ExecutionContext and not the JDBC constants from java.sql.Connection.
    
    Parameters:
    
    level - Isolation level to change to. level is the DB2 level specified in the package names which happen to correspond to our internal levels. If level == ExecutionContext.UNSPECIFIED_ISOLATION, the statement won't be prepared with an isolation level.
    
    Throws:
    
    java.sql.SQLException
  - getPrepareIsolation
```
int getPrepareIsolation()
                 throws java.sql.SQLException
```
    Return prepare isolation
    
    Throws:
    
    java.sql.SQLException
  - addWarning
```
void addWarning(java.sql.SQLWarning newWarning)
         throws java.sql.SQLException
```
    Add a SQLWarning to this Connection object.
    
    Parameters:
    
    newWarning - Warning to be added, will be chained to any existing warnings.
    
    Throws:
    
    java.sql.SQLException
  - getLOBMapping
```
java.lang.Object getLOBMapping(int key)
                        throws java.sql.SQLException
```
    Get the LOB reference corresponding to the locator.
    
    Parameters:
    
    key - the integer that represents the LOB locator value.
    
    Returns:
    
    the LOB Object corresponding to this locator.
    
    Throws:
    
    java.sql.SQLException
  - getCurrentSchemaName
```
java.lang.String getCurrentSchemaName()
                               throws java.sql.SQLException
```
    Obtain the name of the current schema, so that the NetworkServer can use it for piggy-backing
    
    Returns:
    
    the current schema name
    
    Throws:
    
    java.sql.SQLException
  - resetFromPool
```
void resetFromPool()
            throws java.sql.SQLException
```
    Resets the connection before it is returned from a PooledConnection to a new application request (wrapped by a BrokeredConnection).
    Note that resetting the transaction isolation level is not performed as part of this method. Temporary tables, IDENTITY_VAL_LOCAL and current schema are reset.
    
    Throws:
    
    java.sql.SQLException
  - getSchema
```
java.lang.String getSchema()
                    throws java.sql.SQLException
```
    Get the name of the current schema.
    
    Specified by:
    
    getSchema in interface java.sql.Connection
    
    Throws:
    
    java.sql.SQLException
  - setSchema
```
void setSchema(java.lang.String schemaName)
        throws java.sql.SQLException
```
    Set the default schema for the Connection.
    
    Specified by:
    
    setSchema in interface java.sql.Connection
    
    Throws:
    
    java.sql.SQLException
  - abort
```
void abort(java.util.concurrent.Executor executor)
    throws java.sql.SQLException
```
    Specified by:
    
    abort in interface java.sql.Connection
    
    Throws:
    
    java.sql.SQLException
  - setNetworkTimeout
```
void setNetworkTimeout(java.util.concurrent.Executor executor,
                       int millis)
                throws java.sql.SQLException
```
    Specified by:
    
    setNetworkTimeout in interface java.sql.Connection
    
    Throws:
    
    java.sql.SQLException
  - getNetworkTimeout
```
int getNetworkTimeout()
               throws java.sql.SQLException
```
    Specified by:
    
    getNetworkTimeout in interface java.sql.Connection
    
    Throws:
    
    java.sql.SQLException

Interface EngineConnection

Field Summary

Fields inherited from interface java.sql.Connection

Method Summary

Methods inherited from interface java.sql.Connection

Methods inherited from interface java.sql.Wrapper

Method Detail

setDrdaID

isInGlobalTransaction

setPrepareIsolation

getPrepareIsolation

addWarning

getLOBMapping

getCurrentSchemaName

resetFromPool

getSchema

setSchema

abort

setNetworkTimeout

getNetworkTimeout