sqlj.runtime.ExecutionContext class

public static final int ADD_BATCH_COUNT

A constant that can be returned by the getUpdateCount method. It indicates that the previous statement was not executed but was added to the existing statement batch.

public static final int AUTO_BATCH

A constant that can be passed to the setBatchLimit method. It indicates that implicit batch execution should be performed, and that SQLJ should determine the batch size.

public static final short DBDefault=-5;

A constant that can be assigned to an indicator variable. It specifies that the corresponding host variable value that is passed to the data server is the default value.

public static final short DBNonNull=0;

A constant that can be assigned to an indicator variable. It specifies that the corresponding host variable value that is passed to the data server is a non-null value.

public static final short DBNull=-1;

A constant that can be assigned to an indicator variable. It specifies that the corresponding host variable value that is passed to the data server is the SQL NULL value.

public static final short DBUnassigned=-7;

A constant that can be assigned to an indicator variable. It specifies that no value for the corresponding host variable is passed to the data server.

public static final int EXEC_BATCH_COUNT

A constant that can be returned from the getUpdateCount method. It indicates that a statement batch was just executed.

public static final int EXCEPTION_COUNT

A constant that can be returned from the getUpdateCount method. It indicates that an exception was thrown before the previous execution completed, or that no operation has been performed on the execution context object.

public static final int NEW_BATCH_COUNT

A constant that can be returned from the getUpdateCount method. It indicates that the previous statement was not executed, but was added to a new statement batch.

public static final int QUERY_COUNT

A constant that can be passed to the setBatchLimit method. It indicates that the previous execution produced a result set.

public static final int UNLIMITED_BATCH

A constant that can be returned from the getUpdateCount method. It indicates that statements should continue to be added to a statement batch, regardless of the batch size.

public void cancel() throws SQLException

Cancels an SQL operation that is currently being executed by a thread that uses the execution context object. If there is a pending statement batch on the execution context object, the statement batch is canceled and cleared.

The cancel method throws an SQLException if the statement cannot be canceled.

public boolean execute ( ) throws SQLException

This method is used by code that is generated by the SQLJ translator. It is not intended for direct use by application programs.

public synchronized int[] executeBatch() throws SQLException

Executes the pending statement batch and returns an array of update counts. If no pending statement batch exists, null is returned. When this method is called, the statement batch is cleared, even if the call results in an exception.

The executeBatch method throws an SQLException if a database error occurs while the statement batch executes.

public RTResultSet executeQuery ( ) throws SQLException

This method is used by code that is generated by the SQLJ translator. It is not intended for direct use by application programs.

public int executeUpdate() throws SQLException

This method is used by code that is generated by the SQLJ translator. It is not intended for direct use by application programs.

synchronized public int getBatchLimit()

Returns the number of statements that are added to a batch before the batch is implicitly executed.

public synchronized int[] getBatchUpdateCounts()

Returns an array that contains the number of rows that were updated by each statement that successfully executed in a batch. The order of elements in the array corresponds to the order in which statements were inserted into the batch. Returns null if no statements in the batch completed successfully.

synchronized public int getFetchDirection() throws SQLException

Returns the current fetch direction for scrollable iterator objects that were generated from the given execution context. If a fetch direction was not set for the execution context, sqlj.runtime.ResultSetIterator.FETCH_FORWARD is returned.

synchronized public int getFetchSize() throws SQLException

Returns the number of rows that should be fetched by SQLJ when more rows are needed. This value applies only to iterator objects that were generated from the given execution context. The returned value is the value that was set by the setFetchSize method, or 0 if no value was set by setFetchSize.

public synchronized int getMaxFieldSize()

Returns the maximum number of bytes that are returned for any string (character, graphic, or varying-length binary) column in queries that use the given execution context. If this limit is exceeded, SQLJ discards the remaining bytes. A value of 0 means that the maximum number of bytes is unlimited.

public synchronized int getMaxRows()

