|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.as400.access.AS400JDBCConnection
public class AS400JDBCConnection extends Object implements Connection
The AS400JDBCConnection class provides a JDBC connection to a specific DB2 for IBM i database. Use DriverManager.getConnection() to create new AS400JDBCConnection objects.
There are many optional properties that can be specified when the connection is created. Properties can be specified either as part of the URL or in a java.util.Properties object. See JDBC properties for a complete list of properties supported by the AS400JDBCDriver.
Note that a connection may contain at most 9999 open statements.
Modifier and Type | Field and Description |
---|
Fields inherited from interface java.sql.Connection |
---|
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE |
Modifier and Type | Method and Description |
---|---|
void |
clearWarnings()
Clears all warnings that have been reported for the connection. |
void |
close()
Releases the connection's resources immediately instead of waiting for them to be automatically released. |
void |
commit()
Commits all changes made since the previous commit or rollback and releases any database locks currently held by the connection. |
Array |
createArrayOf(String typeName,
Object[] elements)
Factory method for creating Array objects. |
Statement |
createStatement()
Creates a Statement object for executing SQL statements without parameters. |
Statement |
createStatement(int resultSetType,
int resultSetConcurrency)
Creates a Statement object for executing SQL statements without parameters. |
Statement |
createStatement(int resultSetType,
int resultSetConcurrency,
int resultSetHoldability)
Creates a Statement object for executing SQL statements without parameters. |
protected void |
finalize()
Closes the connection if not explicitly closed by the caller. |
boolean |
getAutoCommit()
Returns the auto-commit state. |
String |
getCatalog()
Returns the catalog name. |
Properties |
getClientInfo()
Returns a list containing the name and current value of each client info property supported by the driver. |
String |
getClientInfo(String name)
Returns the value of the client info property specified by name. |
int |
getConcurrentAccessResolution()
This method returns the concurrent access resolution setting. |
int |
getHoldability()
Returns the holdability of ResultSets created from this connection. |
DatabaseMetaData |
getMetaData()
Returns the DatabaseMetaData object that describes the connection's tables, supported SQL grammar, stored procedures, capabilities and more. |
String |
getServerJobIdentifier()
Returns the job identifier of the host server job corresponding to this connection. |
AS400 |
getSystem()
Returns the system object which is managing the connection to the system. |
int |
getTransactionIsolation()
Returns the transaction isolation level. |
Map |
getTypeMap()
Returns the type map. |
SQLWarning |
getWarnings()
Returns the first warning reported for the connection. |
boolean |
isClosed()
Indicates if the connection is closed. |
boolean |
isReadOnly()
Indicates if the connection is in read-only mode. |
String |
nativeSQL(String sql)
Returns the native form of an SQL statement without executing it. |
CallableStatement |
prepareCall(String sql)
Precompiles an SQL stored procedure call with optional input and output parameters and stores it in a CallableStatement object. |
CallableStatement |
prepareCall(String sql,
int resultSetType,
int resultSetConcurrency)
Precompiles an SQL stored procedure call with optional input and output parameters and stores it in a CallableStatement object. |
CallableStatement |
prepareCall(String sql,
int resultSetType,
int resultSetConcurrency,
int resultSetHoldability)
Precompiles an SQL stored procedure call with optional input and output parameters and stores it in a CallableStatement object. |
PreparedStatement |
prepareStatement(String sql)
Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object. |
PreparedStatement |
prepareStatement(String sql,
int autoGeneratedKeys)
Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object. |
PreparedStatement |
prepareStatement(String sql,
int[] columnIndexes)
Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object. |
PreparedStatement |
prepareStatement(String sql,
int resultSetType,
int resultSetConcurrency)
Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object. |
PreparedStatement |
prepareStatement(String sql,
int resultSetType,
int resultSetConcurrency,
int resultSetHoldability)
Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object. |
PreparedStatement |
prepareStatement(String sql,
String[] columnNames)
Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object. |
void |
releaseSavepoint(Savepoint savepoint)
Removes the given Savepoint object from the current transaction. |
void |
rollback()
Drops all changes made since the previous commit or rollback and releases any database locks currently held by the connection. |
void |
rollback(Savepoint savepoint)
Undoes all changes made after the specified Savepoint was set. |
void |
setAutoCommit(boolean autoCommit)
Sets the auto-commit mode. |
void |
setCatalog(String catalog)
This method is not supported. |
void |
setClientInfo(Properties properties)
Sets the value of the connection's client info properties. |
void |
setClientInfo(String name,
String value)
Sets the value of the client info property specified by name to the value specified by value. |
void |
setConcurrentAccessResolution(int concurrentAccessResolution)
This method sets concurrent access resolution. |
void |
setDB2eWLMCorrelator(byte[] bytes)
Sets the eWLM Correlator. |
void |
setDBHostServerTrace(boolean trace)
Starts or stops the Database Host Server trace for this connection. |
void |
setHoldability(int holdability)
Sets the holdability of ResultSets created from this connection. |
void |
setReadOnly(boolean readOnly)
Sets the read-only mode. |
Savepoint |
setSavepoint()
Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it. |
Savepoint |
setSavepoint(String name)
Creates a named savepoint in the current transaction and returns the new Savepoint object that represents it. |
void |
setTransactionIsolation(int level)
Sets the transaction isolation level. |
void |
setTypeMap(Map typeMap)
Sets the type map to be used for distinct and structured types. |
String |
toString()
Returns the connection's catalog name. |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.sql.Connection |
---|
createBlob, createClob, createNClob, createSQLXML, createStruct, isValid |
Methods inherited from interface java.sql.Wrapper |
---|
isWrapperFor, unwrap |
Method Detail |
---|
public void clearWarnings() throws SQLException
clearWarnings
in interface Connection
SQLException
- If an error occurs.public void close() throws SQLException
close
in interface Connection
SQLException
- If an error occurs.public void commit() throws SQLException
This method can not be called when the connection is part of a distributed transaction. See AS400JDBCXAResource for more information.
commit
in interface Connection
SQLException
- If the connection is not open
or an error occurs.public Statement createStatement() throws SQLException
Result sets created using the statement will be type ResultSet.TYPE_FORWARD_ONLY and concurrency ResultSet.CONCUR_READ_ONLY.
createStatement
in interface Connection
SQLException
- If the connection is not open,
the maximum number of statements
for this connection has been reached, or an
error occurs.public Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLException
createStatement
in interface Connection
resultSetType
- The result set type. Valid values are:
resultSetConcurrency
- The result set concurrency. Valid values are:
SQLException
- If the connection is not open,
the maximum number of statements
for this connection has been reached, the
result type or currency is not supported,
or an error occurs.public Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
Full functionality of this method requires support in OS/400 V5R2 or IBM i. If connecting to OS/400 V5R1 or earlier, the value for resultSetHoldability will be ignored.
createStatement
in interface Connection
resultSetType
- The result set type. Valid values are:
resultSetConcurrency
- The result set concurrency. Valid values are:
resultSetHoldability
- The result set holdability. Valid values are:
SQLException
- If the connection is not open,
the maximum number of statements
for this connection has been reached, the
result type, currency, or holdability is not supported,
or an error occurs.protected void finalize() throws Throwable
finalize
in class Object
Throwable
- If an error occurs.public boolean getAutoCommit() throws SQLException
getAutoCommit
in interface Connection
SQLException
- If the connection is not open.public String getCatalog() throws SQLException
getCatalog
in interface Connection
SQLException
- If the connection is not open.public int getConcurrentAccessResolution()
AS400JDBCDataSource.CONCURRENTACCESS_NOT_SET
,
AS400JDBCDataSource.CONCURRENTACCESS_USE_CURRENTLY_COMMITTED
,
AS400JDBCDataSource.CONCURRENTACCESS_WAIT_FOR_OUTCOME
and
AS400JDBCDataSource.CONCURRENTACCESS_SKIP_LOCKS
,
with the property defaulting to AS400JDBCDataSource.CONCURRENTACCESS_NOT_SET
.
Setting this property to default exhibits the default behavior on the servers
i.e., the semantic applied for read
transactions to avoid locks will be determined by the server.
AS400JDBCDataSource.CONCURRENTACCESS_USE_CURRENTLY_COMMITTED
specifies that driver will flow USE CURRENTLY COMMITTED
to server. Whether CURRENTLY COMMITTED will actually be in effect is
ultimately determined by server.
AS400JDBCDataSource.CONCURRENTACCESS_WAIT_FOR_OUTCOME
specifies that driver will flow WAIT FOR OUTCOME
to server. This will disable the CURRENTLY COMMITTED behavior at the server,
if enabled, and the server will wait for the commit or rollback of data in the process of
being updated.
AS400JDBCDataSource.CONCURRENTACCESS_SKIP_LOCKS
specifies that driver will flow SKIP LOCKS
to server. This directs the database manager to skip records in the case of record lock conflicts.
AS400JDBCDataSource.CONCURRENTACCESS_NOT_SET
,
AS400JDBCDataSource.CONCURRENTACCESS_USE_CURRENTLY_COMMITTED
,
AS400JDBCDataSource.CONCURRENTACCESS_WAIT_FOR_OUTCOME
, or
AS400JDBCDataSource.CONCURRENTACCESS_SKIP_LOCKS
public int getHoldability() throws SQLException
getHoldability
in interface Connection
cursor hold
driver property. SQLException
- If the connection is not open.public DatabaseMetaData getMetaData() throws SQLException
getMetaData
in interface Connection
SQLException
- If an error occurs.public String getServerJobIdentifier()
Note: Since this method is not defined in the JDBC Connection interface, you typically need to cast a Connection object to AS400JDBCConnection in order to call this method:
String serverJobIdentifier = ((AS400JDBCConnection)connection).getServerJobIdentifier();
public AS400 getSystem()
Note: Since this method is not defined in the JDBC Connection interface, you typically need to cast a Connection object to AS400JDBCConnection in order to call this method:
AS400 system = ((AS400JDBCConnection)connection).getSystem();
public int getTransactionIsolation() throws SQLException
getTransactionIsolation
in interface Connection
SQLException
- If the connection is not open.public Map getTypeMap() throws SQLException
This driver does not support the type map.
getTypeMap
in interface Connection
SQLException
- This exception is always thrown.public SQLWarning getWarnings() throws SQLException
getWarnings
in interface Connection
SQLException
- If an error occurs.public boolean isClosed() throws SQLException
isClosed
in interface Connection
SQLException
- If an error occurs.public boolean isReadOnly() throws SQLException
isReadOnly
in interface Connection
SQLException
- If the connection is not open.public String nativeSQL(String sql) throws SQLException
nativeSQL
in interface Connection
sql
- The SQL statement in terms of the JDBC SQL grammar.SQLException
- If the SQL statement has a syntax error.public CallableStatement prepareCall(String sql) throws SQLException
Result sets created using the statement will be type ResultSet.TYPE_FORWARD_ONLY and concurrency ResultSet.CONCUR_READ_ONLY.
prepareCall
in interface Connection
sql
- The SQL stored procedure call.SQLException
- If the connection is not open,
the maximum number of statements
for this connection has been reached, or an
error occurs.public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
prepareCall
in interface Connection
sql
- The SQL statement.resultSetType
- The result set type. Valid values are:
resultSetConcurrency
- The result set concurrency. Valid values are:
SQLException
- If the connection is not open,
the maximum number of statements
for this connection has been reached, the
result type or currency is not valid,
or an error occurs.public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
Full functionality of this method requires support in OS/400 V5R2 or IBM i. If connecting to OS/400 V5R1 or earlier, the value for resultSetHoldability will be ignored.
prepareCall
in interface Connection
sql
- The SQL statement.resultSetType
- The result set type. Valid values are:
resultSetConcurrency
- The result set concurrency. Valid values are:
resultSetHoldability
- The result set holdability. Valid values are:
SQLException
- If the connection is not open,
the maximum number of statements
for this connection has been reached, the
result type, currency, or holdability is not valid,
or an error occurs.public PreparedStatement prepareStatement(String sql) throws SQLException
Result sets created using the statement will be type ResultSet.TYPE_FORWARD_ONLY and concurrency ResultSet.CONCUR_READ_ONLY.
prepareStatement
in interface Connection
sql
- The SQL statement.SQLException
- If the connection is not open,
the maximum number of statements
for this connection has been reached, or an
error occurs.public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys) throws SQLException
This method requires OS/400 V5R2 or IBM i. If connecting to OS/400 V5R1 or earlier, an exception will be thrown.
Result sets created using the statement will be type ResultSet.TYPE_FORWARD_ONLY and concurrency ResultSet.CONCUR_READ_ONLY.
prepareStatement
in interface Connection
sql
- The SQL statement.autoGeneratedKeys
- Whether to return auto generated keys. Valid values are:
SQLException
- If the connection is not open,
the maximum number of statements
for this connection has been reached,
if connecting to OS/400 V5R1 or earlier,
an error occurs.public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
Result sets created using the statement will be holdability ResultSet.CLOSE_CURSORS_AT_COMMIT.
prepareStatement
in interface Connection
sql
- The SQL statement.resultSetType
- The result set type. Valid values are:
resultSetConcurrency
- The result set concurrency. Valid values are:
SQLException
- If the connection is not open,
the maximum number of statements
for this connection has been reached, the
result type or currency is not valid,
or an error occurs.public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
prepareStatement
in interface Connection
sql
- The SQL statement.resultSetType
- The result set type. Valid values are:
resultSetConcurrency
- The result set concurrency. Valid values are:
resultSetHoldability
- The result set holdability. Valid values are:
SQLException
- If the connection is not open,
the maximum number of statements
for this connection has been reached, the
result type, currency, or holdability is not valid,
or an error occurs.public PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLException
This method is not supported when connecting to IBM i V5R4 or earlier systems.
prepareStatement
in interface Connection
sql
- The SQL statement.columnIndexes
- An array of column indexes indicating the columns that should be returned from the inserted row or rows.SQLException
- - If connecting to IBM i V5R4 or earlier systems,
the connection is not open,
the maximum number of statements for this connection has been reached,
or an error occurs.public PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLException
This method is not supported when connecting to IBM i V5R4 or earlier systems.
prepareStatement
in interface Connection
sql
- The SQL statement.columnNames
- An array of column names indicating the columns that should be returned from the inserted row or rows.SQLException
- - If connecting to IBM i V5R4 or earlier systems,
the connection is not open,
the maximum number of statements for this connection has been reached,
or an error occurs.public void releaseSavepoint(Savepoint savepoint) throws SQLException
releaseSavepoint
in interface Connection
savepoint
- the savepoint to be removed.SQLException
- if a database access error occurs or the given Savepoint
is not a valid savepoint in the current transaction.public void rollback() throws SQLException
This method can not be called when the connection is part of a distributed transaction. See AS400JDBCXAResource for more information.
rollback
in interface Connection
SQLException
- If the connection is not open
or an error occurs.public void rollback(Savepoint savepoint) throws SQLException
rollback
in interface Connection
savepoint
- the savepoint to be rolled back to.SQLException
- if a database access error occurs, the Savepoint
is no longer valid, or this Connection
is currently in auto-commit mode.public void setAutoCommit(boolean autoCommit) throws SQLException
By default, the connection is in auto-commit mode. The commit occurs when the statement execution completes or the next statement execute occurs, whichever comes first. In the case of statements returning a result set, the statement execution completes when the last row of the result set has been retrieved or the result set has been closed. In advanced cases, a single statement may return multiple results as well as output parameter values. Here the commit occurs when all results and output parameter values have been retrieved.
The auto-commit mode is always false when the connection is part of a distributed transaction. See AS400JDBCXAResource for more information.
setAutoCommit
in interface Connection
autoCommit
- true to turn on auto-commit mode, false to
turn it off.SQLException
- If the connection is not open
or an error occurs.public void setCatalog(String catalog) throws SQLException
setCatalog
in interface Connection
SQLException
- If the connection is not open.public void setConcurrentAccessResolution(int concurrentAccessResolution) throws SQLException
AS400JDBCDataSource.CONCURRENTACCESS_NOT_SET
,
AS400JDBCDataSource.CONCURRENTACCESS_USE_CURRENTLY_COMMITTED
,
AS400JDBCDataSource.CONCURRENTACCESS_WAIT_FOR_OUTCOME
and
AS400JDBCDataSource.CONCURRENTACCESS_SKIP_LOCKS
,
with the property defaulting to AS400JDBCDataSource.CONCURRENTACCESS_NOT_SET
.
Setting this property to default exhibits the default behavior on the servers
i.e., the semantic applied for read
transactions to avoid locks will be determined by the server.
AS400JDBCDataSource.CONCURRENTACCESS_USE_CURRENTLY_COMMITTED
specifies that driver will flow USE CURRENTLY COMMITTED
to server. Whether CURRENTLY COMMITTED will actually be in effect is
ultimately determined by server.
AS400JDBCDataSource.CONCURRENTACCESS_WAIT_FOR_OUTCOME
specifies that driver will flow WAIT FOR OUTCOME
to server. This will disable the CURRENTLY COMMITTED behavior at the server,
if enabled, and the server will wait for the commit or rollback of data in the process of
being updated.
AS400JDBCDataSource.CONCURRENTACCESS_SKIP_LOCKS
specifies that driver will flow SKIP LOCKS
to server. This directs the database manager to skip records in the case of record lock conflicts.
concurrentAccessResolution
- The current access resolution setting. Possible valuse:
AS400JDBCDataSource.CONCURRENTACCESS_NOT_SET
,
AS400JDBCDataSource.CONCURRENTACCESS_USE_CURRENTLY_COMMITTED
,
AS400JDBCDataSource.CONCURRENTACCESS_WAIT_FOR_OUTCOME
, or
AS400JDBCDataSource.CONCURRENTACCESS_SKIP_LOCKS
SQLException
public void setDB2eWLMCorrelator(byte[] bytes) throws SQLException
bytes
- The eWLM correlator valueSQLException
public void setHoldability(int holdability) throws SQLException
Full functionality of this method requires OS/400 V5R2 or IBM i. If connecting to OS/400 V5R1 or earlier, all cursors for the connection will be changed to the value of the variable holdability.
setHoldability
in interface Connection
holdability
- The cursor holdability.
Valid values are ResultSet.HOLD_CURSORS_OVER_COMMIT or
ResultSet.CLOSE_CURSORS_AT_COMMIT.SQLException
- If the connection is not open
or the value passed in is not valid.public void setReadOnly(boolean readOnly) throws SQLException
This method can not be called when the connection is part of a distributed transaction. See AS400JDBCXAResource for more information.
setReadOnly
in interface Connection
SQLException
- If the connection is not open,
a transaction is active, or the
"access" property is set to "read
only".public Savepoint setSavepoint() throws SQLException
setSavepoint
in interface Connection
SQLException
- if a database access error occurs or this Connection object is currently in auto-commit mode.public Savepoint setSavepoint(String name) throws SQLException
setSavepoint
in interface Connection
name
- A String containing the name of the savepointSQLException
- if a database access error occurs or this Connection object is currently in auto-commit mode.public void setTransactionIsolation(int level) throws SQLException
JDBC and DB2 for IBM i use different terminology for transaction isolation levels. The following table provides a terminology mapping:
IBM i isolation level | JDBC transaction isolation level |
---|---|
*CHG | TRANSACTION_READ_UNCOMMITTED |
*CS | TRANSACTION_READ_COMMITTED |
*ALL | TRANSACTION_READ_REPEATABLE_READ |
*RR | TRANSACTION_SERIALIZABLE |
setTransactionIsolation
in interface Connection
level
- The transaction isolation level. Possible
values are:
SQLException
- If the connection is not open,
the input level is not valid
or unsupported, or a transaction
is active.public void setTypeMap(Map typeMap) throws SQLException
Note: Distinct types are supported by DB2 for IBM i, but are not externalized by the IBM Toolbox for Java JDBC driver. In other words, distinct types behave as if they are the underlying type. Structured types are not supported by DB2 for IBM i. Consequently, this driver does not support the type map.
setTypeMap
in interface Connection
typeMap
- The type map.SQLException
- This exception is always thrown.public String toString()
toString
in class Object
public void setClientInfo(String name, String value) throws SQLException
The following are client info properties.
setClientInfo
in interface Connection
name
- The name of the client info property to setvalue
- The value to set the client info property to. If the
value is null, the current value of the specified
property is cleared.
SQLException
- if the database returns an error while
setting the client info value on the database.
public void setClientInfo(Properties properties) throws SQLException
Properties
object contains the names and values of the
client info properties to be set. The set of client info properties
contained in the properties list replaces the current set of client info
properties on the connection. If a property that is currently set on the
connection is not present in the properties list, that property is
cleared. Specifying an empty properties list will clear all of the
properties on the connection. See
setClientInfo (String, String)
for more information.
If an error occurs in setting any of the client info properties, a
ClientInfoException
is thrown. The
ClientInfoException
contains information indicating which
client info properties were not set. The state of the client information
is unknown because some databases do not allow multiple client info
properties to be set atomically. For those databases, one or more
properties may have been set before the error occurred.
The following client info properties are supported in Toobox for Java.
setClientInfo
in interface Connection
properties
- the list of client info properties to set
SQLException
- if the database returns an error while setting the
clientInfo values on the database
public String getClientInfo(String name) throws SQLException
Applications may use the DatabaseMetaData.getClientInfoProperties
method to determine the client info properties supported by the driver.
The following client info properties are supported in Toobox for Java.
getClientInfo
in interface Connection
name
- The name of the client info property to retrieve
SQLException
- if the database returns an error when
fetching the client info value from the database.public Properties getClientInfo() throws SQLException
The following client info properties are supported in Toobox for Java.
getClientInfo
in interface Connection
Properties
object that contains the name and current value of
each of the client info properties supported by the driver.
SQLException
- if the database returns an error when
fetching the client info values from the databasepublic Array createArrayOf(String typeName, Object[] elements) throws SQLException
createArrayOf
in interface Connection
typeName
- the SQL name of the type the elements of the array map to. The typeName is a
database-specific name which may be the name of a built-in type, a user-defined type or a standard SQL type supported by this database. This
is the value returned by Array.getBaseTypeName
For Toolbox, the typeName will correspond to a typename in java.sql.Types.elements
- the elements that populate the returned objectSQLException
- if a database error occurs, the typeName is null or this method is called on a closed connectionSQLFeatureNotSupportedException
- if the JDBC driver does not support this data typepublic void setDBHostServerTrace(boolean trace)
trace
- true to start database host server tracing, false to end it.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |