Skip navigation links

com.timesten.jdbc
Interface TimesTenPreparedStatement

All Superinterfaces:

java.sql.PreparedStatement, java.sql.Statement, TimesTenStatement, java.sql.Wrapper

All Known Subinterfaces:

TimesTenCallableStatement

public interface TimesTenPreparedStatement

extends TimesTenStatement, java.sql.PreparedStatement

Contains TimesTen extension to java.sql.PreparedStatement

Since:

11.2.1

Version:

$Header: timesten/jdbc/src/jdbc/TimesTenPreparedStatement.java /main/6 2012/02/15 14:19:13 mardhana Exp $

Field Summary

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Method Summary

java.sql.ResultSet	getReturnResultSet() Returns the DML returned parameters in the form of a ResultSet.
void	registerReturnParameter(int paramIndex, int sqlType) Use this method to register DML returning parameters.
void	registerReturnParameter(int paramIndex, int sqlType, int maxSize) Use this method to register DML returning parameters.
void	setPlsqlIndexTable(int paramIndex, java.lang.Object arrayData, int maxLen, int curLen, int elemSqlType, int elemMaxLen) Binds a PL/SQL index-by table parameter in the IN parameter mode.

Methods inherited from interface com.timesten.jdbc.TimesTenStatement

getLobPrefetchSize, getQueryTimeThreshold, setLobPrefetchSize, setQueryTimeThreshold

Methods inherited from interface java.sql.PreparedStatement

addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Method Detail

registerReturnParameter

void registerReturnParameter(int paramIndex,
                             int sqlType)
                             throws java.sql.SQLException

Use this method to register DML returning parameters. This method is used for fixed data types such as INTEGER and CHAR.

Parameters:

paramIndex - the first parameter is 1, the second is 2,...

sqlType - a value from java.sql.Types supported by TimesTen

Throws:

java.sql.SQLException - if a database access error occurs

registerReturnParameter

void registerReturnParameter(int paramIndex,
                             int sqlType,
                             int maxSize)
                             throws java.sql.SQLException

Use this method to register DML returning parameters. This method is used for variable size data types such as VARCHAR.

Parameters:

paramIndex - the first parameter is 1, the second is 2,...

sqlType - a value from java.sql.Types supported by TimesTen

maxSize - Maximum size of the parameter specified in bytes for BINARY/VARBINARY fields and in characters for CHAR/VARCHAR fields.

Throws:

java.sql.SQLException - if a database access error or truncation error occurs

getReturnResultSet

java.sql.ResultSet getReturnResultSet()
                                      throws java.sql.SQLException

Returns the DML returned parameters in the form of a ResultSet.

Returns:

ResultSet

Throws:

java.sql.SQLException - if a database access error occurs

setPlsqlIndexTable

void setPlsqlIndexTable(int paramIndex,
                        java.lang.Object arrayData,
                        int maxLen,
                        int curLen,
                        int elemSqlType,
                        int elemMaxLen)
                        throws java.sql.SQLException

Binds a PL/SQL index-by table parameter in the IN parameter mode.

Parameters:

paramIndex - This argument indicates the parameter position within the statement. The first parameter is 1, the second is 2, ...

arrayData - This argument is an array of values to be bound to the PL/SQL index-by table parameter. The value is of type java.lang.Object, and the value can be a Java primitive type array such as int[] or a Java object array such as BigDecimal[].

maxLen - This argument specifies the maximum table length of the index-by table bind value which defines the maximum possible curLen for batch updates. For standalone binds, maxLen should use the same value as curLen. This argument is required.

curLen - This argument specifies the actual size of the index-by table bind value in arrayData. If the curLen value is smaller than the size of arrayData, only the curLen number of table elements is passed to the database. If the curLen value is larger than the size of arrayData, the entire arrayData is sent to the database.

elemSqlType - This argument specifies the index-by table element type based on the values defined in the TimesTenTypes class.

elemMaxLen - This argument specifies the index-table element maximum length in case the element type is CHAR, VARCHAR, or RAW. This value is ignored for other types. A value of 0 for elemMaxLen would inidicate the driver to calculate the elemMaxLen based on the actual length of data bound. For a non zero value if the data bound is greater than elemMaxLen it is truncated.

Throws:

java.sql.SQLException

Skip navigation links