Returns the maximum number of rows that are returned for any query that uses the given execution context. If this limit is exceeded, SQLJ discards the remaining rows. A value of 0 means that the maximum number of rows is unlimited.

public ResultSet getNextResultSet() throws SQLException

After a stored procedure call, returns a result set from the stored procedure.

When you invoke getNextResultSet(), SQLJ closes the currently-open result set and advances to the next result set.

If an error occurs during a call to getNextResultSet, resources for the current JDBC ResultSet object are released, and an SQLException is thrown. Subsequent calls to getNextResultSet return null.

public ResultSet getNextResultSet(int current)

After a stored procedure call, returns a result set from the stored procedure.

If an error occurs during a call to getNextResultSet, resources for the current JDBC ResultSet object are released, and an SQLException is thrown. Subsequent calls to getNextResultSet return null.

public synchronized int getQueryTimeout()

Returns the maximum number of seconds that SQL operations that use the given execution context object can execute. If an SQL operation exceeds the limit, an SQLException is thrown. The returned value is the value that was set by the setQueryTimeout method, or 0 if no value was set by setQueryTimeout. 0 means that execution time is unlimited.

public abstract int getUpdateCount() throws SQLException

public synchronized SQLWarning getWarnings()

Returns the first warning that was reported by the last SQL operation that was executed using the given execution context. Subsequent warnings are chained to the first warning. If no warnings occurred, null is returned.

getWarnings is used to retrieve positive SQLCODEs.

public synchronized boolean isBatching()

Returns true if batching is enabled for the execution context. Returns false if batching is disabled.

public RTStatement registerStatement(ConnectionContext connCtx, 
 Object profileKey, int stmtNdx)
 throws SQLException

This method is used by code that is generated by the SQLJ translator. It is not intended for direct use by application programs.

public void releaseStatement() throws SQLException

This method is used by code that is generated by the SQLJ translator. It is not intended for direct use by application programs.

public synchronized void setBatching(boolean batching)

setBatching affects only statements that occur in the program after setBatching is called. It does not affect previous statements or an existing statement batch.

public synchronized void setBatchLimit(int batch-size)

Sets the maximum number of statements that are added to a batch before the batch is implicitly executed.

public synchronized void setFetchDirection(int direction) throws SQLException

Gives SQLJ a hint as to the current fetch direction for scrollable iterator objects that were generated from the given execution context.

synchronized public void setFetchSize(int number-of-rows) throws SQLException

Gives SQLJ a hint as to the number of rows that should be fetched when more rows are needed.

public void setMaxFieldSize(int max-bytes)

Specifies the maximum number of bytes that are returned for any string (character, graphic, or varying-length binary) column in queries that use the given execution context. If this limit is exceeded, SQLJ discards the remaining bytes.

public synchronized void setMaxRows(int max-rows)

Specifies the maximum number of rows that are returned for any query that uses the given execution context. If this limit is exceeded, SQLJ discards the remaining rows.

When setMaxRows is invoked at run time on a statically executed SELECT statement, setMaxRows limits the maximum number of rows in the result table through IBM® Data Server Driver for JDBC and SQLJ processing only. Data server optimization that limits the number of rows in the result table does not occur unless the FETCH FIRST n ROWS ONLY clause is also added to the SELECT statement. If FETCH FIRST n rows ONLY is added to the SELECT statement, and setMaxRows(m) is called, the maximum number of rows is the smaller of n and m. The driver discards the rest of the rows.

public synchronized void setQueryTimeout(int timeout-value)

Specifies the maximum number of seconds that SQL operations that use the given execution context object can execute. If an SQL operation exceeds the limit, an SQLException is thrown.

For IBM Data Server Driver for JDBC and SQLJ type 2 connectivity on Db2® for z/OS® data servers, setQueryTimeout is supported only if Connection or DataSource property queryTimeoutInterruptProcessingMode is set to INTERRUPT_PROCESSING_MODE_CLOSE_SOCKET.